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

[OAS 3.1.0] Summary and description now valid when $ref is set #589

Open
4 tasks
Azquelt opened this issue Jan 19, 2024 · 0 comments · May be fixed by #618
Open
4 tasks

[OAS 3.1.0] Summary and description now valid when $ref is set #589

Azquelt opened this issue Jan 19, 2024 · 0 comments · May be fixed by #618
Assignees
Labels
OAS 3.1.0 All issues related to OpenAPI version 3.1.0 support

Comments

@Azquelt
Copy link
Member

Azquelt commented Jan 19, 2024

Previously, when $ref was used, nothing else should be set. Now, Reference objects allow summary and description to be set along with $ref.

We should:

  • Update existing documentation for $ref
  • Add tests for setting summary and description along with $ref for objects which support them
    • Model tests
    • Annotation tests, where the annotation has ref along with description and/or summary
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
OAS 3.1.0 All issues related to OpenAPI version 3.1.0 support
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant