agentleFS
gerard-labsgerard-labs/superpowers-api-platform/skills/api-platform-identifiers/SKILL.md

api-platform-identifiers

Skill2 starsChanged 6 months agoMITView on GitHub

Choose and wire up API Platform 4.3 resource identifiers — UUID v7 (recommended for temporal cursor pagination), ULID, scalar (string/int), `\DateTimeInterface`, composite identifiers via `Link(uriVariables: …)`, custom identifiers (slug) with `#[ApiProperty(identifier: true)]`, decorating `UriVariableTransformerInterface` to coerce strings into typed objects (Uuid, custom), decorating `IdentifiersExtractorInterface` to format identifiers in responses (ISO date, custom). Trigger when modeling a new resource, switching from auto-increment ID to UUID v7 / ULID for anti-enumeration, supporting cursor-based pagination on a chronological field, or exposing a slug as the public identifier.

The file

We split this skill into the rules it gives an agent

2 rules. About 0 are common, 1 is distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Default to UUID v7 (Symfony\Component\Uid\Uuid::v7()) on public resources — chronologically sortable + non-enumerable.

    line 23
  2. Distinctive:

    Composite identifiers: must be stable — never reuse a (customerId, orderId) pair.

    line 33

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

API Platform 4.3 — Identifiers (UUID v7, ULID, composite, custom)

Use when

  • Designing a new resource: should the identifier be a sequential int, a UUID, a ULID, or a slug?
  • Switching an existing resource from auto-increment to UUID v7 (anti-enumeration + cursor pagination).
  • Modeling a composite identifier (/customer/{customerId}/order/{orderId}).
  • Exposing a slug as the public identifier while keeping an internal numeric ID.
  • Customizing how an identifier is parsed from the URI or rendered in the response.

Default workflow

  1. Default to UUID v7 (Symfony\Component\Uid\Uuid::v7()) on public resources — chronologically sortable + non-enumerable.
  2. Annotate the identifier with #[ApiProperty(identifier: true)] and persist it as a native uuid column (PostgreSQL) or as a ulid column.
  3. For composite identifiers, declare them in uriVariables with Link(fromClass: …, identifiers: ['id']).
  4. For custom identifiers (slug), set #[ApiProperty(identifier: true)] on the slug and #[ApiProperty(identifier: false)] on the auto-increment id.
  5. Decorate UriVariableTransformerInterface only when the string-to-typed-object conversion is non-trivial.

Guardrails

  • No sequential auto-increment IDs on public resources. Volume leakage + enumeration.
  • UUID v7 > UUID v4 for any resource where chronological ordering helps (cursor pagination, B-tree indexing).
  • Native DB column types: uuid (PostgreSQL) instead of varchar(36) — better indexing, smaller storage.
  • Composite identifiers must be stable — never reuse a (customerId, orderId) pair.

Progressive disclosure

  • SKILL.md covers the decision tree.
  • reference.md carries the full catalog (supported types), UUID v7 + cursor pagination wiring, composite identifiers with Link, custom slug pattern, UriVariableTransformerInterface and IdentifiersExtractorInterface recipes.

Output contract

  • Public resources use UUID v7 / ULID / slug — no exposed auto-increment.
  • Composite identifiers declared via Link(uriVariables: …, identifiers: […]).
  • DB columns use native types where supported.
  • Tests assert the IRI shape (UUID format, slug format) instead of integer matching.

References

  • reference.md

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.