# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for OpenFGA Auth Zen Service API
  version: 1.0.0
extends: openapi/auth0-authzenservice-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: 6
- target: $.paths['/.well-known/authzen-configuration/{store_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a store's AuthZEN PDP configuration
      effect: read
      questions:
      - Which AuthZEN endpoints and capabilities does my store's policy decision point support?
      - Can I discover the AuthZEN metadata for an authorization store?
      instructions:
      - text: Show the AuthZEN configuration for store {store_id}.
        slots:
          store_id: path.store_id
      - text: Get PDP capabilities of store {store_id}.
        slots:
          store_id: path.store_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stores/{store_id}/access/v1/evaluation'].post
  update:
    x-apievangelist-phrasing:
      intent: Decide if a subject may act on a resource
      effect: read
      questions:
      - Can I ask the AuthZEN endpoint whether one user may perform an action on a resource?
      - What does a single AuthZEN access evaluation return?
      instructions:
      - text: Check in store {store_id} if {subject} can perform {action} on {resource}.
        slots:
          store_id: path.store_id
          subject: requestBody.subject
          action: requestBody.action
          resource: requestBody.resource
      - text: Evaluate whether subject {subject} is allowed {action} on {resource} in store {store_id}.
        slots:
          subject: requestBody.subject
          action: requestBody.action
          resource: requestBody.resource
          store_id: path.store_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stores/{store_id}/access/v1/evaluations'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a batch of AuthZEN access evaluations
      effect: read
      questions:
      - Can I check many subject-action-resource combinations in one AuthZEN request?
      - Is there a way to set default subject or action for a batch of evaluations?
      instructions:
      - text: Run the AuthZEN evaluations {evaluations} in store {store_id}.
        slots:
          evaluations: requestBody.evaluations
          store_id: path.store_id
      - text: Batch-check {evaluations} for subject {subject} in store {store_id}.
        slots:
          evaluations: requestBody.evaluations
          subject: requestBody.subject
          store_id: path.store_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stores/{store_id}/access/v1/search/action'].post
  update:
    x-apievangelist-phrasing:
      intent: Find actions a subject can take on a resource
      effect: read
      questions:
      - What can a given user do with this document?
      - Can I list every action a subject is allowed on one resource?
      instructions:
      - text: List actions {subject} can perform on {resource} in store {store_id}.
        slots:
          subject: requestBody.subject
          resource: requestBody.resource
          store_id: path.store_id
      - text: Search store {store_id} for what {subject} may do to {resource}.
        slots:
          store_id: path.store_id
          subject: requestBody.subject
          resource: requestBody.resource
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stores/{store_id}/access/v1/search/resource'].post
  update:
    x-apievangelist-phrasing:
      intent: Find resources a subject can access
      effect: read
      questions:
      - Which documents can a user read?
      - Can I search for all resources of a type that someone has a given action on?
      instructions:
      - text: Find resources like {resource} that {subject} can {action} in store {store_id}.
        slots:
          resource: requestBody.resource
          subject: requestBody.subject
          action: requestBody.action
          store_id: path.store_id
      - text: Search store {store_id} for {resource} items where {subject} holds {action}.
        slots:
          store_id: path.store_id
          resource: requestBody.resource
          subject: requestBody.subject
          action: requestBody.action
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stores/{store_id}/access/v1/search/subject'].post
  update:
    x-apievangelist-phrasing:
      intent: Find subjects with access to a resource
      effect: read
      questions:
      - Who can read this document?
      - Can I list all users who hold a given action on a resource through AuthZEN?
      instructions:
      - text: Find subjects of type {subject} who can {action} {resource} in store {store_id}.
        slots:
          subject: requestBody.subject
          action: requestBody.action
          resource: requestBody.resource
          store_id: path.store_id
      - text: Search store {store_id} for who has {action} on {resource}, matching {subject}.
        slots:
          store_id: path.store_id
          action: requestBody.action
          resource: requestBody.resource
          subject: requestBody.subject
      method: generated
      generated: '2026-10-01'