Start with get /projects. The entry pairs “v1 stable” with “200”. That pairing is useful only when it is clear why the context supports the state. A renamed field can look harmless in a pull request while breaking an integration that relies on its old meaning.
Begin with the constraint
Review example payloads alongside the schema. Record compatibility assumptions before approving a version change.
Example: GET /projects
The illustrative record contains v1 stable. Its state is 200. Ask what evidence supports that state, which detail is still uncertain and whether the next person could understand it without reading a separate message thread.
Questions for a working review
- Define the decision the reader needs to make. For get /projects, use “v1 stable” as the starting context.
- Find the source behind the example record. For get /projects, use “v1 stable” as the starting context.
- Write down the open question before choosing a state. For get /projects, use “v1 stable” as the starting context.
A small exercise
Take one recent api collaboration example from your own process. Write its context without using a status label, then add the label separately. If the two contradict each other, investigate the source before updating the record. Compare the result with “POST /reviews” in the demonstration to see which distinctions your process needs.
These are planning notes. The specimen is illustrative, and the preview does not process live work.
More field notes →