Authentik · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for authentik Reports API

4 actions 4 updates phrasing extends openapi/authentik-reports-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 4

$.info

$.paths['/reports/exports/'].get

$.paths['/reports/exports/{id}/'].get

$.paths['/reports/exports/{id}/'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for authentik Reports API
  version: 1.0.0
extends: openapi/authentik-reports-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: 3
- target: $.paths['/reports/exports/'].get
  update:
    x-apievangelist-phrasing:
      intent: List data exports
      effect: read
      questions:
      - Which report exports have been generated in authentik?
      - Can I search my data exports and page through them?
      instructions:
      - text: List all data exports.
      - text: Search data exports for {search}.
        slots:
          search: query.search
      - text: Show data exports sorted by {ordering}, {page_size} per page.
        slots:
          ordering: query.ordering
          page_size: query.page_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reports/exports/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one data export
      effect: read
      questions:
      - What are the details of a single report export I already generated?
      - How do I look up one export by its ID?
      instructions:
      - text: Show data export {id}.
        slots:
          id: path.id
      - text: Get the details of report export {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reports/exports/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a data export
      effect: destructive
      questions:
      - How do I remove an old report export I no longer need?
      - Can I delete a generated data export by its ID?
      instructions:
      - text: Delete data export {id}.
        slots:
          id: path.id
      - text: Remove the generated report export {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'