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

[DOCUMENTATION] Setup OpenAPI Documentation #33

Open
ZombiMigz opened this issue Oct 8, 2022 · 0 comments
Open

[DOCUMENTATION] Setup OpenAPI Documentation #33

ZombiMigz opened this issue Oct 8, 2022 · 0 comments
Labels
Difficult This may include advanced topics, concepts or applications documentation Improvements or additions to documentation

Comments

@ZombiMigz
Copy link
Member

ZombiMigz commented Oct 8, 2022

User Story

As a developer, I want automatically generated documentation for REST endpoints so I can easily understand what each endpoint does.

Technical Tasks

  • Follow this tutorial
  • You don't need to follow it word for word
  • Make sure you can explain the process of adding endpoints to the documentation, so we can get devs to do this in the future

Acceptance Criteria

  • an endpoint returns API docs as a readable page
  • another endpoint returns the OpenAPI/Swagger definition in JSON
@ZombiMigz ZombiMigz added the documentation Improvements or additions to documentation label Oct 8, 2022
@misslame misslame moved this to Todo in Sprint 2 Oct 15, 2022
@misslame misslame added this to the Sprint 3 milestone Nov 11, 2022
@misslame misslame moved this to Todo in Sprint 3 Nov 11, 2022
@owwix owwix moved this from Todo to In Progress in Sprint 2 Nov 15, 2022
@owwix owwix moved this from Todo to In Progress in Sprint 3 Nov 15, 2022
@GuyWhoCode GuyWhoCode removed this from the Sprint 3 milestone Jan 17, 2024
@GuyWhoCode GuyWhoCode added the Difficult This may include advanced topics, concepts or applications label Mar 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Difficult This may include advanced topics, concepts or applications documentation Improvements or additions to documentation
Projects
Status: Todo
Status: In Progress
Status: In Progress
Development

No branches or pull requests

4 participants