From fb9e2193570a5cbfd0255f9eee844fe9cc45cb5e Mon Sep 17 00:00:00 2001 From: Lovisa Berggren Date: Mon, 17 Aug 2026 14:57:16 +0200 Subject: [PATCH] fix(ipa0114): Adjust formatting for sub-guidelines --- ipa/general/0114.mdx | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/ipa/general/0114.mdx b/ipa/general/0114.mdx index 7862c45..b3f17b9 100644 --- a/ipa/general/0114.mdx +++ b/ipa/general/0114.mdx @@ -174,8 +174,12 @@ paths: + + ### Authentication and Authorization + + APIs **must** document `401 Unauthorized` and `403 Forbidden` status codes for @@ -305,8 +309,12 @@ have permission to access the resource. + + ### Not Found + + APIs **must** document the `404 Not Found` status code when the resource @@ -390,6 +398,8 @@ invalid or non-existent ID + + :::tip For path parameters consider applying regex-based routing to ensure invalid IDs @@ -410,6 +420,8 @@ Validation errors typically occur when: - Values fall outside acceptable ranges - Business rules are violated + + APIs **must** return a `400 Bad Request` status code when validation fails @@ -561,8 +573,12 @@ request and include all validation errors in the field `badRequestDetail` + + ### Rate Limiting + + APIs **must** document the `429 Too Many Requests` status code for endpoints @@ -760,7 +776,7 @@ RateLimit-Remaining: 73 } ``` -Example +Example: ```json { @@ -788,7 +804,7 @@ Example } ``` -:::tip +:::info New fields `badRequestDetail` and `help` are inspired by [googleapis/google/rpc/error_details.proto](https://github.com/googleapis/googleapis/blob/master/google/rpc/error_details.proto)