OpenAPI Generator creates invalid Java enum with no constants from enum: [null] specification

[zhangwei217245]

This is the line that needs to be fixed:

authenticator/service/resources/openapi_v3.yml

Line 263 in 1d8f384

enum: [null]

Presumably, we should follow the standard here, to ensure consistency throughout this whole spec.

authenticator/service/resources/openapi_v3.yml

Line 465 in 1d8f384

enum: [success, failure]

[zhangwei217245]

a string result whose only allowed value is null is valid but pointless. It communicates “this field exists but must be null,” which adds no information and can confuse code generators.

Given we already have status in BasicResponse, here are clean patterns we can use instead.

Recommended patterns

1. Best practice for DELETE-like actions: 204 No Content
   No body, no result, simplest for clients.

responses:
  '204':
    description: Client deactivated.
  '404':
    description: Not found.

2. If we want a body confirming the outcome (keep the envelope)
   Make result meaningful and non-null.
   a) Enum outcome (simple and explicit)

'200':
  description: OK
  content:
    application/json:
      schema:
        allOf:
          - $ref: '#/components/schemas/BasicResponse'
          - type: object
            required: [result]
            properties:
              result:
                type: string
                enum: [deleted]   # optionally: [deleted, already_inactive]

b) Structured result (room to grow)

'200':
  description: OK
  content:
    application/json:
      schema:
        allOf:
          - $ref: '#/components/schemas/BasicResponse'
          - type: object
            required: [result]
            properties:
              result:
                type: object
                required: [outcome]
                properties:
                  outcome:
                    type: string
                    enum: [deleted, not_found, already_inactive]
                  client_id:
                    type: string

(If we use this, return 200 for successful deletions and 404 separately for not-found.)

3. If there’s nothing useful to say but we insist on 200
   Just omit result and rely on status + message:

'200':
  description: OK
  content:
    application/json:
      schema:
        allOf:
          - $ref: '#/components/schemas/BasicResponse'
          - type: object
            # no result here