Skip to content

Document the backend HTTP API in the hub #10

Description

@Glittersup

Problem. ARCHITECTURE.md covers the read path conceptually, but endpoints, query parameters, response shape, and error codes live only in the backend README and in code. A third-party client author has to read the source.

Acceptance criteria

  • The hub documents every endpoint with parameters and response shape.
  • It stays in sync with the backend's generated OpenAPI spec.

Activity

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