api-ref-schema

api-ref-schema is a cursor rule for Cursor from AdobeDocs/ff-services-docs. It costs 0 tokens per session (300 once invoked), scanned A, original, Apache-2.0.

A set of rules for designing OpenAPI schemas, which define the data structures used by a web API. It covers names, references, alternatives, and differences between OpenAPI 3.0 and 3.1.

In plain words
What is it for?
Use it when creating or reviewing schema names, properties, `$ref` references, `anyOf` alternatives, and nullable or multi-type values.
Why use it?
It prevents common schema mistakes that can cause lint errors, confusing generated documentation, or incompatibility between OpenAPI versions.

Cursor rule for Cursor

Written for Cursor: installed under .cursor/.

Good fit Use it when creating or reviewing schema names, properties, $ref references, anyOf alternatives, and nullable or multi-type values.

Compare 6 cursor rules from other repositories ↓
Install with agentmods
npx agentmods add rules/adobedocs/ff-services-docs/api-ref-schema
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.

Clone the repo
git clone --depth 1 https://github.com/AdobeDocs/ff-services-docs

Made for: Cursor.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for api-ref-schema

README.md
[![agentmods](https://agentmods.dev/badge/rules/adobedocs/ff-services-docs/api-ref-schema/github.svg)](https://agentmods.dev/rules/adobedocs/ff-services-docs/api-ref-schema)
Your own site
<a href="https://agentmods.dev/rules/adobedocs/ff-services-docs/api-ref-schema"><img src="https://agentmods.dev/badge/rules/adobedocs/ff-services-docs/api-ref-schema/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for api-ref-schema

Your own site · 80×15
<a href="https://agentmods.dev/rules/adobedocs/ff-services-docs/api-ref-schema"><img src="https://agentmods.dev/badge/rules/adobedocs/ff-services-docs/api-ref-schema.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 300 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
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.1 $0.00000 $0.00300
Opus 5.5 $0.00000 $0.00120
Sonnet 5.5 $0.00000 $0.00060
Haiku 4.5 $0.00000 $0.00030

Measured 1mo ago against content hash 005206a3bdaa, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

api-ref-schema 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 1mo ago.

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-schema.mdc · 35 lines

What it actually says

API reference — schemas

Naming

  • Schemas: PascalCase, descriptive (e.g. RemoveBackgroundRequest).
  • Properties: camelCase.
  • Paths: descriptive kebab-case (e.g. /v2/remove-background).

anyOf

  • Do not use anyOf when the only alternative is null — omit from required instead.
  • Do not use anyOf with a single option — use direct $ref or type.
  • Valid anyOf: multiple real type alternatives (not null-only).

OpenAPI 3.1 only

  • Simplify primitive anyOf to type arrays: "type": ["string", "array", "null"].
  • OpenAPI 3.0 does not support multi-value type arrays — do not apply 3.1 patterns to 3.0 files.

$ref siblings

  • Remove title as sibling to $ref (ignored by tools, linter errors).
  • Keep description, deprecated, example siblings where tools support them.
  • Put titles on the referenced schema definition instead.

Organization

  • Group related schemas; avoid duplicates; use $ref (DRY).
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. 1mo ago First seen · 35 lines · 0 tokens per session scan A 005206a3bdaa

Subscribe to this mod's changes

api-ref-schema is a cursor rule published in the GitHub repository AdobeDocs/ff-services-docs (4 stars, last pushed 3mo ago), licensed Apache-2.0. It costs nothing until one of its globs matches a file; then it loads 300 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.