✍️ Writing

OpenAPI 3.1 Path Descriptions from an Operation List (No Invented Endpoints)

Write OpenAPI 3.1 path and operation descriptions from a pasted operation list. Never invent paths, methods, or status codes.

0.0
0Reviews
P
August 28, 2026

Prompt

Act as an OpenAPI 3.1 path-description writer who only uses a pasted operation list. You fill summary/description/operationId text for listed paths. You do not invent endpoints, HTTP methods, or status codes. This is not a full OpenAPI generator from scratch, not a GraphQL schema writer, and not a Postman collection exporter.
You work only from Inputs. Do not invent stats, citations, quotes, URLs, names, IDs, or records that are not in Inputs.

Inputs:
- Pasted operation list (method path purpose): [Ops]
- OpenAPI version lock: [Version or 3.1.0]
- Status codes I may document (exact list or NONE): [Codes]
- Auth scheme name I may mention (or NONE): [Auth]
- Words I must not use: [Banned]
- What I must never invent: [Never]
- Output format: [Format]
- Language: [Lang]
- Max operations: [Max]

Generate:
1. Honesty ledger: Ops count, Version, Codes status, Auth, Lang, Max. Forbidden: invented paths, invented methods, invented 418 jokes.
2. Operation map: each method+path with purpose from Ops or NOT IN INPUTS.
3. Description pack: YAML fragments under paths: for up to Max ops. summary + description only; responses only if Codes not NONE.
4. operationId list: derive from method+path tokens; never invent resource names beyond Ops.
5. Refuse list: invented endpoints, invented webhooks, invented OAuth scopes beyond Auth.
6. Diff notes: Banned or Never cuts.
7. Auth note: if Auth NONE, write auth NOT IN INPUTS in descriptions.
8. Compliance pass: Banned/Never hits. Op count vs Max. Gaps list of five. Format as Format.

Constraints:
- OpenAPI 3.1 descriptions from Ops only. Not GraphQL and not a full greenfield spec.
- Never invent endpoints, methods, or status codes beyond Codes.
- Stay at or under Max operations.
- No emojis.

Instructions

Replace every [bracket] with your details before running. Works on ChatGPT, Claude, and Gemini.

Examples

Example Input

Ops:
GET /v1/meshes/{id} - fetch one mesh membership view
POST /v1/meshes/{id}/digests - accept a gossip digest blob
DELETE /v1/meshes/{id}/members/{memberId} - remove a member hint
Version: 3.1.0
Codes: 200, 201, 404 (do not invent 429 or 500)
Auth: bearerAuth
Banned: blazing fast, industry leading, guaranteed uptime
Never: invent paths, invent methods, invent status codes, invent webhook URLs
Format: ledger + map + yaml + operationIds + refuse + diff + auth-note + gaps
Lang: English
Max: 3

Example Output

1. Ledger. Ops 3. Version 3.1.0. Codes 200,201,404. Auth bearerAuth. Lang English. Max 3. Forbidden: invented paths, invented methods, invented 429/500, blazing fast, industry leading, guaranteed uptime.

2. Map. GET /v1/meshes/{id}: fetch one mesh membership view. POST /v1/meshes/{id}/digests: accept gossip digest blob. DELETE /v1/meshes/{id}/members/{memberId}: remove member hint.

3. YAML fragments.
paths:
  /v1/meshes/{id}:
    get:
      summary: Fetch one mesh membership view
      description: Returns the membership view for path id. Auth bearerAuth. Status codes limited to 200 and 404 from Inputs.
      operationId: getV1MeshesId
      responses:
        '200': { description: Membership view returned }
        '404': { description: Mesh id not found }
  /v1/meshes/{id}/digests:
    post:
      summary: Accept a gossip digest blob
      description: Accepts a digest blob for mesh id. Auth bearerAuth. Success 201 when Codes allow.
      operationId: postV1MeshesIdDigests
      responses:
        '201': { description: Digest accepted }
        '404': { description: Mesh id not found }
  /v1/meshes/{id}/members/{memberId}:
    delete:
      summary: Remove a member hint
      description: Removes memberId hint from mesh id. Auth bearerAuth.
      operationId: deleteV1MeshesIdMembersMemberId
      responses:
        '200': { description: Member hint removed }
        '404': { description: Mesh or member not found }

4. operationIds. getV1MeshesId; postV1MeshesIdDigests; deleteV1MeshesIdMembersMemberId.

5. Refuse. Extra paths: refused. Webhooks: refused. Status 429/500: refused (not in Codes).

6. Diff. Cut blazing fast / industry leading / guaranteed uptime if attempted in descriptions.

7. Auth. bearerAuth named in each description. No invented OAuth scopes.

8. Compliance. Banned hits none. Ops 3 vs Max 3. Gaps: requestBody schemas, parameter types for id/memberId, securitySchemes block detail, examples objects, servers list.

Missing-data policy: if a field was blank, write NOT IN INPUTS rather than guessing. Lock any tool version named in Inputs; if unnamed, write unknown. No invented testimonials, star ratings, or press logos. If legal, clinical, insurance, HR, education-plan, or veterinary content appears, add a one-line not-advice and de-identify banner. Quote banned-word hits and cut them. End with a gaps list of five bullets the user still owes you. Character and byte caps in the job are hard; print counts when relevant. Refuse to backfill DOIs, exam dumps, PHI, PII, or compensation promises not in Inputs.

Reviews (0)

Please login to leave a review.
Loading reviews...