fix(partner-api): enforce organization-output contract filtering (#80)

Enforce the `organization-output` API contract by filtering Confederatio
responses to only include documented fields.

Organization endpoints were returning undocumented fields (`name`,
`country`) that leaked from Confederatio's internal response.

Added response filtering pipeline to ensure only documented fields are
returned:

- `id` (UUID)
- `status` (active, suspended, terminated)
- `billing-address` (structured ISO 20022 address)
- `client-id`

Author: diogomdo

.github/workflows/openapi.yaml

@@ -25,7 +25,7 @@ jobs:
         run: |-
           git config user.name "Automated"
           git config user.email "actions@users.noreply.github.com"
-          git add exoscale/openapi.json
+          git add exoscale/openapi.json exoscale/partner-api.json
           timestamp=$(date -u)
           git commit -m "OpenAPI spec update: ${timestamp}" || exit 0
           git push

docs/changes.rst

@@ -1,6 +1,18 @@
 Changelog
 ---------
 
+0.16.1 (unreleased)
+-------------------
+
+Fixes
+*****
+
+* Partner API: Ensure organization responses match ``organization-output`` contract.
+  Responses now only include documented fields (``id``, ``status``, ``billing-address``,
+  ``client-id``). Access organization name via ``billing-address.name``.
+
+* GitHub Actions: Add automatic sync of Partner API OpenAPI spec (``partner-api.json``).
+
 0.16.0 (2025-11-27)
 -------------------
 

exoscale/partner-api.json

@@ -213,13 +213,6 @@
                         "maxLength": 191,
                         "type": "string"
                     },
-                    "country": {
-                        "description": "Organization Country. Format: ISO 3166-1 alpha-2",
-                        "maxLength": 2,
-                        "minLength": 2,
-                        "readOnly": true,
-                        "type": "string"
-                    },
                     "id": {
                         "description": "Organization ID",
                         "format": "uuid",
@@ -702,4 +695,4 @@
             "title": "API Request Signature"
         }
     ]
-}
+}

tests/test_partner_client.py

@@ -90,7 +90,6 @@ def test_create_organization_with_structured_address(requests_mock):
 
     expected_response = {
         "id": "a1b2c3d4-e5f6-4a5b-8c9d-0e1f2a3b4c5d",
-        "name": "test-org-001",
         "status": "active",
         "billing-address": {
             "name": "ACME Corporation",
@@ -100,7 +99,6 @@ def test_create_organization_with_structured_address(requests_mock):
             "postal-code": "1217",
             "country": "CH",
         },
-        "country": "CH",
     }
 
     requests_mock.post(
@@ -132,7 +130,6 @@ def test_create_organization_with_optional_fields(requests_mock):
 
     expected_response = {
         "id": "a1b2c3d4-e5f6-4a5b-8c9d-0e1f2a3b4c5d",
-        "name": "test-org-002",
         "status": "active",
         "billing-address": {
             "name": "Test GmbH",
@@ -144,7 +141,6 @@ def test_create_organization_with_optional_fields(requests_mock):
             "address": "Additional address information",
         },
         "client-id": "custom-client-123",
-        "country": "DE",
     }
 
     requests_mock.post(
@@ -181,7 +177,6 @@ def test_create_organization_minimal_billing_address(requests_mock):
 
     expected_response = {
         "id": "a1b2c3d4-e5f6-4a5b-8c9d-0e1f2a3b4c5d",
-        "name": "test-org-003",
         "status": "active",
         "billing-address": {
             "name": "Société Française",
@@ -190,7 +185,6 @@ def test_create_organization_minimal_billing_address(requests_mock):
             "postal-code": "75001",
             "country": "FR",
         },
-        "country": "FR",
     }
 
     requests_mock.post(
@@ -224,7 +218,6 @@ def test_list_organizations(requests_mock):
         "organizations": [
             {
                 "id": "org-1",
-                "name": "org-001",
                 "status": "active",
                 "billing-address": {
                     "name": "Org 1",
@@ -233,11 +226,9 @@ def test_list_organizations(requests_mock):
                     "postal-code": "1000",
                     "country": "CH",
                 },
-                "country": "CH",
             },
             {
                 "id": "org-2",
-                "name": "org-002",
                 "status": "suspended",
                 "billing-address": {
                     "name": "Org 2",
@@ -246,7 +237,6 @@ def test_list_organizations(requests_mock):
                     "postal-code": "2000",
                     "country": "DE",
                 },
-                "country": "DE",
             },
         ]
     }