Add equivalentToMessages

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

Author: Alan-Cha

packages/openapi-to-graphql-cli/README.md

@@ -27,11 +27,12 @@ Options:
   -u, --url <url>              select the base url which paths will be built on
   -s, --strict                 throw an error if OpenAPI-to-GraphQL cannot run without compensating for errors or missing data in the OAS
   -f, --fillEmptyResponses     create placeholder schemas for operations with HTTP status code 204 (no response) rather than ignore them
-  -a, --addLimitArgument       add a limit argument on fields returning lists of objects/lists that will constrain the list size
+  -a, --addLimitArgument       add limit argument on fields returning lists of objects/lists to control the data size
   -o, --operationIdFieldNames  create field names based on the operationId
   --cors                       enable Cross-origin resource sharing (CORS)
   --no-viewer                  do not create GraphQL viewer objects for passing authentication credentials
   --no-extensions              do not add extentions, containing information about failed REST calls, to the GraphQL errors objects
+  --no-equivalentToMessages    do not append information about the underlying REST operations to the description of fields
   --save <file path>           save schema to path and do not start server
   -h, --help                   output usage information
 ```

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

@@ -49,6 +49,10 @@ program
     '--no-extensions',
     'do not add extentions, containing information about failed REST calls, to the GraphQL errors objects'
   )
+  .option(
+    '--no-equivalentToMessages',
+    'do not append information about the underlying REST operations to the description of fields'
+  )
   .option('--save <file path>', 'save schema to path and do not start server')
   .parse(process.argv)
 
@@ -162,7 +166,8 @@ function startGraphQLServer(oas, port) {
     baseUrl: program.url,
     operationIdFieldNames: program.operationIdFieldNames,
     provideErrorExtensions: program.extensions,
-    addLimitArgument: program.addLimitArgument
+    addLimitArgument: program.addLimitArgument,
+    equivalentToMessages: program.equivalentToMessages
   })
     .then(({ schema, report }) => {
       console.log(JSON.stringify(report, null, 2))

packages/openapi-to-graphql-cli/lib/openapi-to-graphql.js.map

@@ -166,6 +166,8 @@ The options object can contain the following properties:
 
 - `addLimitArgument` (type: `boolean`, default: `false`): Add a `limit` argument to fields returning lists of objects/lists that will limit the number of returned elements, selecting the first `n` elements of the list.
 
+- `equivalentToMessages` (type: `boolean`, default: `true`): Append a small message to the description of a field that clarifies the operation the field will trigger. The message will take the form of `Equivalent to {title of OAS} {method in ALL_CAPS} {path}` (the [title](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#infoObject) will only appear if multiple OASs are provided). Messages will appear for query/mutation fields as well as for fields created by links. _Note: These messages may unintentionally leak information about the underlying REST API._
+
 Consider this example of passing options:
 
 ```javascript