restful-hateoas

RESTful API design guidelines following the Richardson Maturity Model through to Level 3 (HATEOAS) for Ruby on Rails. This skill should be used when designing, building, reviewing, or refactoring REST APIs to ensure proper resource modeling, HTTP method semantics, hypermedia controls, content negotiation, and API evolvability. Triggers on tasks involving API controllers, serializers, routing, link relations, pagination, error handling, or HTTP caching in Rails.

Jump to install

Repository: pproenca/dot-skills
Last source activity: May 14, 2026 at 18:16
Detected SKILL.md language: English
Stars: 194
Forks: 17

Install options

The review-first prompt is selected by default. You can switch to a direct command or download a local copy.

Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.

A direct command skips the review prompt. Inspect the source before running it.

npx skills add https://github.com/pproenca/dot-skills --skill restful-hateoas

The command stays on one line. Scroll horizontally to inspect it before copying.

Prefer a local copy? Download the files currently available to SkillsMP.

Review the source files

Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.

File Explorer

52 files

SKILL.md

Source instructions · Read-only preview

Back to search Back to installation

drizzle-nextjs-postgres

Drizzle ORM against PostgreSQL inside a Next.js App Router app. Covers client construction (globalThis singleton across HMR, serverless pool sizing, `prepare:false` behind PgBouncer/Supavisor, driver choice when you need interactive transactions, `server-only`), reads in Server Components under Next.js 16 Cache Components (`use cache` superseding `unstable_cache` and the `revalidate`/`dynamic` segment configs, Suspense boundaries, React `cache()` dedupe), Server Actions (authorization inside the action, `updateTag` vs `revalidateTag`, `after()`), Postgres schema types (timestamptz, identity vs serial, jsonb, numeric-as-string, bigint modes), drizzle-kit migrations (generate vs push, CONCURRENTLY outside the migrator, NOT VALID constraints, rename prompts), transactions and pooled connections, and Postgres query traps (keyset pagination, count cost, driver-dependent `db.execute()` shape, NOT IN nulls, prepared statements). Use when writing or reviewing Drizzle + Postgres code in Next.js.

2026-07-24

relational-data-modeling

Corrects the wrong defaults a model has when designing a relational schema — the DDL decisions an experienced engineer makes differently. Use when creating or reviewing tables, migrations, ER models, or ORM schema definitions. Covers identity and keys (surrogate vs natural, identity vs serial, uuidv7, composite keys that make cross-tenant references impossible), relationships (polymorphic foreign keys the database cannot enforce, referential actions, unindexed FK columns, disjoint subtypes), invariants the engine can prove instead of application code (EXCLUDE, partial unique indexes, CHECK limits, deferrable cycles, NOT VALID), types (timestamptz, exact money, range types, enum vs lookup table), derived and encoded data (generated columns, JSONB as an escape hatch), and time (events vs in-place updates, soft-delete flags that silently disable constraints, temporal keys). NOT for query tuning, index selection for read paths, or connection pooling.

2026-07-23

relational-database-design

Distills a logical relational-database design methodology into rules an agent applies while designing or reviewing a schema. Covers the design sequence (mission → tables → fields → keys → relationships → business rules → views → integrity review), one-subject-per-table decomposition, atomic single-valued fields, candidate/primary/foreign keys, relationship types with deletion rules and participation, the four levels of data integrity, database-vs-application business rules, validation tables, views for derived data, and the flat-file / spreadsheet / RDBMS-driven antipatterns to avoid. The structure is logical and RDBMS-agnostic, and normalized by construction. Use when designing a new relational schema, reviewing or refactoring an existing one, resolving redundant or repeating data, choosing keys, modeling relationships, or deciding where a constraint belongs.

2026-07-23

View all from this repository

name

restful-hateoas

description

Community RESTful HATEOAS Best Practices

Comprehensive guide to building REST APIs that reach the Glory of REST (Richardson Maturity Level 3) in Ruby on Rails. Contains 47 rules across 9 categories, ordered by the request/response lifecycle — from resource URI design through hypermedia link relations to API evolution.

When to Apply

Reference these guidelines when:

Designing new REST API endpoints and resource URIs
Adding hypermedia controls (_links, affordances) to API responses
Implementing content negotiation with HAL, JSON:API, or vendor media types
Building paginated, filterable, sortable collection endpoints
Reviewing APIs for proper HTTP method semantics and status codes
Evolving APIs without breaking existing clients

Rule Categories by Priority

Priority	Category	Impact	Prefix
1	Resource Modeling	CRITICAL	`res-`
2	HTTP Method Semantics	CRITICAL	`http-`
3	Hypermedia & Link Relations	CRITICAL	`link-`
4	Status Codes & Response Headers

File	Description
references/_sections.md	Category definitions and ordering
assets/templates/_template.md	Template for new rules
metadata.json	Version and reference information

restful-hateoas

Install options

Review the source files

Community RESTful HATEOAS Best Practices

When to Apply

Rule Categories by Priority

Community RESTful HATEOAS Best Practices

When to Apply

Rule Categories by Priority

Quick Reference

1. Resource Modeling (CRITICAL)

2. HTTP Method Semantics (CRITICAL)

3. Hypermedia & Link Relations (CRITICAL)

4. Status Codes & Response Headers (HIGH)

5. Content Negotiation & Media Types (HIGH)

6. Collection Patterns (MEDIUM-HIGH)

7. Error Semantics (MEDIUM)

8. Caching & Conditional Requests (MEDIUM)

9. API Evolution (LOW-MEDIUM)

How to Use

Reference Files

restful-hateoas

Source facts

Install options

Review the source files

More from this repository

Community RESTful HATEOAS Best Practices

When to Apply

Rule Categories by Priority

Community RESTful HATEOAS Best Practices

When to Apply

Rule Categories by Priority

Quick Reference

1. Resource Modeling (CRITICAL)

2. HTTP Method Semantics (CRITICAL)

3. Hypermedia & Link Relations (CRITICAL)

4. Status Codes & Response Headers (HIGH)

5. Content Negotiation & Media Types (HIGH)

6. Collection Patterns (MEDIUM-HIGH)

7. Error Semantics (MEDIUM)

8. Caching & Conditional Requests (MEDIUM)

9. API Evolution (LOW-MEDIUM)

How to Use

Reference Files

More from this repository