Auth0 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OpenFGA Authorization Models API

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

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/stores/{store_id}/authorization-models'].get
$.paths['/stores/{store_id}/authorization-models'].post
$.paths['/stores/{store_id}/authorization-models/{id}'].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 OpenFGA Authorization Models API
  version: 1.0.0
extends: openapi/auth0-authorization-models-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/stores/{store_id}/authorization-models'].get
  update:
    x-apievangelist-phrasing:
      intent: List a store's authorization models
      effect: read
      questions:
      - What versions of the authorization model exist for my FGA store?
      - Are authorization models returned newest first?
      instructions:
      - text: List the authorization models in store {store_id}.
        slots:
          store_id: path.store_id
      - text: Show {page_size} authorization models from store {store_id}.
        slots:
          page_size: query.page_size
          store_id: path.store_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stores/{store_id}/authorization-models'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new authorization model version
      effect: write
      questions:
      - How do I publish a new authorization model with my type definitions?
      - Can an authorization model include conditions?
      instructions:
      - text: Write a new authorization model to store {store_id} with type definitions {type_definitions} and schema version {schema_version}.
        slots:
          store_id: path.store_id
          type_definitions: requestBody.type_definitions
          schema_version: requestBody.schema_version
      - text: 'Add a model to store {store_id}: schema {schema_version}, types {type_definitions}, conditions {conditions}.'
        slots:
          store_id: path.store_id
          schema_version: requestBody.schema_version
          type_definitions: requestBody.type_definitions
          conditions: requestBody.conditions
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stores/{store_id}/authorization-models/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one authorization model version
      effect: read
      questions:
      - What type definitions are in a specific version of my authorization model?
      - Can I fetch an older authorization model by its ID?
      instructions:
      - text: Get authorization model {id} from store {store_id}.
        slots:
          id: path.id
          store_id: path.store_id
      - text: Show the type definitions of model version {id} in store {store_id}.
        slots:
          id: path.id
          store_id: path.store_id
      method: generated
      generated: '2026-10-01'