Option fillEmptyResponses affects all

Changes requested in #140

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

Author: Alan-Cha

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

@@ -26,8 +26,8 @@ Options:
   -p, --port <port>            select the port where the server will start
   -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 limit argument on fields returning lists of objects/lists to control the data size
+  -f, --fillEmptyResponses     create placeholder schemas for operations with no response body rather than ignore them
+  -a, --addLimitArgument       add a 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

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

@@ -30,11 +30,11 @@ program
   )
   .option(
     '-f, --fillEmptyResponses',
-    'create placeholder schemas for operations with HTTP status code 204 (no response) rather than ignore them'
+    'create placeholder schemas for operations with no response body rather than ignore them'
   )
   .option(
     '-a, --addLimitArgument',
-    'add limit argument on fields returning lists of objects/lists to control the data size'
+    'add a limit argument on fields returning lists of objects/lists to control the data size'
   )
   .option(
     '-o, --operationIdFieldNames',

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

@@ -152,7 +152,7 @@ The options object can contain the following properties:
 
 - `tokenJSONpath` (type: `string`, default: `undefined`): Used to pass the [JSONPath](http://goessner.net/articles/JsonPath/) of the OAuth token in the GraphQL context. To see more details, click [here](./README.md#authorization).
 
-- `fillEmptyResponses` (type: `boolean`, default: `false`): OpenAPI-to-GraphQL, by default, will only wrap operations that have a [response schema](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#responsesObject) and operations that do not have a response schema will be ignored. The reason is that all GraphQL objects must have a data structure and in these cases, where the OAS does not define a response schema, the data structure cannot be safely assumed. As a result, it is recommended that the OAS should be modified to include a response schema. However, under certain circumstances, some operations should _not in fact_ have a response schema. One circumstance is HTTP status code 204, in which no content should be returned. The option `fillEmptyResponses` will allow OpenAPI-to-GraphQL to wrap these operations, _specifically ones with the 204 HTTP status code_, by assigning these operations a nullable data structure. Although this data structure is meaningless, the operation will appear in the schema.
+- `fillEmptyResponses` (type: `boolean`, default: `false`): OpenAPI-to-GraphQL, by default, will only wrap operations that have a [response schema](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#responsesObject). Therefore, operations that _do not have_ response schemas will be ignored. The reason is that all GraphQL objects must have a data structure and in these cases where the OAS does not define response schemas, the data structures cannot be safely assumed. As a result, it is recommended that the OAS should be modified to include a response schema. However, under certain circumstances, some operations should _not in fact_ have a response schema. One circumstance is HTTP status code 204, in which no content should be returned. The option `fillEmptyResponses` will allow OpenAPI-to-GraphQL to wrap these operations by assigning these operations a nullable data structure. Although this data structure is meaningless, the operation will appear in the schema.
 
 - `baseUrl` (type: `string`): Used to manual specify the base URL which all paths will be built on. Normally, OpenAPI-to-GraphQL will select a base URL from the [server object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#serverObject) defined in the OAS. However, if the server object contains multiple URLs, OpenAPI-to-GraphQL will randomly select one. The purpose of this option is to provide greater control over the base URL in these situations, especially when the OAS cannot be modified. This option may also prove to be useful in testing and development.