api-ref-structure

A set of rules for organizing and validating OpenAPI files, which describe web APIs. It defines the order of major sections, required license information, valid JSON, and working schema references.

In plain words
What is it for?
Use it when checking or repairing OpenAPI structure, including section order, licenses, schema names, references, and version-specific rules.
Why use it?
It catches structural problems that can make API documentation inconsistent, invalid, or difficult for tools to process.

Cursor rule for Cursor

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/adobedocs/ff-services-docs/api-ref-structure
Clone the repo
git clone --depth 1 https://github.com/AdobeDocs/ff-services-docs

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 263 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00000 $0.00263
Opus 5 $0.00000 $0.00131
Sonnet 5 $0.00000 $0.00053
Haiku 4.5 $0.00000 $0.00026

Measured yesterday against content hash 8fe1b410f546, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

api-ref-structure scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.cursor/rules/api-ref-structure.mdc · 44 lines

What it actually says

API reference — structure

Section order

Top-level keys in this order:

  1. openapi (version, always first)
  2. info (include license when missing)
  3. servers
  4. security
  5. tags
  6. paths
  7. components (always last)

License boilerplate

When info.license is missing, add:

"license": {
  "name": "Adobe Creative API License",
  "url": "https://www.adobe.com/content/dam/cc/en/legal/terms/enterprise/pdfs/PSLT-AdobeCreativeAPI-WW-2024v2.pdf"
}

Validity

  • Valid JSON syntax.
  • All $ref paths resolve to existing schemas.
  • No duplicate schema names in components.schemas.
  • Verify openapi version (3.0.x vs 3.1.x) before applying version-specific schema rules.

File organization

  • Group related endpoints (operation + status) together.
  • Organize schemas by function or alphabetically.
  • Consistent indentation.
Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 44 lines · 0 tokens per session scan A 8fe1b410f546

Subscribe to this mod's changes

api-ref-structure is a cursor rule published in the GitHub repository AdobeDocs/ff-services-docs (4 stars, last pushed 2mo ago), licensed Apache-2.0. It costs nothing until one of its globs matches a file; then it loads 263 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.