Requests and responses
A placeholder for the verified request and response schemas.
Working scaffold: Field names and response examples are illustrative placeholders. Do not send them to a live service.
Request contract
For each endpoint, document the method and path, content type, required and optional fields, accepted values, defaults, size limits, and whether unknown fields are rejected or ignored. Identify features that vary by model or downstream service.
Response contract
Describe the success envelope, content types, output fields, usage or diagnostic metadata, and any partial-result behavior. Explain streaming separately if it changes the response format.
Schema maintenance
Keep schemas versioned and reviewed with the service implementation. If an OpenAPI document exists, link to its canonical source and note how clients can use it. Do not publish a generated schema that is out of sync with production.