# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Authorization API v1.1 Grants API
  version: 1.0.0
extends: openapi/here-grants-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/grants/resources/{resourceHrn}/entities'].get
  update:
    x-apievangelist-phrasing:
      intent: List who has access to a resource
      effect: read
      questions:
      - Which users, apps or groups have permissions on this resource?
      - Can I include grants from other realms?
      instructions:
      - text: List all grants on resource {resource_hrn}.
        slots:
          resource_hrn: path.resourceHrn
      - text: Show {entity_type} grants on {resource_hrn}.
        slots:
          entity_type: query.entityType
          resource_hrn: path.resourceHrn
      - text: List grants on {resource_hrn} including cross-realm grants {cross_realm}.
        slots:
          resource_hrn: path.resourceHrn
          cross_realm: query.includeCrossRealmGrants
      method: generated
      generated: '2026-09-26'
- target: $.paths['/grants/resources/{resourceHrn}/entities/{entityId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an entity's permissions on a resource
      effect: read
      questions:
      - What permissions does a specific user have on a resource?
      - Does an app have any access to a given catalog?
      instructions:
      - text: Show the grants {entity_type} {entity_id} has on resource {resource_hrn}.
        slots:
          entity_type: query.entityType
          entity_id: path.entityId
          resource_hrn: path.resourceHrn
      - text: List what {entity_id} of type {entity_type} can do on {resource_hrn}.
        slots:
          entity_id: path.entityId
          entity_type: query.entityType
          resource_hrn: path.resourceHrn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/grants/resources/{resourceHrn}/entities/{entityId}/actions/{actionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check one action grant for an entity
      effect: read
      questions:
      - Is a user allowed to take a particular action on a resource?
      - How do I verify a single permission for a group?
      instructions:
      - text: Check whether {entity_type} {entity_id} can {action_id} on {resource_hrn}.
        slots:
          entity_type: query.entityType
          entity_id: path.entityId
          action_id: path.actionId
          resource_hrn: path.resourceHrn
      - text: Get the {action_id} grant for {entity_id} ({entity_type}) on resource {resource_hrn}.
        slots:
          action_id: path.actionId
          entity_id: path.entityId
          entity_type: query.entityType
          resource_hrn: path.resourceHrn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/grants/resources/{resourceHrn}/entities/{entityId}/actions/{actionId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant an entity permission on a resource
      effect: write
      questions:
      - How do I give a user permission to read a catalog?
      - Can I grant a group a specific action on a resource?
      instructions:
      - text: Grant {entity_type} {entity_id} the {action_id} action on {resource_hrn}.
        slots:
          entity_type: query.entityType
          entity_id: path.entityId
          action_id: path.actionId
          resource_hrn: path.resourceHrn
      - text: Allow {entity_id} ({entity_type}) to {action_id} resource {resource_hrn}.
        slots:
          entity_id: path.entityId
          entity_type: query.entityType
          action_id: path.actionId
          resource_hrn: path.resourceHrn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/grants/resources/{resourceHrn}/entities/{entityId}/actions/{actionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke an entity's permission on a resource
      effect: destructive
      questions:
      - Can I take away one action a user has on a resource?
      - Does revoking a grant remove permissions inherited from groups?
      instructions:
      - text: Revoke the {action_id} grant from {entity_type} {entity_id} on {resource_hrn}.
        slots:
          action_id: path.actionId
          entity_type: query.entityType
          entity_id: path.entityId
          resource_hrn: path.resourceHrn
      - text: Stop {entity_id} ({entity_type}) from being able to {action_id} {resource_hrn}.
        slots:
          entity_id: path.entityId
          entity_type: query.entityType
          action_id: path.actionId
          resource_hrn: path.resourceHrn
      method: generated
      generated: '2026-09-26'