Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support Multiple Required Headers - OpenAPI Security Scheme #5707

Open
prowave opened this issue Jan 22, 2025 · 0 comments
Open

Support Multiple Required Headers - OpenAPI Security Scheme #5707

prowave opened this issue Jan 22, 2025 · 0 comments
Labels
bug Issues reporting bugs. product/docs Fern Docs which builds and hosts a developer documentation site

Comments

@prowave
Copy link

prowave commented Jan 22, 2025

CLI Version (from fern.config.json)

0.50.13

Minimal API Specification

Not small, but will prove the point:

https://app.brightmove.com/ATS/app/v3/api-docs

Actual UI Behavior

Image

Expected UI Behavior

Like image above but also including the required header X-Brightmove-Company-ApiKey defined in securitySchemes

    "securitySchemes": {
      "X-Brightmove-Company-ApiKey": {
        "type": "apiKey",
        "description": "BrightMove Company Api Key",
        "name": "X-Brightmove-Company-ApiKey",
        "in": "header"
      },
      "X-Brightmove-User-ApiKey": {
        "type": "apiKey",
        "description": "BrightMove User Api Key",
        "name": "X-Brightmove-User-ApiKey",
        "in": "header"
      }
    }

Now from the screenshot is the docs actually indicate that the headers are required in all cases, and in the spec the headers are not required for any of the endpoints since the endpoints can be called other ways.

The securityScheme defined should show in the docs that both headers are required for authentication.

Steps to Reproduce

  1. Generate Docs from the above Api Spec
  2. See that only 1 of the 2 securityScheme headers is marked as required.

Environment Details

Brave: Version 1.74.48 Chromium: 132.0.6834.83 (Official Build) (arm64)
Mac OS 15.2
Node: v23.6.0

@prowave prowave added bug Issues reporting bugs. product/docs Fern Docs which builds and hosts a developer documentation site labels Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Issues reporting bugs. product/docs Fern Docs which builds and hosts a developer documentation site
Development

No branches or pull requests

1 participant