Skip to content

[BUG] TypeError generating OpenAPI with Request Schema Validators #245

@okonomi

Description

@okonomi

Describe the bug

I configured it according to "Serverless Request Schema Validators" in the README, but an error occurred.

https://github.com/JaredCE/serverless-openapi-documenter?tab=readme-ov-file#serverless-request-schema-validators

To Reproduce

serverless.yml is as follows:

service: serverless-openapi-doc-demo
frameworkVersion: "4"
provider:
  name: aws
  runtime: nodejs14.x
  apiGateway:
    request:
      schemas:
        user:
          name: User
          schema:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
              email:
                type: string

plugins:
  - serverless-openapi-documenter

custom:
  documentation:
    version: 1.0.0

functions:
  createUser:
    handler: handler.createUser
    events:
      - http:
          path: users
          method: post
          request:
            schemas:
              application/json: user
          documentation:
            methodResponses:
              - statusCode: 201
              - statusCode: 400

Expected behavior

run this command:

npx sls openapi generate --output openapi.json

and raise this error:

OpenAPI v3 Description Generation
[OPTIONS]
  openApiVersion: "3.0.0"
  format: "json"
  output file: "openapi.json"
  indentation: "2"
  validationWarn: false

Generating OpenAPI Description
✖ ERROR: An error was thrown generating the OpenAPI v3 Description

✖ ServerlessError2: ServerlessError2: TypeError: Cannot convert undefined or null to object
    at /Users/okonomi/src/github.com/okonomi/serverless-openapi-documenter-example/node_modules/.pnpm/serverless-openapi-documenter@0.0.113/node_modules/serverless-openapi-documenter/src/openAPIGenerator.js:144:13
    at async OpenAPIGenerator.generate (/Users/okonomi/src/github.com/okonomi/serverless-openapi-documenter-example/node_modules/.pnpm/serverless-openapi-documenter@0.0.113/node_modules/serverless-openapi-documenter/src/openAPIGenerator.js:143:26)
    at async PluginManager.runHooks (file:///Users/okonomi/.serverless/releases/4.14.2/package/dist/sf-core.js:1241:9549)
    at async PluginManager.invoke (file:///Users/okonomi/.serverless/releases/4.14.2/package/dist/sf-core.js:1241:10318)
    at async PluginManager.run (file:///Users/okonomi/.serverless/releases/4.14.2/package/dist/sf-core.js:1241:11047)
    at async Serverless.run (file:///Users/okonomi/.serverless/releases/4.14.2/package/dist/sf-core.js:1248:10523)
    at async runFramework (file:///Users/okonomi/.serverless/releases/4.14.2/package/dist/sf-core.js:1275:1777)
    at async TraditionalRunner.run (file:///Users/okonomi/.serverless/releases/4.14.2/package/dist/sf-core.js:1271:28313)
    at async route (file:///Users/okonomi/.serverless/releases/4.14.2/package/dist/sf-core.js:1302:2779)
    at async Object.run (file:///Users/okonomi/.serverless/releases/4.14.2/package/dist/sf-core.js:1303:3661)

For help, try the following:
  • Run the command again with the "--debug" option
  • Run "serverless support"
  • Review the docs: https://www.serverless.com/framework/docs/

Desktop (please complete the following information):

  • Serverless version: 4.14.2
  • serverless-openapi-documenter version: 0.0.113

Additional context
Add any other context about the problem here.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions