danielgolub / openapi-middleware Goto Github PK

Is your feature request related to a problem? Please describe.
Support json ref parsing capability to take references from different sections of the file.

Describe the solution you'd like
https://swagger.io/docs/specification/components/

Describe alternatives you've considered
N/A

Additional context
N/A

Describe the feature
add Dependabot config.
make sure it will label its PRs with a custom label

Is your feature request related to a problem? Please describe.
when securityScheme is the following:

securitySchemes:
  basicAuth:
    type: 'apiKey'
    in: 'cookie'
    name: 'cookieParam'

we throw an exception. need to add cookie support here including tests.

Describe the solution you'd like
Follow official spec: https://swagger.io/docs/specification/authentication/

Add it to the enum here:

And also add respective test case here (another param for cookie):

Describe alternatives you've considered
N/A

Additional context
N/A

Is your feature request related to a problem? Please describe.
we currently validate all input parameters, we need to also validate response codes + body

Describe the solution you'd like
https://swagger.io/docs/specification/describing-responses/

Describe alternatives you've considered
N/A

Additional context
N/A

Describe the bug
Missing support for security validators

To Reproduce
OpenAPI definition:

openapi: 3.0.0
info:
  title: Sample API
  description: Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML.
  version: 0.1.0
securitySchemes:
  basicAuth:
    type: 'http'
    scheme: 'basic'
paths:
  /greeting:
    get:
      summary: Returns a greeting for a guest.
      description: Sample endpoint that returns a greeting.
      operationId: greetingGuest
      security:
        - basicAuth: []
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                type: object
                responseText:
                  type: string

Expected behavior
should be able to pass to config a handler for each securityScheme.

Desktop (please complete the following information):

• OS: MacBook Pro
• Node Version: 14.x / 16.x / 18.x

Describe the bug
missing byte / binary validator

To Reproduce
OpenAPI definition:

type: string
format: byte/binary

Expected behavior
Validate the input to be binary / byte

Desktop (please complete the following information):

• OS: MacBook Pro
• Node Version: 14.x, 16.x, 18.x

Additional context

missing docs for index export.
same for readme.

Describe the bug
multipleOf for numeric properties is not being validated

To Reproduce
OpenAPI definition:

type: integer
multipleOf: 10

Expected behavior
Validate increments multiplied by the specified number

Desktop (please complete the following information):

• OS: MacBook Pro
• Node Version: 14.x, 16.x, 18.x

Additional context
Need to add custom validator to the openapi-schema-validator usage

Is your feature request related to a problem? Please describe.
Missing support for oauth2 / openIdConnect in security schemes.

Describe the solution you'd like
Need to add support here:

Describe alternatives you've considered
N/A

Additional context
N/A

Feature description
Missing JSDOC integration for easier development experience.
Consider adding GitHub Pages integration.