Review API documentation for contract mismatches

API examples should match the implemented route, authentication and response shape. Review a bounded endpoint set rather than guessing the entire service contract.

Use a reviewable project copy

Give the product or code teammate the relevant specification and a dedicated project folder or branch. Separate a proposed change from permission to release it. Request a diff or evidence table alongside the recommendation, and run checks that exercise the behavior in question. Generated code and test output still need review in the actual project environment.

Inputs for this workflow: API documentation, relevant route code and approved example responses.

Work through the task

1. Map examples to implemented handlers.
2. Compare required fields and error behavior.

A brief you can adapt

Create api-doc-review.md with endpoint, mismatch, code reference and corrected example proposal. Use placeholder credentials only.

The filenames above are examples. Replace them with your actual inputs and destination before submitting the task.

Review the deliverable

Run approved read-only or isolated tests to verify examples before publishing them.

Where this approach can fail

Do not send state-changing requests to production merely to validate a documentation draft.

For the related desktop setup, see local folder.