chore: update OpenAPI spec to 3.1

[joscha]

September 25th, 2024
Upgrade schema to Openapi 3.1

via https://developer.affinity.co/#section/Changelog

Potential issues

Nullability

Nullability seems not to generate correctly (most definitely an issue).

Fix is here: OpenAPITools/openapi-generator#19687

This is generated from:

      "LocationsValue": {
        "title": "LocationsValue",
        "properties": {
          "type": {
            "description": "The type of value",
            "const": "location-multi",
            "type": "string"
          },
          "data": {
            "description": "The values for many locations",
            "items": {
              "$ref": "#/components/schemas/Location"
            },
            "type": [
              "array",
              "null"
            ]
          }
        },
        "required": [
          "data",
          "type"
        ],
        "type": "object"
      },

i.e.:

            "type": [
              "array",
              "null"
            ]

before (OpenAPI spec 3.0.1) this was:

            "type": "array",
            "nullable": true

Enum values

Enum values seem not to generate correctly as enums (possibly an issue)

          "type": {
            "description": "The type of value",
            "const": "location-multi",
            "type": "string"
          },

note the const instead of

          "type": {
            "description": "The type of value",
            "enum": [
              "location-multi"
            ],
            "type": "string"
          },

opened PR here: OpenAPITools/openapi-generator#19696

Error models

All previously generated error models seem to have gone (possibly not an issue?) Asked support about it.

• ConflictError
• EmptyMessageBodyError
• GenericError
• InvalidAcceptHeaderError
• InvalidMessageBodyError
• InvalidVersionHeaderError
• MethodNotAllowedError
• ModelError
• RateLimitError
• ServerError
• TooManyMultipartFilesError

Update: most of these have been re-added: