Add option for generic payload argument name, 'requestBody', for mutations

Signed-off-by: Yoon Lee <[email protected]>

Author: Yoon Lee

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

@@ -33,6 +33,7 @@ Options:
   -o, --operationIdFieldNames    create field names based on the operationId
   -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
+  -g, --genericPayloadArgName    Sets argument name for the payload of a mutation to 'requestBody'
 
   -H, --header <key:value>       add headers to every request; repeatable flag; set using key:value notation (default: [])
   -Q, --queryString <key:value>  add query parameters to every request; repeatable flag; set using key:value notation (default: [])

packages/openapi-to-graphql-cli/src/openapi-to-graphql.ts

@@ -50,6 +50,10 @@ program
     '-a, --addLimitArgument',
     'add a limit argument on fields returning lists of objects/lists to control the data size'
   )
+  .option(
+    '-g, --genericPayloadArgName',
+    'Sets argument name for the payload of a mutation to \'requestBody\''
+  )
 
   // Resolver options
   .option(
@@ -102,6 +106,7 @@ const options: Options = {
   operationIdFieldNames: program.operationIdFieldNames,
   fillEmptyResponses: program.fillEmptyResponses,
   addLimitArgument: program.addLimitArgument,
+  genericPayloadArgName: program.genericPayloadArgName,
 
   // Resolver options
   headers,

packages/openapi-to-graphql/README.md

@@ -158,6 +158,8 @@ Schema options:
 
 - `selectQueryOrMutationField` (type: `object`, default: `{}`): OpenAPI-to-GraphQL, by default, will make all GET operations into `Query` fields and all other operations into `Mutation` fields. This option allows users to manually override this process. The operation 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 `selectQueryOrMutationField` 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 an integer value of either `0`, or `1`, corresponding to `Query` or `Mutation` type respectively. 
 
+- `genericPayloadArgName` (type: `boolean`, default: `false`): Set the default argument name for the payload of a mutation to `requestBody`. Otherwise, the name will default to the camelCased pathname.
+
 ***
 
 Resolver options:

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

@@ -13,7 +13,7 @@ declare type GetGraphQLTypeParams = {
     isInputObjectType?: boolean;
 };
 declare type GetArgsParams = {
-    def?: DataDefinition;
+    requestPayloadDef?: DataDefinition;
     parameters: ParameterObject[];
     operation?: Operation;
     data: PreprocessingData;
@@ -23,8 +23,7 @@ declare type GetArgsParams = {
  */
 export declare function getGraphQLType({ def, operation, data, iteration, isInputObjectType }: GetGraphQLTypeParams): GraphQLType;
 /**
- * Creates an object with the arguments for resolving a GraphQL (Input) Object
- * Type
+ * Creates the arguments for resolving a field
  */
-export declare function getArgs({ def, parameters, operation, data }: GetArgsParams): Args;
+export declare function getArgs({ requestPayloadDef, parameters, operation, data }: GetArgsParams): Args;
 export {};