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

Write API documentation for all desired endpoints #29

Open
marsbergen opened this issue Aug 5, 2024 · 0 comments
Open

Write API documentation for all desired endpoints #29

marsbergen opened this issue Aug 5, 2024 · 0 comments
Labels
testing Improvements for Test Engineers

Comments

@marsbergen
Copy link
Contributor

Requirements

  • Write an API documentation for all desired endpoints defined in the product backlog
  • Make sure input and output are aligned with existing endpoints in the backend project.
  • Optionally mark which endpoints are currently in use and which are planned
  • You can use any form of styling or build system, but the docs should be able to be hosted as statics on s3.
  • It's open to choose to host the API docs close to the endpoints or on their own.
@marsbergen marsbergen added the testing Improvements for Test Engineers label Aug 5, 2024
@infowijs infowijs locked and limited conversation to collaborators Aug 6, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
testing Improvements for Test Engineers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@marsbergen