# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Permission Service Entity API
  version: 1.0.0
extends: openapi/optimizely-entity-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: 4
- target: $.paths['/users/{user_id}/projects/{project_id}/{entity_type}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's permissions on a project entity type
      effect: read
      questions:
      - What permissions does a given user have on a type of entity in a project?
      - Can I page through a user's per-entity permissions within one project?
      instructions:
      - text: Show user {user_id}'s permissions on {entity_type} in project {project_id}.
        slots:
          user_id: path.user_id
          entity_type: path.entity_type
          project_id: path.project_id
      - text: List {per_page} per page of user {user_id}'s {entity_type} permissions in project {project_id}.
        slots:
          per_page: query.per_page
          user_id: path.user_id
          entity_type: path.entity_type
          project_id: path.project_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/teams/{team_id}/projects/{project_id}/{entity_type}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a team's permissions on a project entity type
      effect: read
      questions:
      - Which permissions does a team hold on a type of entity in a project?
      - Can I see a team's access to every entity of one type in a project?
      instructions:
      - text: Show team {team_id}'s permissions on {entity_type} in project {project_id}.
        slots:
          team_id: path.team_id
          entity_type: path.entity_type
          project_id: path.project_id
      - text: List what team {team_id} can do with {entity_type} entities in project {project_id}.
        slots:
          team_id: path.team_id
          entity_type: path.entity_type
          project_id: path.project_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/{entity_type}/{entity_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get who has access to one project entity
      effect: read
      questions:
      - Who has access to a specific entity in my project?
      - What permissions are granted on one entity, by user and team?
      instructions:
      - text: Get the permissions on {entity_type} {entity_id} in project {project_id}.
        slots:
          entity_type: path.entity_type
          entity_id: path.entity_id
          project_id: path.project_id
      - text: Show who can access entity {entity_id} of type {entity_type} in project {project_id}.
        slots:
          entity_id: path.entity_id
          entity_type: path.entity_type
          project_id: path.project_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/{entity_type}/{entity_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change access permissions on a project entity
      effect: write
      questions:
      - How do I change who can access a specific entity in a project?
      - Can I grant or adjust permissions on a single entity rather than the whole project?
      instructions:
      - text: Change the permissions on {entity_type} {entity_id} in project {project_id}.
        slots:
          entity_type: path.entity_type
          entity_id: path.entity_id
          project_id: path.project_id
      - text: Update access to entity {entity_id} of type {entity_type} in project {project_id}.
        slots:
          entity_id: path.entity_id
          entity_type: path.entity_type
          project_id: path.project_id
      method: generated
      generated: '2026-09-26'