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

Decide if OpenAPI spec is useful (and write it if so) #528

Open
azaroth42 opened this issue Oct 13, 2023 · 1 comment
Open

Decide if OpenAPI spec is useful (and write it if so) #528

azaroth42 opened this issue Oct 13, 2023 · 1 comment
Labels
API The issue is about an API or service discuss Discussion of this topic needed question
Milestone

Comments

@azaroth42
Copy link
Collaborator

azaroth42 commented Oct 13, 2023

Consider if providing an OpenAPI specification would add value. It might be just a reflection of the JSON schema to the fact that there's a GET response.

https://spec.openapis.org/oas/v3.1.0#response-object

@azaroth42 azaroth42 added API The issue is about an API or service question labels Nov 13, 2023
@azaroth42 azaroth42 changed the title Write OpenAPI specs for the APIs Decide if OpenAPI spec is useful (and write it if so) Nov 13, 2023
@azaroth42 azaroth42 added the discuss Discussion of this topic needed label Nov 13, 2023
@azaroth42 azaroth42 added this to the 1.1 milestone Nov 15, 2023
@azaroth42
Copy link
Collaborator Author

1.1 as backwards compatible and not a necessary community affordance like validators

@azaroth42 azaroth42 modified the milestones: 1.1, Questions Apr 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API The issue is about an API or service discuss Discussion of this topic needed question
Projects
None yet
Development

No branches or pull requests

1 participant