OpenAPI 3.1 Support

[revnode]

It looks like OpenAPI 3.1 support was added a few years back? I'm having trouble with it.

When executing:

const definition = `{
  "openapi": "3.1.0",
  "info": {
    "version": "1.0.0",
    "title": "test",
    "description": "test",
    "contact": {
      "email": "[email protected]"
    },
    "license": {
      "name": "UNLICENSED",
      "url": "https://test.com/terms-conditions/"
    }
  },
  "servers": [
    {
      "url": "/api/v1"
    }
  ],
  "paths": {
    "/ping": {
      "get": {
        "operationId": "ping.get",
        "summary": "Checks if the API is operational.",
        "description": "Verifies the API is deployed and functioning properly.",
        "tags": [
          "Utilities"
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "description": "The response to a ping should be pong.",
                      "type": "string",
                      "example": "pong"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "key": {
        "type": "apiKey",
        "in": "header",
        "name": "key",
        "description": "test"
      },
      "session": {
        "type": "apiKey",
        "in": "header",
        "name": "session",
        "description": "test"
      }
    },
    "schemas": {
      "test": {
        "type": "object",
        "properties": {
          "test": {
            "description": "This is a test.",
            "type": [
              "string",
              "null"
            ]
          }
        }
      }
    }
  }
}`;
const api = new OpenAPIBackend({
  definition,
  apiRoot: "/api/v1"
});

I get errors like:

{
  "instancePath": "/components/schemas/test/properties/test/type",
  "schemaPath": "#/properties/type/type",
  "keyword": "type",
  "params": {
    "type": "string"
  },
  "message": "must be string"
}

If I set the type to a string, the error goes away. But it should support an array? Any help appreciated. Thanks!

[revnode]

It looks like the culprit might be https://www.npmjs.com/package/openapi-schema-validator which is used internally? It doesn't look like openapi-schema-validator supports 3.1

[revnode]

Seems there is a ticket for it: kogosoftwarellc/open-api#837

For those running into the same issue, a quick hack is to set quick to true as an option to OpenAPIBackend to suppress the errors.

[danbars]

The docs say that 3.1 is supported... So it's not really the case?

[kennethaasan]

#212 #158 says otherwise. Not sure why this issue is not closed?