AuthSchemeCard

Domain · API Doc

Selectable card describing a single auth scheme (apiKey, http, oauth2, openIdConnect, mutualTLS).

OAuth 2.0 recommended scheme

Code
<%- include('modules/domain/api-doc/AuthSchemeCard', {
  name: 'OAuth 2.0',
  type: 'oauth2',
  recommended: true,
  description: 'Authorization Code flow with PKCE — preferred for user-facing apps.',
  metaItems: [
    { label: 'Client ID', value: 'prod_client_42' },
    { label: 'Scopes',    value: 'read write' },
  ],
  href: '/auth/oauth2'
}) %>

API Key static scheme

Preview

X-API-Key

apiKey

Static header-based key for server-to-server integrations.

Code
<%- include('modules/domain/api-doc/AuthSchemeCard', {
  name: 'X-API-Key',
  type: 'apiKey',
  description: 'Static header-based key for server-to-server integrations.'
}) %>
Source modules/domain/api-doc/AuthSchemeCard.ejs
<% } %>