Skip to content

Publish curl examples for every endpoint #321

Description

@Fury03

Backlog entry #268, from docs/backlog.md — Cross-cutting — Ecosystem and community / I5 — Accessibility and motion.

What

Copy-pasteable, with real responses from the live instance, including the stale and error shapes.

Roadmap impact

V1 — Hardening — I5 — Accessibility and motion.

Constraints that apply

  • assert nothing the repository does not currently support; check claims against
    the code as it is, not as it is described
  • every measurement cited carries its source and the date it was checked
  • mark future capabilities as future — do not describe roadmap items as though
    they are built
  • a negative or inconclusive finding is a valid result and should be reported
    as one

Done when

  • the document lands under docs/ (or in the README where it belongs there)
  • every claim about the code is checked against the code at time of writing
  • nothing is asserted that the repository does not support
  • it is linked from wherever a reader would look for it

Scope and acceptance criteria may be sharpened in the comments before work starts — say so in a comment if you are picking this up. If the work turns out to require changing verdict thresholds, integrity semantics, the check composition rule or the run-record layout, stop and flag it: that is a different issue with a different review bar.

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

    area:ecosystemCommunity, onboarding, downstream consumersdifficulty:easySmall, well-scoped; a few hoursgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions