API Evangelist conversational phrasing for OpenFGA Relationship Queries API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for OpenFGA Relationship Queries API
  version: 1.0.0
extends: openapi/auth0-relationship-queries-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['/stores/{store_id}/batch-check'].post
  update:
    x-apievangelist-phrasing:
      intent: Check many relationships in one request
      effect: read
      questions:
      - Can I run a whole list of authorization checks in a single FGA call?
      - How does a batch check report results for each relationship?
      instructions:
      - text: Run batch checks {checks} in store {store_id}.
        slots:
          checks: requestBody.checks
          store_id: path.store_id
      - text: Batch-check {checks} against model {authorization_model_id} in store {store_id}.
        slots:
          checks: requestBody.checks
          authorization_model_id: requestBody.authorization_model_id
          store_id: path.store_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stores/{store_id}/check'].post
  update:
    x-apievangelist-phrasing:
      intent: Check if a user has a relation to an object
      effect: read
      questions:
      - Is user anne allowed to view document roadmap according to my FGA store?
      - Can I include contextual tuples when checking one relationship?
      instructions:
      - text: Check tuple {tuple_key} in store {store_id}.
        slots:
          tuple_key: requestBody.tuple_key
          store_id: path.store_id
      - text: Check {tuple_key} in store {store_id} with contextual tuples {contextual_tuples}.
        slots:
          tuple_key: requestBody.tuple_key
          store_id: path.store_id
          contextual_tuples: requestBody.contextual_tuples
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stores/{store_id}/expand'].post
  update:
    x-apievangelist-phrasing:
      intent: Expand a relationship into its userset tree
      effect: read
      questions:
      - How can I debug why someone has a relation by seeing the userset tree?
      - What does the expanded tree of a relationship look like?
      instructions:
      - text: Expand relationship {tuple_key} in store {store_id}.
        slots:
          tuple_key: requestBody.tuple_key
          store_id: path.store_id
      - text: Show the userset tree for {tuple_key} in store {store_id}.
        slots:
          tuple_key: requestBody.tuple_key
          store_id: path.store_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stores/{store_id}/list-objects'].post
  update:
    x-apievangelist-phrasing:
      intent: List objects a user has a relation with
      effect: read
      questions:
      - Which documents can a user edit, returned all at once?
      - Can I list every object of a type a user is related to?
      instructions:
      - text: List {type} objects where {user} is {relation} in store {store_id}.
        slots:
          type: requestBody.type
          user: requestBody.user
          relation: requestBody.relation
          store_id: path.store_id
      - text: Find all {type} that {user} has {relation} on in store {store_id}.
        slots:
          type: requestBody.type
          user: requestBody.user
          relation: requestBody.relation
          store_id: path.store_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stores/{store_id}/list-users'].post
  update:
    x-apievangelist-phrasing:
      intent: List users with a relation to an object
      effect: read
      questions:
      - Which users are viewers of a particular document?
      - Can I filter the users returned by type when listing who relates to an object?
      instructions:
      - text: List users of type {user_filters} with {relation} on {object} in store {store_id}.
        slots:
          user_filters: requestBody.user_filters
          relation: requestBody.relation
          object: requestBody.object
          store_id: path.store_id
      - text: Find who has {relation} on {object} in store {store_id}, filtered by {user_filters}.
        slots:
          relation: requestBody.relation
          object: requestBody.object
          store_id: path.store_id
          user_filters: requestBody.user_filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stores/{store_id}/streamed-list-objects'].post
  update:
    x-apievangelist-phrasing:
      intent: Stream objects a user has a relation with
      effect: read
      questions:
      - Can I stream accessible objects as they are found instead of waiting for the full list?
      - Is there a streaming way to list objects for very large result sets?
      instructions:
      - text: Stream {type} objects where {user} has {relation} in store {store_id}.
        slots:
          type: requestBody.type
          user: requestBody.user
          relation: requestBody.relation
          store_id: path.store_id
      - text: Stream every {type} that {user} can {relation} from store {store_id} as results arrive.
        slots:
          type: requestBody.type
          user: requestBody.user
          relation: requestBody.relation
          store_id: path.store_id
      method: generated
      generated: '2026-10-01'