Skip to content

Demote one organisation's HTTP API style from MUST to an example #2130

Open

Description

@braboj

Part of #2124.

backend/http.md states one house style as universal MUST. A project with its own API guide must break these rules to keep it.

  • :37-45 paths: lowercase hyphens, American English, no abbreviations
  • :48-52 camelCase query names; reserved limit, skip, offset, expand, sortedBy
  • :96-109 a links array with href, rel, type and media; backend/api.md:90 depends on it

Done when

  • Protocol-level rules stay: methods, status codes, RFC 9457 errors, timeouts
  • The style rules become an example the project adopts, or SHOULD with a reason

Activity

  1. added
    P3Low — nice to have
    taskAtomic implementable work
    on Oct 22, 2026
  2. braboj commented on Oct 22, 2026

    @braboj
    CollaboratorAuthor

    A second agent review (2026-10-22) agrees: offer the API spelling, parameter names and response layout as defaults a project adopts explicitly, not as universal rules.

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

    P3Low — nice to havetaskAtomic implementable work

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions