Auth0 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OpenFGA Assertions API

3 actions 3 updates phrasing extends openapi/auth0-assertions-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 3

$.info
$.paths['/stores/{store_id}/assertions/{authorization_model_id}'].get
$.paths['/stores/{store_id}/assertions/{authorization_model_id}'].put

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 Assertions API
  version: 1.0.0
extends: openapi/auth0-assertions-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: 2
- target: $.paths['/stores/{store_id}/assertions/{authorization_model_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the test assertions for an authorization model
      effect: read
      questions:
      - What test assertions are stored for a fine-grained authorization model?
      - Can I see the expected check results saved against a specific model version?
      instructions:
      - text: Show the assertions for model {authorization_model_id} in store {store_id}.
        slots:
          authorization_model_id: path.authorization_model_id
          store_id: path.store_id
      - text: Read the stored assertions of store {store_id} for authorization model {authorization_model_id}.
        slots:
          store_id: path.store_id
          authorization_model_id: path.authorization_model_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stores/{store_id}/assertions/{authorization_model_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Save test assertions for an authorization model
      effect: write
      questions:
      - How do I record expected allow/deny results to test my authorization model?
      - Does writing assertions overwrite the ones already stored for that model?
      instructions:
      - text: Write assertions {assertions} for model {authorization_model_id} in store {store_id}.
        slots:
          assertions: requestBody.assertions
          authorization_model_id: path.authorization_model_id
          store_id: path.store_id
      - text: Replace the test assertions of store {store_id} model {authorization_model_id} with {assertions}.
        slots:
          store_id: path.store_id
          authorization_model_id: path.authorization_model_id
          assertions: requestBody.assertions
      method: generated
      generated: '2026-10-01'