REST naming and HTTP methods

RFC 9110 URI and method rules checked by ADP-001 to ADP-007.

Automated naming and method rules

Enforced directly on OpenAPI paths, request bodies, and status codes.

RulePrincipleBad patternGood patternStandard
ADP-001Plural resource nouns, no CRUD verbsGET /v1/getUsersGET /v1/usersRFC 9110 §9
ADP-002Lowercase kebab-case path segments/v1/paymentMethods/v1/payment-methodsRFC 3986 / AIP-122
ADP-003No trailing slashes/v1/orders//v1/ordersHTTP Cache Keys
ADP-005GET/HEAD must never have requestBodyGET /v1/orders + JSON bodyGET /v1/orders?status=paidRFC 9110 §9.3.1
ADP-006DELETE returns 204/202, no required bodyDELETE + required bodyDELETE /v1/orders/{id} (204)RFC 9110 §9.3.5
ADP-007POST creation returns 201 + LocationPOST /v1/orders (200)201 Created + LocationRFC 9110 §15.3.2
ADP-020PATCH for partial updates + ETag/If-MatchUnconditional PUTPATCH (application/merge-patch+json)RFC 7396 / RFC 9110

Validate endpoints in CI

Run python3 api_validator.py --spec openapi.json or test a spec in the Interactive OpenAPI Validator.