Authentik · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for authentik Schema API

2 actions 2 updates phrasing extends openapi/authentik-schema-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Authentik's API. It is a proposal applied on top of the contract, not a document Authentik publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/schema/'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for authentik Schema API
  version: 1.0.0
extends: openapi/authentik-schema-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/schema/'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the OpenAPI schema for the API
      effect: read
      questions:
      - Where can I download the OpenAPI 3 definition for my authentik instance's API?
      - Can I get the API schema as JSON instead of YAML?
      - Is it possible to fetch the API schema in a specific language?
      instructions:
      - text: Download the OpenAPI schema for this API.
      - text: Fetch the OpenAPI schema in {format} format.
        slots:
          format: query.format
      - text: Get the API schema in {format} with descriptions in language {lang}.
        slots:
          format: query.format
          lang: query.lang
      method: generated
      generated: '2026-09-26'