Change some comments

Signed-off-by: Alan Cha <[email protected]>

Author: Alan-Cha

packages/openapi-to-graphql/README.md

@@ -178,7 +178,7 @@ Resolver options:
 
 - `customResolvers` (type: `object`, default: `{}`): OpenAPI-to-GraphQL, by default, creates resolver functions that make REST calls to resolve fields in the generated GraphQL interface. This option allows users to provide custom resolver functions to be used in place of said ones created by OpenAPI-to-GraphQL. The field that the custom resolver will affect is identifed first by the [title](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#infoObject) of the OAS, then the [path](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#paths-object) of the operation, and lastly the [method](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#path-item-object) of the operation. The `customResolvers` object is thus a triply nested object where the outer key is the title, followed by the path, and finally the method, which points to the [resolver function](https://graphql.org/learn/execution/#root-fields-resolvers) itself. The resolver function can use the parameters `obj`, `args`, `context`, and `info` in order to produce the proper data, as do standard [resolver functions](https://graphql.org/learn/execution/#root-fields-resolvers) in GraphQL. Use cases include the resolution of complex relationships between types, implementing performance improvements like caching, or dealing with non-standard authentication requirements. _Note: Because the arguments are provided by the GraphQL interface, they may look different from the [parameters](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#parameterObject) defined by the OAS. For example, they will have [sanitized](https://github.com/Alan-Cha/openapi-to-graphql#characteristics) names. The [request body](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#requestBodyObject) will also be contained in the arguments as an [input object type](https://graphql.org/graphql-js/mutations-and-input-types/)._
 
-- `createSubscriptionsFromCallbacks` (type: `boolean`, default: `false`): Generates subscription fields from [callback objects](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#CallbackObject). The keys ([runtime expressions](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#runtimeExpression)) of the callback objects will be interpolated as the topic of a publish/subscription connection using [graphql-subscriptions](https://github.com/apollographql/graphql-subscriptions). Read the [doc](./docs/SUBSCRIPTIONS.md) for explanations and examples regarding its usage.
+- `createSubscriptionsFromCallbacks` (type: `boolean`, default: `false`): Generates subscription fields from [callback objects](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#CallbackObject). The keys ([runtime expressions](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#runtimeExpression)) of the callback objects will be interpolated as the topic of a publish/subscription connection using [graphql-subscriptions](https://github.com/apollographql/graphql-subscriptions). Read the [doc](./docs/subscriptions.md) for explanations and examples regarding its usage.
 
 ***
 

packages/openapi-to-graphql/docs/SUBSCRIPTIONS.md renamed to packages/openapi-to-graphql/docs/subscriptions.md

@@ -27,7 +27,7 @@ declare type GetSubscribeParams = {
 export declare function getSubscribe({ operation, payloadName, data, baseUrl, connectOptions }: GetSubscribeParams): SubscriptionIterator;
 export declare function getPublishResolver({ operation, argsFromLink, responseName, data }: GetResolverParams): ResolveFunction;
 /**
- * if operationType is Query | Mutation, creates and returns a resolver function that performs API requests for the
+ * If operationType is Query/Mutation, creates and returns a resolver function that performs API requests for the
  * given GraphQL query
  */
 export declare function getResolver({ operation, argsFromLink, payloadName, data, baseUrl, requestOptions }: GetResolverParams): ResolveFunction;

packages/openapi-to-graphql/lib/resolver_builder.d.ts

@@ -132,8 +132,8 @@ export declare type Options = {
      */
     baseUrl?: string;
     /**
-     * Allows to define custom resolvers for fields on the query/mutation/subscription root
-     * operation type.
+     * Allows to define custom resolvers for fields on the Query/Mutation |
+     * Subscription root operation type.
      *
      * In other words, instead of resolving on an operation (REST call) defined in
      * the OAS, the field will resolve on the custom resolver. Note that this will
@@ -310,8 +310,8 @@ export declare type InternalOptions = {
      */
     baseUrl?: string;
     /**
-     * Allows to define custom resolvers for fields on the query/mutation/subscription
-     * root operation type.
+     * Allows to define custom resolvers for fields on the Query/Mutation |
+     * Subscription root operation type.
      *
      * In other words, instead of resolving on an operation (REST call) defined in
      * the OAS, the field will resolve on the custom resolver. Note that this will

packages/openapi-to-graphql/lib/resolver_builder.js

@@ -285,7 +285,7 @@ export function getPublishResolver({
 }
 
 /**
- * if operationType is Query | Mutation, creates and returns a resolver function that performs API requests for the
+ * If operationType is Query/Mutation, creates and returns a resolver function that performs API requests for the
  * given GraphQL query
  */
 export function getResolver({

packages/openapi-to-graphql/lib/types/options.d.ts

@@ -156,8 +156,8 @@ export type Options = {
   baseUrl?: string
 
   /**
-   * Allows to define custom resolvers for fields on the query/mutation/subscription root
-   * operation type.
+   * Allows to define custom resolvers for fields on the Query/Mutation/Subscription
+   * root operation type.
    *
    * In other words, instead of resolving on an operation (REST call) defined in
    * the OAS, the field will resolve on the custom resolver. Note that this will
@@ -358,7 +358,7 @@ export type InternalOptions = {
   baseUrl?: string
 
   /**
-   * Allows to define custom resolvers for fields on the query/mutation/subscription
+   * Allows to define custom resolvers for fields on the Query/Mutation/Subscription
    * root operation type.
    *
    * In other words, instead of resolving on an operation (REST call) defined in