Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

describeRoute response configuration should allow reference #9

Closed
ngraef opened this issue Nov 26, 2024 · 0 comments · Fixed by #12
Closed

describeRoute response configuration should allow reference #9

ngraef opened this issue Nov 26, 2024 · 0 comments · Fixed by #12
Assignees
Labels
bug Something isn't working

Comments

@ngraef
Copy link

ngraef commented Nov 26, 2024

The following gives a TypeScript error complaining about $ref not being a know property:

describeRoute({
  responses: {
    401: { $ref: '#/components/responses/401' }
  }
})

However, this is valid according to the OpenAPI spec, and it works as expected at runtime.

The type definition for DescribeRouteOptions["responses"][code:string] should allow a reference object.

@MathurAditya724 MathurAditya724 self-assigned this Nov 30, 2024
@MathurAditya724 MathurAditya724 added the bug Something isn't working label Nov 30, 2024
@MathurAditya724 MathurAditya724 linked a pull request Dec 2, 2024 that will close this issue
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants