From d03b0998c9c4e0769141f1abec46ad75ec420766 Mon Sep 17 00:00:00 2001 From: Sweets Sweetman Date: Fri, 3 Jul 2026 14:05:28 -0500 Subject: [PATCH] docs(organizations): error envelope for member/domain endpoints is {status, error} MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The api converged these endpoints' error paths on the shared errorResponse helper (recoupable/api#749), which emits {status:"error", error} — the same shape validateAuthContext's 401s always had. New ErrorEnvelope schema; the 16 error responses across the five member/domain operations now reference it. The pre-existing artists endpoint keeps OrganizationsErrorResponse ({status, message}), which is what it actually emits. Co-Authored-By: Claude Fable 5 --- api-reference/openapi/accounts.json | 52 ++++++++++++++++++++--------- 1 file changed, 36 insertions(+), 16 deletions(-) diff --git a/api-reference/openapi/accounts.json b/api-reference/openapi/accounts.json index eca5be1..8b7858d 100644 --- a/api-reference/openapi/accounts.json +++ b/api-reference/openapi/accounts.json @@ -416,7 +416,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrganizationsErrorResponse" + "$ref": "#/components/schemas/ErrorEnvelope" } } } @@ -426,7 +426,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrganizationsErrorResponse" + "$ref": "#/components/schemas/ErrorEnvelope" } } } @@ -436,7 +436,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrganizationsErrorResponse" + "$ref": "#/components/schemas/ErrorEnvelope" } } } @@ -491,7 +491,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrganizationsErrorResponse" + "$ref": "#/components/schemas/ErrorEnvelope" } } } @@ -501,7 +501,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrganizationsErrorResponse" + "$ref": "#/components/schemas/ErrorEnvelope" } } } @@ -511,7 +511,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrganizationsErrorResponse" + "$ref": "#/components/schemas/ErrorEnvelope" } } } @@ -558,7 +558,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrganizationsErrorResponse" + "$ref": "#/components/schemas/ErrorEnvelope" } } } @@ -568,7 +568,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrganizationsErrorResponse" + "$ref": "#/components/schemas/ErrorEnvelope" } } } @@ -578,7 +578,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrganizationsErrorResponse" + "$ref": "#/components/schemas/ErrorEnvelope" } } } @@ -622,7 +622,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrganizationsErrorResponse" + "$ref": "#/components/schemas/ErrorEnvelope" } } } @@ -632,7 +632,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrganizationsErrorResponse" + "$ref": "#/components/schemas/ErrorEnvelope" } } } @@ -642,7 +642,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrganizationsErrorResponse" + "$ref": "#/components/schemas/ErrorEnvelope" } } } @@ -652,7 +652,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrganizationsErrorResponse" + "$ref": "#/components/schemas/ErrorEnvelope" } } } @@ -706,7 +706,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrganizationsErrorResponse" + "$ref": "#/components/schemas/ErrorEnvelope" } } } @@ -716,7 +716,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrganizationsErrorResponse" + "$ref": "#/components/schemas/ErrorEnvelope" } } } @@ -726,7 +726,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrganizationsErrorResponse" + "$ref": "#/components/schemas/ErrorEnvelope" } } } @@ -3700,6 +3700,26 @@ } } }, + "ErrorEnvelope": { + "type": "object", + "required": [ + "status", + "error" + ], + "properties": { + "status": { + "type": "string", + "enum": [ + "error" + ], + "description": "Status of the request" + }, + "error": { + "type": "string", + "description": "Error message describing what went wrong" + } + } + }, "Pulse": { "type": "object", "properties": {