From e3efb1dfd87c84c732464aad2f00f7790f45f8b5 Mon Sep 17 00:00:00 2001 From: Damien Pontifex Date: Wed, 17 Aug 2022 10:41:46 +0800 Subject: [PATCH] notes on docs for the shareable attribute --- src/docs/complex_object.md | 1 + src/docs/object.md | 2 ++ src/docs/simple_object.md | 2 ++ 3 files changed, 5 insertions(+) diff --git a/src/docs/complex_object.md b/src/docs/complex_object.md index 306cec47..ce54f595 100644 --- a/src/docs/complex_object.md +++ b/src/docs/complex_object.md @@ -30,6 +30,7 @@ some simple fields, and use the `ComplexObject` macro to define some other field | external | Mark a field as owned by another service. This allows service A to use fields from service B while also knowing at runtime the types of that field. | bool | Y | | provides | Annotate the expected returned fieldset from a field on a base type that is guaranteed to be selectable by the gateway. | string | Y | | requires | Annotate the required input fieldset from a base type for a resolver. It is used to develop a query plan where the required fields may not be needed by the client, but the service may need additional information from other services. | string | Y | +| shareable | Indicate that a field is allowed to be resolved by multiple subgraphs | guard | Field of guard *[See also the Book](https://async-graphql.github.io/async-graphql/en/field_guard.html)* | string | Y | | visible | If `false`, it will not be displayed in introspection. *[See also the Book](https://async-graphql.github.io/async-graphql/en/visibility.html).* | bool | Y | | visible | Call the specified function. If the return value is `false`, it will not be displayed in introspection. | string | Y | diff --git a/src/docs/object.md b/src/docs/object.md index fa86af8c..e6b14930 100644 --- a/src/docs/object.md +++ b/src/docs/object.md @@ -13,6 +13,7 @@ All methods are converted to camelCase. | rename_args | Rename all the arguments according to the given case convention. The possible values are "lowercase", "UPPERCASE", "PascalCase", "camelCase", "snake_case", "SCREAMING_SNAKE_CASE". | string | Y | | cache_control | Object cache control | [`CacheControl`](struct.CacheControl.html) | Y | | extends | Add fields to an entity that's defined in another service | bool | Y | +| shareable | Indicate that an object type's field is allowed to be resolved by multiple subgraphs | use_type_description | Specifies that the description of the type is on the type declaration. [`Description`]()(derive.Description.html) | bool | Y | | visible | If `false`, it will not be displayed in introspection. *[See also the Book](https://async-graphql.github.io/async-graphql/en/visibility.html).* | bool | Y | | visible | Call the specified function. If the return value is `false`, it will not be displayed in introspection. | string | Y | @@ -33,6 +34,7 @@ All methods are converted to camelCase. | external | Mark a field as owned by another service. This allows service A to use fields from service B while also knowing at runtime the types of that field. | bool | Y | | provides | Annotate the expected returned fieldset from a field on a base type that is guaranteed to be selectable by the gateway. | string | Y | | requires | Annotate the required input fieldset from a base type for a resolver. It is used to develop a query plan where the required fields may not be needed by the client, but the service may need additional information from other services. | string | Y | +| shareable | Indicate that a field is allowed to be resolved by multiple subgraphs | guard | Field of guard *[See also the Book](https://async-graphql.github.io/async-graphql/en/field_guard.html)* | string | Y | | visible | If `false`, it will not be displayed in introspection. *[See also the Book](https://async-graphql.github.io/async-graphql/en/visibility.html).* | bool | Y | | visible | Call the specified function. If the return value is `false`, it will not be displayed in introspection. | string | Y | diff --git a/src/docs/simple_object.md b/src/docs/simple_object.md index fdf24bc2..4071ac2a 100644 --- a/src/docs/simple_object.md +++ b/src/docs/simple_object.md @@ -12,6 +12,7 @@ Similar to `Object`, but defined on a structure that automatically generates get | rename_fields | Rename all the fields according to the given case convention. The possible values are "lowercase", "UPPERCASE", "PascalCase", "camelCase", "snake_case", "SCREAMING_SNAKE_CASE". | string | Y | | cache_control | Object cache control | [`CacheControl`](struct.CacheControl.html) | Y | | extends | Add fields to an entity that's defined in another service | bool | Y | +| shareable | Indicate that an object type's field is allowed to be resolved by multiple subgraphs | visible | If `false`, it will not be displayed in introspection. *[See also the Book](https://async-graphql.github.io/async-graphql/en/visibility.html).* | bool | Y | | visible | Call the specified function. If the return value is `false`, it will not be displayed in introspection. | string | Y | | concretes | Specify how the concrete type of the generic SimpleObject should be implemented. *[See also the Book](https://async-graphql.github.io/async-graphql/en/define_simple_object.html#generic-simpleobjects) | ConcreteType | Y | @@ -33,6 +34,7 @@ Similar to `Object`, but defined on a structure that automatically generates get | external | Mark a field as owned by another service. This allows service A to use fields from service B while also knowing at runtime the types of that field. | bool | Y | | provides | Annotate the expected returned fieldset from a field on a base type that is guaranteed to be selectable by the gateway. | string | Y | | requires | Annotate the required input fieldset from a base type for a resolver. It is used to develop a query plan where the required fields may not be needed by the client, but the service may need additional information from other services. | string | Y | +| shareable | Indicate that a field is allowed to be resolved by multiple subgraphs | guard | Field of guard *[See also the Book](https://async-graphql.github.io/async-graphql/en/field_guard.html)* | string | Y | | visible | If `false`, it will not be displayed in introspection. *[See also the Book](https://async-graphql.github.io/async-graphql/en/visibility.html).* | bool | Y | | visible | Call the specified function. If the return value is `false`, it will not be displayed in introspection. | string | Y |