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

OpenAPI Documentation #185

Open
1 of 4 tasks
iaktern opened this issue Dec 8, 2023 · 1 comment
Open
1 of 4 tasks

OpenAPI Documentation #185

iaktern opened this issue Dec 8, 2023 · 1 comment
Assignees

Comments

@iaktern
Copy link
Contributor

iaktern commented Dec 8, 2023

Our REST API should be documented with the OpenAPI spec:

  • Create OpenAPI Spec in new Backend
  • Describe in the wiki, how to update the OpenAPI spec
  • If the OpenAPI Spec changes, update the website documentation automatically via the pipeline
  • Automatic OpenAPI Test: create an automatic checker in pipeline for the OpenAPI documentation
@iaktern
Copy link
Contributor Author

iaktern commented Dec 8, 2023

Blocked by: #158

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Todos: Fine-Grained
Development

No branches or pull requests

3 participants