Add addLimitArgument option

Updated license to confirm with MIT template

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

Author: Alan-Cha

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

@@ -27,6 +27,7 @@ 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
   -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

@@ -32,6 +32,10 @@ program
     '-f, --fillEmptyResponses',
     'create placeholder schemas for operations with HTTP status code 204 (no response) rather than ignore them'
   )
+  .option(
+    '-a, --addLimitArgument',
+    'add limit argument on fields returning lists of objects/lists to control the data size'
+  )
   .option(
     '-o, --operationIdFieldNames',
     'create field names based on the operationId'
@@ -157,7 +161,8 @@ function startGraphQLServer(oas, port) {
     fillEmptyResponses: program.fillEmptyResponses,
     baseUrl: program.url,
     operationIdFieldNames: program.operationIdFieldNames,
-    provideErrorExtensions: program.extensions
+    provideErrorExtensions: program.extensions,
+    addLimitArgument: program.addLimitArgument
   })
     .then(({ schema, report }) => {
       console.log(JSON.stringify(report, null, 2))

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

@@ -164,6 +164,8 @@ The options object can contain the following properties:
 
 - `customResolvers` (type: `object`, default: `{}`): OpenAPI-to-GraphQL, per 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/)._
 
+- `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.
+
 Consider this example of passing options:
 
 ```javascript