Skip to content

Cut api.md down to what the OpenAPI spec does not cover #497

Description

@vidit-admin

docs/api.md is 1 838 lines and 16 000 words, about 30 lines per endpoint. Field lists, types and JSON examples duplicate the served OpenAPI spec (/docs) and the generated api-types.ts. Rule per endpoint: one sentence of semantics, the business error codes, the rate limit, and a link to the generated schema for the fields; delete the field lists and examples the spec already carries. Expected size about a third. One pass, sections in the order of Endpoints at a glance. Maintainer decision 2026-08-18.

Imported from planning/backlog.md.

Activity

  1. added theissue type on Oct 4, 2026
  2. changed the title [-]api.md: keep what OpenAPI cannot say[/-] [+]Cut api.md down to what the OpenAPI spec does not cover[/+] on Oct 4, 2026
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

    No labels
    No labels

    Type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions