Skip to content

Commit

Permalink
Add readme doc
Browse files Browse the repository at this point in the history
Signed-off-by: Justinidlerz <zqc.sunny@gmail.com>
  • Loading branch information
Justinidlerz committed Jun 17, 2022
1 parent 3d2dbb1 commit 5085c7c
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions packages/openapi-to-graphql/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,7 @@ Schema options:

- `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.

- `graphQLSchemaPrefix` (type: `string`, default: `''`): For add a constants prefix for each generated GraphQL schema, i.e. passing `CustomName` for this option, generated `Product` type will be change to `CustomNameProduct`.
***

Resolver options:
Expand Down

0 comments on commit 5085c7c

Please sign in to comment.