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.

Sign up for GitHub

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

Jump to bottom

OpenAPI Documentation #47

Open
Tethik opened this issue Jun 29, 2023 · 0 comments
Open

OpenAPI Documentation #47

Tethik opened this issue Jun 29, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@Tethik
Copy link
Member

Tethik commented Jun 29, 2023

As per Service Rulebook we ought to supply OpenAPI documentation for our service. Currently we have no dependents planned, so we can likely wait with doing it. However some teams have expressed an interest in consuming our API, so it could be relevant in the future.

Ideally it would be something that can be automatically generated, perhaps something that can be considered with #44 for a more general refactor of the API backend.
@Tethik Tethik added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Tethik