Instruction file imported from AdobeDocs/ff-services-docs (
.cursor/rules/api-ref-router.mdc). Copyright stays with the author.
API reference router
When editing or reviewing OpenAPI JSON under static/, use the right skill. Load modular rules only when needed.
Task routing
| User intent | Skill | Edits? |
|---|---|---|
/api-eval, evaluate, audit |
api-eval | No — findings only |
/api-review, catalog descriptions |
api-review | No — tables for manual review |
/api-fix, fix lint or structure |
api-fix | Yes — lint + api-ref-structure |
Resolve the spec path with _shared/resolve-api-spec.md. Do not assume petstore.json.
Non-negotiable description rule
- HTTP response
description(status lines): Title Case, no trailing period (e.g.Internal Server Error). - All other descriptions (operations, parameters, schemas, headers): complete sentences with periods.
Modular rules (load on demand)
api-ref-structure.mdc— section order, license, JSON/$refapi-ref-copy.mdc— summaries, punctuation, public-facing textapi-ref-schema.mdc— anyOf, type arrays, $ref/titleapi-ref-examples.mdc— Redocly examplesapi-ref-tags-errors.mdc— tags, errors, authapi-ref-ffs-styleguide.mdc— Firefly Services API Style Guide (api-eval only)
Legacy monolith: eval-API-ref.mdc (deprecated stub).