How To Write Openapi 31 Path Descriptions From An Operation List
OpenAPI drafts invent paths. Descriptions only for listed operations.
The matching generator is the OpenAPI 3.1 Path Descriptions from an Operation List (No Invented Endpoints) (Openapi 31 Path Descriptions From Operation List No Invented Endpoints) prompt. Browse related cards in the PromptDig library (Browse more prompts). When a filled run survives, share the version you actually use (Share a prompt).
Lock the OpenAPI version from Inputs
Write OpenAPI 3.1 path and operation descriptions from a pasted operation list. Never invent paths, methods, or status codes. Start by filling Inputs, not by asking the model to remember last week's run. If a field is blank, write NONE or NOT IN INPUTS and leave it blank through Generate. The card is built so the model cannot honestly invent a number, owner, URL, or command that you did not paste.
Paste these fields before you hit run:
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]
That inventory is the honesty ledger. Anything that does not appear there is forbidden in the draft. If you catch yourself adding a nice-to-have after the run, you are no longer using the card. You are ghostwriting. Put the extra fact in Inputs and run again.
Document only listed methods and paths
Generate is numbered on purpose. Do not skip a step because the first paragraph looked done. The early steps exist to stop later prose from smuggling claims.
Walk the Generate list in order:
- Honesty ledger: Ops count, Version, Codes status, Auth, Lang, Max. Forbidden: invented paths, invented methods, invented 418 jokes.
- Operation map: each method+path with purpose from Ops or NOT IN INPUTS.
- Description pack: YAML fragments under paths: for up to Max ops. summary + description only; responses only if Codes not NONE.
- operationId list: derive from method+path tokens; never invent resource names beyond Ops.
- Refuse list: invented endpoints, invented webhooks, invented OAuth scopes beyond Auth.
- Diff notes: Banned or Never cuts.
- Auth note: if Auth NONE, write auth NOT IN INPUTS in descriptions.
- Compliance pass: Banned/Never hits. Op count vs Max. Gaps list of five. Format as Format.
If a step asks for a version lock, quote the version from Inputs in the output. If a step asks for a refuse list, keep the refuse list in the published artifact, not in a sidebar you delete. Reviewers should see what the model was not allowed to do.
Limit responses to the Codes allowlist
Most failures are the same shape: a missing field gets a confident fill. A conversion rate appears. A Gradle task appears. A flash point appears. A caption appears on a job that asked for slide text only. Your review is to search the draft for numbers, names, and commands, then grep Inputs. No match means cut.
Honor the constraints as hard stops, not vibes:
- 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.
When the card says not legal advice, not certification, not an exam dump, or not a caption engine, that sentence belongs at the top of the output. Deleting it to look more finished is how you inherit risk.
Refuse GraphQL and webhook padding
Finish with the compliance pass the prompt already asks for. Quote the banned-word hits. Cut them. Print character counts when the job has a cap. Print word counts when the job has a budget. List gaps as gaps. Five missing facts are more useful than one smooth paragraph.
Tags on the card (openapi 3.1 descriptions, no invented endpoints, openapi path descriptions) are a reminder of the job shape, not an invitation to wander into a neighboring cluster. If you need a different surface, open a different PromptDig card rather than stretching this one.
Fill the card, then run
Replace every bracket. Run on ChatGPT, Claude, or Gemini. Read the ledger first, then the artifact. If the model invents a commit, KPI, DOI, PEL, bid, or logo, discard the run. Tighten Inputs. Run again. Share the filled card that survived, not the first draft that sounded done.