The default error response field value in openapi docs is "DEFAULT" about huma HOT 2 CLOSED

@minpeter I understand your concern and agree that documentation generators should show the default as an error when a 2xx code is already present. According to the spec:

default - The documentation of responses other than the ones declared for specific HTTP response codes. Use this field to cover undeclared responses.

And their example:

'200':
  description: a pet to be returned
  content:
    application/json:
      schema:
        $ref: '#/components/schemas/Pet'
default:
  description: Unexpected error
  content:
    application/json:
      schema:
        $ref: '#/components/schemas/ErrorModel'

https://spec.openapis.org/oas/v3.1.0#responses-object

I think most code generators and other OpenAPI tools know that default is treated special due to the spec explicitly calling it out. Huma is doing what is recommended by the spec here, so maybe the documentation generators should be updated to handle this case better? Like I'm struggling to understand what specific change should be made in Huma that will still be broadly compatible with the whole OpenAPI ecosystem of tools.

from huma.

Thank you for your quick reply.
After referring to the document above, I think that huma is creating the document in an excellent way.

from huma.