Skip to content

Write API documentation for all desired endpoints #29

Open

Description

@marsbergen

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.

Activity

  1. locked and limited conversation to collaborators on Aug 6, 2024
  2. added
    documentationImprovements or additions to documentation
    and removed
    testingImprovements for Test Engineers
    on Jan 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions