OpenAPI spec's `ClientErrorResponse` etc are incorrect for most API routes

Created on 14 August 2025, about 15 hours ago

Overview

Discovered in 📌 Move `PropSourceEndpointTest` into new `XbConfigEntityHttpApiTest::testComponent()` Active .

Proposed resolution

User interface changes

🐛 Bug report
Status

Active

Version

1.0

Component

Internal HTTP API

Created by

🇧🇪Belgium wim leers Ghent 🇧🇪🇪🇺

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @wim leers
  • 🇧🇪Belgium wim leers Ghent 🇧🇪🇪🇺

    Starting point for making this more strict and hence actually useful for development:

    diff --git a/openapi.yml b/openapi.yml
    index a9b71ddfb..71b3a0321 100644
    --- a/openapi.yml
    +++ b/openapi.yml
    @@ -2027,6 +2027,7 @@ components:
           required:
             - detail
             - source
    +      additionalProperties: false
           properties:
             detail:
               type: string
    @@ -2205,14 +2206,14 @@ components:
                 type: object
                 required:
                   - errors
    +            additionalProperties: false
                 properties:
                   errors:
                     type: array
                     description: Error items
    +                minItems: 1
                     items:
    -                  type: object
    -                  schema:
    -                    $ref: '#/components/schemas/Error'
    +                  $ref: '#/components/schemas/Error'
         AuthenticationErrorResponse:
           description: Access denied response.
           content:
    
Production build 0.71.5 2024