Skip to content

Add new preview type for auth flow examples (API key, OAuth) #13

@akuligowski9

Description

@akuligowski9

Right now previews show sample response data. But a lot of developers also want to see how to authenticate with an API before they commit to using it.

Proposed solution
Add an auth preview type that renders a code snippet showing how to make an authenticated request, tailored to the API's auth method (API key in header, query param, OAuth flow, etc.).

Preview types needed

  • API Key in header: Authorization: Bearer YOUR_KEY
  • API Key as query param: ?api_key=YOUR_KEY
  • OAuth 2.0 flow overview

Acceptance criteria

  • New auth preview type added to the preview registry
  • Syntax highlighted code block
  • Auth method pulled from catalog.json data

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requesthardChallenging implementationhelp wantedExtra attention is needed

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions