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

Display scopes needed for endpoints per spec #5474

Open
jacobcovington opened this issue Dec 23, 2024 · 0 comments
Open

Display scopes needed for endpoints per spec #5474

jacobcovington opened this issue Dec 23, 2024 · 0 comments
Labels
feature Requests for new features. product/docs Fern Docs which builds and hosts a developer documentation site

Comments

@jacobcovington
Copy link

jacobcovington commented Dec 23, 2024

Feature Description

In the generated API docs, show which scopes are needed for an endpoint, per the provided openapi spec.

Use Case

We have specific scopes needed for some of our endpoints, and we've specified them in our openapi schema, as described here: https://swagger.io/docs/specification/v3_0/authentication/#scopes

It would be fantastic if the docs generated with Fern picked up and displayed the scope(s) needed for specific endpoint.

Here's an example of where it's specified in our schema:

  /v2/transaction_screening:
    get:
      summary: Check if a transaction screening exists
      operationId: checkTransactionScreening
      tags:
        - Screening
      security:
        - BearerAuth: [ "transaction_screening:read" ]
@jacobcovington jacobcovington added feature Requests for new features. product/docs Fern Docs which builds and hosts a developer documentation site labels Dec 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Requests for new features. product/docs Fern Docs which builds and hosts a developer documentation site
Development

No branches or pull requests

1 participant