Skip to content

Unable to display endpoints through an OpenAPI specification file #81

Closed
@jaslam94

Description

@jaslam94

Trying to validate an OpenAPI 3.0 file which is generated by nswag, but getting the following error when running mint openapi-check specification.json:

(node:20856) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
(Use `node --trace-deprecation ...` to show where the warning was created)
Error: Failed to validate OpenAPI schema:/components/securitySchemes/Bearer: must have required property 'openIdConnectUrl'

The file is valid, but it is not getting rendered when I click the API Docs tab.

Here's the docs.json file specifying the openapi source (it's inside the docs folder, same as docs.json):

{
  "$schema": "https://mintlify.com/docs.json",
  "theme": "mint",
  "name": "Mint Starter Kit",
  "colors": {
    "primary": "#16A34A",
    "light": "#07C983",
    "dark": "#15803D"
  },
  "favicon": "/favicon.svg",
  "navigation": {
    "tabs": [
      {
        "tab": "API Docs",
        "groups": [
          {
            "group": "Endpoints",
            "pages": [
              {
                "openapi": "./specification.json"
              }
            ]
          }
        ]
      },
      {
        "tab": "API Reference",
        "groups": [
          {
            "group": "API Documentation",
            "pages": ["api-reference/introduction"]
          },
          {
            "group": "Endpoint Examples",
            "pages": [
              "api-reference/endpoint/get",
              "api-reference/endpoint/create",
              "api-reference/endpoint/delete",
              "api-reference/endpoint/webhook"
            ]
          }
        ]
      }
    ]
  }
}

What am I missing?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions