# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Jira Cloud platform REST Project role actors API
  version: 1.0.0
extends: openapi/jira-project-role-actors-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: 6
- target: $.paths['/rest/api/3/project/{projectIdOrKey}/role/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace all actors in a project role
      effect: write
      questions:
      - How do I overwrite everyone in a project role with a new set of users and groups?
      - Does setting project role actors replace the existing members?
      instructions:
      - text: Replace the actors of role {id} in project {projectIdOrKey} with {categorisedActors}.
        slots:
          id: path.id
          projectIdOrKey: path.projectIdOrKey
          categorisedActors: requestBody.categorisedActors
      - text: Reset role {id} on project {projectIdOrKey} so only these users and groups remain.
        slots:
          id: path.id
          projectIdOrKey: path.projectIdOrKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/project/{projectIdOrKey}/role/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add users or groups to a project role
      effect: write
      questions:
      - How do I add someone to a project role without removing current members?
      - Can I add a whole group to a project's role?
      instructions:
      - text: Add user {user} to role {id} in project {projectIdOrKey}.
        slots:
          user: requestBody.user
          id: path.id
          projectIdOrKey: path.projectIdOrKey
      - text: Add group {groupId} to project {projectIdOrKey}'s role {id}.
        slots:
          groupId: requestBody.groupId
          projectIdOrKey: path.projectIdOrKey
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/project/{projectIdOrKey}/role/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user or group from a project role
      effect: destructive
      questions:
      - How do I take a person out of a role in one specific project?
      - Can I remove a group from a project role by its group ID?
      instructions:
      - text: Remove user {user} from role {id} in project {projectIdOrKey}.
        slots:
          user: query.user
          id: path.id
          projectIdOrKey: path.projectIdOrKey
      - text: Drop group {groupId} from project {projectIdOrKey}'s role {id}.
        slots:
          groupId: query.groupId
          projectIdOrKey: path.projectIdOrKey
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/role/{id}/actors'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project role's default actors
      effect: read
      questions:
      - Who are the default members of a project role for new projects?
      - Which users and groups get a role automatically when a project is created?
      instructions:
      - text: List the default actors for project role {id}.
        slots:
          id: path.id
      - text: Show who new projects get by default in role {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/role/{id}/actors'].post
  update:
    x-apievangelist-phrasing:
      intent: Add default actors to a project role
      effect: write
      questions:
      - How do I make a group a default member of a role for all future projects?
      - Does changing a role's default actors affect projects that already exist?
      instructions:
      - text: Add users {user} as default actors of project role {id}.
        slots:
          user: requestBody.user
          id: path.id
      - text: Make group {groupId} a default member of role {id} for new projects.
        slots:
          groupId: requestBody.groupId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/role/{id}/actors'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove default actors from a project role
      effect: destructive
      questions:
      - How do I stop a user being added to a role by default in new projects?
      - Can I remove a group and a user from a role's defaults in the same call?
      instructions:
      - text: Remove user {user} from the default actors of role {id}.
        slots:
          user: query.user
          id: path.id
      - text: Remove group {groupId} as a default member of project role {id}.
        slots:
          groupId: query.groupId
          id: path.id
      method: generated
      generated: '2026-09-26'