Auth0 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OpenFGA Stores API

5 actions 5 updates phrasing extends openapi/auth0-stores-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 5

$.info

$.paths['/stores'].get

$.paths['/stores'].post

$.paths['/stores/{store_id}'].get

$.paths['/stores/{store_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 OpenFGA Stores API
  version: 1.0.0
extends: openapi/auth0-stores-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: 4
- target: $.paths['/stores'].get
  update:
    x-apievangelist-phrasing:
      intent: List authorization stores
      effect: read
      questions:
      - Which FGA stores exist in my account?
      - Can I filter stores by name?
      instructions:
      - text: List my authorization stores.
      - text: Find stores named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stores'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an authorization store
      effect: write
      questions:
      - How do I create a new FGA store for authorization models and tuples?
      - What do I need to name a new store?
      instructions:
      - text: Create a store named {name}.
        slots:
          name: requestBody.name
      - text: Set up a new FGA store called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stores/{store_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an authorization store
      effect: read
      questions:
      - Can I look up one FGA store by its ID?
      - When was a given store created?
      instructions:
      - text: Show store {store_id}.
        slots:
          store_id: path.store_id
      - text: Get details of FGA store {store_id}.
        slots:
          store_id: path.store_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stores/{store_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an authorization store
      effect: destructive
      questions:
      - Does deleting an FGA store also delete its tuples and models?
      - How do I delete a store?
      instructions:
      - text: Delete store {store_id}.
        slots:
          store_id: path.store_id
      - text: Remove FGA store {store_id}.
        slots:
          store_id: path.store_id
      method: generated
      generated: '2026-10-01'