HiDeoo / starlight-openapi

Starlight plugin to generate documentation from OpenAPI/Swagger specifications
https://starlight-openapi.vercel.app
MIT License
107 stars 13 forks source link

Broken link for SecurityScheme #20

Closed azan-n closed 6 months ago

azan-n commented 6 months ago

Describe the bug

The link to the JWT security scheme is broken and leads nowhere.

image

To Reproduce

The schema used in the above image defines a SecurityScheme as

"securitySchemes": {
      "JWT": {
        "type": "http",
        "description": "Utilize the Bearer token scheme with your access token included in the Authorization HTTP header.\n```Authorization: Bearer YOUR_ACCESS_TOKEN```",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
}

and the security field on the operation is defined as

"security": [
          {
            "JWT": [
              "webhook:write"
            ]
          }
        ]

Expected behavior

Ideally, a link to a page with the SecurityScheme definition would help here. If it makes things simpler, we can repeat all the information on all pages.

Happy to create a PR.

How often does this bug happen?

Every time

System Info

No response

Additional Context

No response

HiDeoo commented 6 months ago

Thanks for your report :raised_hands:

The issue should now be fixed in v0.6.0.