Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Confluence Cloud REST Space Permissions API

4 actions 4 updates phrasing extends openapi/atlassian-space-permissions-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Atlassian's API. It is a proposal applied on top of the contract, not a document Atlassian publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/wiki/rest/api/space/{spaceKey}/permission'].post

$.paths['/wiki/rest/api/space/{spaceKey}/permission/custom-content'].post

$.paths['/wiki/rest/api/space/{spaceKey}/permission/{id}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Atlassian The Confluence Cloud REST Space Permissions API
  version: 1.0.0
extends: openapi/atlassian-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: 3
- target: $.paths['/wiki/rest/api/space/{spaceKey}/permission'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant a permission in a Confluence space
      effect: write
      questions:
      - How do I give a group edit rights in a Confluence space?
      - Can I grant a single user read access to a space?
      instructions:
      - text: Grant {subject} the {operation} permission in space {spaceKey}.
        slots:
          subject: requestBody.subject
          operation: requestBody.operation
          spaceKey: path.spaceKey
      - text: Give {subject} permission {operation} in Confluence space {spaceKey}.
        slots:
          subject: requestBody.subject
          operation: requestBody.operation
          spaceKey: path.spaceKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/space/{spaceKey}/permission/custom-content'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant custom content permissions in a space
      effect: write
      questions:
      - How does an app grant permissions on its custom content type in a space?
      - Can I add several custom content operations for a group at once?
      instructions:
      - text: Grant {subject} custom content operations {operations} in space {spaceKey}.
        slots:
          subject: requestBody.subject
          operations: requestBody.operations
          spaceKey: path.spaceKey
      - text: Add custom content permissions {operations} for {subject} on space {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: Remove a space permission
      effect: destructive
      questions:
      - How do I revoke someone's access to a Confluence 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 Confluence space {spaceKey}.
        slots:
          id: path.id
          spaceKey: path.spaceKey
      method: generated
      generated: '2026-10-01'