Home / outlinedriven / outline-driven-development · GitHub

document-api-endpoint SKILL.md skillA

document-api-endpoint from outlinedriven/outline-driven-development is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned

mdr add outlinedriven/outline-driven-development/document-api-endpoint@git:20260912.5c5b759

Pins git:20260912.5c5b759 in mdr.lock. Pin the fingerprint instead.

Audit grade: A, 17 of 17 checks passed
Kind: SKILL.md skill
Repository: outlinedriven/outline-driven-development
Path: .devin/skills/document-api-endpoint/SKILL.md
Versions recorded: 3
Latest version: git:20260912.5c5b759, committed Sep 12, 2026
First version recorded: Sep 2, 2026
Size: 4,906 bytes
Repository stars: 55
License: Apache-2.0

Use when reconciling an API endpoint''s generated OpenAPI schema and declared response types with its actual runtime response. Not for general API documentation: use docs-and-adrs.

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

# Document and type an API endpoint

## Contract

| Field | Bound contract |
|---|---|
| Trigger | User asks to document, type, or fix OpenAPI schema for an endpoint whose generated spec drifts from its runtime response. |
| Authority | Reversible local: writes only the endpoint class and API documentation files for that one path; rollback is version control (revert to recover). No remote mutation. |
| Side effect | Updates or adds OpenAPI schema annotations and response types for one endpoint path. |
| Done | Endpoint has accurate schema annotations, typed responses matching runtime, and passing local schema validation. |

## Inputs

- The endpoint route and HTTP method(s) to document, plus the serving class or handler (required).
- The runtime response shape: confirmed via a live request, a tool that calls the endpoint, or a test that exercises the path and captures the response (required).
- Optional: a request to promote the endpoint from a private or experimental status to public.

## Procedure
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint

mdr add outlinedriven/outline-driven-development/document-api-endpoint@sha256:aac30dce056da705

The line at the top of this page pins the label git:20260912.5c5b759, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

[![mdr](https://markdownregistry.com/badge/art_nkuei34pa4rvt3ti.svg)](https://markdownregistry.com/a/art_nkuei34pa4rvt3ti)

4 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 3 versions of this file, between Sep 2, 2026 and Sep 12, 2026, about one every 5 days.

version	committed	commit	size	audit
git:20260912.5c5b759 latest	2026-09-12	5c5b759	4,906 B	A	view · diff
git:20260905.1f63894	2026-09-05	1f63894	4,875 B	A	view · diff
git:20260902.1fe14a3	2026-09-02	1fe14a3	4,974 B	A	view

Audit of the latest version

A 17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.

pass: Frontmatter block present
pass: Frontmatter declares a name
pass: Frontmatter declares a description
pass: Size between 200 bytes and 200 KB (4906 bytes)
pass: No zero-width or bidi control characters
pass: No instruction hidden inside an HTML comment
pass: No link to an exfiltration or paste host
pass: No credential-shaped string
pass: No instruction to send local credentials anywhere
pass: No text hidden with inline styles
pass: No prompt-injection phrasing
pass: No curl or wget piped into a shell
pass: No recursive delete of root, home or parent
pass: No instruction to read or print local credentials
pass: No base64 blob over 200 characters
pass: No link to a raw IP address
pass: No script tag

Source

GitHub

outlinedriven/outline-driven-development · 55 stars · license Apache-2.0 · pushed 2026-09-28 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_nkuei34pa4rvt3ti
GET https://markdownregistry.com/api/v1/resolve?ref=outlinedriven/outline-driven-development/document-api-endpoint
GET https://markdownregistry.com/api/v1/blob/aac30dce056da70536856362238b0ae25662e6ba1af2b1bde78c4b50d2f116df

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.

More from outlinedriven/outline-driven-development

abi-and-calling-conventions SKILL.md skill

outlinedriven/outline-driven-development · .devin/skills/abi-and-calling-conventions/SKILL.md · Use when explaining System V AMD64, ARM AAPCS, RISC-V psABI, stack frames, variadic calls, or FFI register rules. Not…

git:20260905.e0ca87e · audit A · 55 stars

abstract-well SKILL.md skill

outlinedriven/outline-driven-development · .devin/skills/abstract-well/SKILL.md · Use when the user wants to classify abstractions as useful, bad, or busy and keep one shallow level. Not for tasks…