Prompt #119

Variables

method, path, purpose, request_schema, response_schema, auth

Tags

api,documentation,openapi,rest

Source

research-2026-05-01

Use count

0

Created

2026-05-01T18:11:52.162090+00:00

Updated

2026-05-01T18:11:52.162090+00:00

Content

Generate OpenAPI 3.0 documentation for the following API endpoint.

Endpoint: {{method}} {{path}}
Purpose: {{purpose}}
Request body: {{request_schema}}
Response body: {{response_schema}}
Authentication: {{auth}}

Generate:
1. Full OpenAPI YAML snippet for this endpoint
2. Markdown description with example request/response
3. Error codes table (status code | meaning | when it occurs)
4. Code examples in: Python (requests), JavaScript (fetch), curl

Standards: use JSON:API or REST conventions, include rate-limit headers in response.