# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Confluence Space permissions API
  version: 1.0.0
extends: openapi/confluence-space-permissions-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: 5
- target: $.paths['/wiki/rest/api/space/{spaceKey}/permission'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant a user or group a space permission
      effect: write
      questions:
      - How do I give a group permission to edit pages in a space?
      - Can I identify the group by its id instead of its name when granting a space permission?
      instructions:
      - text: Grant {subject} the {operation} permission in space {spaceKey}.
        slots:
          subject: requestBody.subject
          operation: requestBody.operation
          spaceKey: path.spaceKey
      - text: Add a space permission in {spaceKey} allowing {subject} to {operation}.
        slots:
          spaceKey: path.spaceKey
          subject: requestBody.subject
          operation: requestBody.operation
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/space/{spaceKey}/permission/custom-content'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant an app's custom content permissions in a space
      effect: write
      questions:
      - How does my app grant permissions on its own custom content type in a space?
      - Can a regular user call the custom content permission endpoint, or only apps?
      instructions:
      - text: Grant {subject} custom content permissions {operations} in space {spaceKey}.
        slots:
          subject: requestBody.subject
          operations: requestBody.operations
          spaceKey: path.spaceKey
      - text: Add app custom content operations {operations} for {subject} in {spaceKey}.
        slots:
          operations: requestBody.operations
          subject: requestBody.subject
          spaceKey: path.spaceKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/space/{spaceKey}/permission/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a space permission
      effect: destructive
      questions:
      - How do I take a permission away from someone in a space?
      - What happens if I remove a user's Read Space permission?
      instructions:
      - text: Remove permission {id} from space {spaceKey}.
        slots:
          id: path.id
          spaceKey: path.spaceKey
      - text: Revoke space permission {id} in {spaceKey}.
        slots:
          id: path.id
          spaceKey: path.spaceKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/spaces/{id}/permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List the permission assignments in a space
      effect: read
      questions:
      - Who has which permissions in a given space?
      - Can I page through a space's permission assignments?
      instructions:
      - text: List the permission assignments for space {id}.
        slots:
          id: path.id
      - text: Show the first {limit} permission grants in space {id}.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/space-permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List all possible space permissions
      effect: read
      questions:
      - Which space permissions exist that a role can include?
      - What permission types can be granted in a role-based access control space?
      instructions:
      - text: List every available space permission.
      - text: Show {limit} of the permission types that can go into a space role.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-10-01'