# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Auth0 Management Resource Servers API
  version: 1.0.0
extends: openapi/auth0-resource-servers-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: 5
- target: $.paths['/resource-servers'].get
  update:
    x-apievangelist-phrasing:
      intent: List APIs registered in the tenant
      effect: read
      questions:
      - Which APIs (resource servers) are registered in my Auth0 tenant?
      - Can I look up resource servers by their audience identifiers?
      instructions:
      - text: List all resource servers in my tenant.
      - text: Find the resource servers with identifiers {identifiers}.
        slots:
          identifiers: query.identifiers
      method: generated
      generated: '2026-10-01'
- target: $.paths['/resource-servers'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a new API (resource server)
      effect: write
      questions:
      - How do I register my backend API so it can receive access tokens?
      - Can I define scopes and token lifetime when creating a resource server?
      instructions:
      - text: Create a resource server with audience identifier {identifier}.
        slots:
          identifier: requestBody.identifier
      - text: Register API {name} at identifier {identifier} with scopes {scopes}.
        slots:
          name: requestBody.name
          identifier: requestBody.identifier
          scopes: requestBody.scopes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/resource-servers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an API's settings
      effect: read
      questions:
      - What signing algorithm and token lifetime does one of my APIs use?
      - Can I fetch a single resource server's configuration by ID?
      instructions:
      - text: Get resource server {id}.
        slots:
          id: path.id
      - text: Show the scopes and token settings of API {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/resource-servers/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an API (resource server)
      effect: destructive
      questions:
      - Can I delete an API I registered by mistake?
      - What's the way to remove a resource server from my tenant?
      instructions:
      - text: Delete resource server {id}.
        slots:
          id: path.id
      - text: Remove the API {id} from my tenant.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/resource-servers/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an API's settings
      effect: write
      questions:
      - How do I add new scopes to an existing API?
      - Can I allow offline access (refresh tokens) for an API after creating it?
      instructions:
      - text: Set the scopes of resource server {id} to {scopes}.
        slots:
          id: path.id
          scopes: requestBody.scopes
      - text: Change the token lifetime of API {id} to {token_lifetime} seconds.
        slots:
          id: path.id
          token_lifetime: requestBody.token_lifetime
      - text: Set allow offline access on API {id} to {allow_offline_access}.
        slots:
          id: path.id
          allow_offline_access: requestBody.allow_offline_access
      method: generated
      generated: '2026-10-01'