Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Confluence Cloud REST Content Restrictions API

16 actions 16 updates phrasing extends openapi/atlassian-content-restrictions-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 16

$.info

$.paths['/wiki/rest/api/content/{id}/restriction'].get

$.paths['/wiki/rest/api/content/{id}/restriction'].put

$.paths['/wiki/rest/api/content/{id}/restriction'].post

$.paths['/wiki/rest/api/content/{id}/restriction'].delete

$.paths['/wiki/rest/api/content/{id}/restriction/byOperation'].get

$.paths['/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}'].get

$.paths['/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName}'].get

$.paths['/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName}'].put

$.paths['/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName}'].delete

$.paths['/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/byGroupId/{groupId}'].get

$.paths['/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/byGroupId/{groupId}'].put

$.paths['/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/byGroupId/{groupId}'].delete

$.paths['/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/user'].get

$.paths['/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/user'].put

$.paths['/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/user'].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 Content Restrictions API
  version: 1.0.0
extends: openapi/atlassian-content-restrictions-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: 15
- target: $.paths['/wiki/rest/api/content/{id}/restriction'].get
  update:
    x-apievangelist-phrasing:
      intent: List the restrictions on a page
      effect: read
      questions:
      - Who is allowed to view or edit a restricted Confluence page?
      - What read and update restrictions are on a piece of content?
      instructions:
      - text: Show every restriction currently on content {id}.
        slots:
          id: path.id
      - text: List up to {limit} users and groups restricted on page {id}.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/restriction'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace the restrictions on a page
      effect: write
      questions:
      - Can I overwrite all existing view and edit restrictions on a page at once?
      - How do I replace a page's restrictions instead of adding to them?
      instructions:
      - text: Replace the restrictions on content {id}.
        slots:
          id: path.id
      - text: Overwrite the existing read and update restrictions on page {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/restriction'].post
  update:
    x-apievangelist-phrasing:
      intent: Add restrictions to a page
      effect: write
      questions:
      - Can I add more restrictions to a page without wiping the current ones?
      - Which permission do I need to add restrictions to content?
      instructions:
      - text: Add restrictions to content {id}.
        slots:
          id: path.id
      - text: Add new restrictions to page {id} while keeping the existing ones.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/restriction'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove all restrictions from a page
      effect: destructive
      questions:
      - How do I make a restricted page open to everyone again?
      - Can I clear every read and update restriction on content in one step?
      instructions:
      - text: Remove all restrictions from content {id}.
        slots:
          id: path.id
      - text: Clear every view and edit restriction on page {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/restriction/byOperation'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a page's restrictions grouped by operation
      effect: read
      questions:
      - Can I see a page's read and update restrictions keyed by operation?
      - What does each operation's restriction look like on a piece of content?
      instructions:
      - text: Show the restrictions on content {id} grouped by operation.
        slots:
          id: path.id
      - text: Get page {id}'s restrictions keyed by read and update.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a page's restrictions for one operation
      effect: read
      questions:
      - Who is restricted from editing a particular page?
      - What are only the read restrictions on a piece of content?
      instructions:
      - text: Show only the {operationKey} restriction details for content {id}.
        slots:
          operationKey: path.operationKey
          id: path.id
      - text: List up to {limit} users and groups in the {operationKey} restriction for page {id}.
        slots:
          limit: query.limit
          operationKey: path.operationKey
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a group's page restriction by name (deprecated)
      effect: read
      questions:
      - Does a restriction apply to a group I know only by its group name?
      - Is there a legacy name-based way to check a group against a page restriction?
      instructions:
      - text: Check by group name whether {groupName} is in the {operationKey} restriction on content {id}.
        slots:
          groupName: path.groupName
          operationKey: path.operationKey
          id: path.id
      - text: Use the deprecated name lookup to see if group {groupName} has {operationKey} on page {id}.
        slots:
          groupName: path.groupName
          operationKey: path.operationKey
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Add a group to a page restriction by name (deprecated)
      effect: write
      questions:
      - Can I still grant a group page access using its name instead of its ID?
      - Is the group-name version of adding a restriction deprecated?
      instructions:
      - text: Add group named {groupName} to the {operationKey} restriction on content {id}.
        slots:
          groupName: path.groupName
          operationKey: path.operationKey
          id: path.id
      - text: Using the legacy name endpoint, grant {groupName} {operationKey} on page {id}.
        slots:
          groupName: path.groupName
          operationKey: path.operationKey
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a group from a page restriction by name
      effect: destructive
      questions:
      - How do I drop a group from a page restriction when I only know the group name?
      - Is removing a group by name from content restrictions still supported?
      instructions:
      - text: Remove group named {groupName} from the {operationKey} restriction on content {id}.
        slots:
          groupName: path.groupName
          operationKey: path.operationKey
          id: path.id
      - text: Via the deprecated name endpoint, revoke {groupName}'s {operationKey} access to page {id}.
        slots:
          groupName: path.groupName
          operationKey: path.operationKey
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/byGroupId/{groupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if a group ID is in a page restriction
      effect: read
      questions:
      - Does a page's read restriction include a group with a given group ID?
      - Can I verify by group ID whether a group may update a piece of content?
      instructions:
      - text: Check whether group ID {groupId} is in the {operationKey} restriction on content {id}.
        slots:
          groupId: path.groupId
          operationKey: path.operationKey
          id: path.id
      - text: Tell me if group {groupId} holds {operationKey} on page {id}.
        slots:
          groupId: path.groupId
          operationKey: path.operationKey
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/byGroupId/{groupId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Add a group to a page restriction by group ID
      effect: write
      questions:
      - How do I give a group read access to a restricted page using its group ID?
      - Can I grant a group update permission on one piece of content?
      instructions:
      - text: Add group ID {groupId} to the {operationKey} restriction on content {id}.
        slots:
          groupId: path.groupId
          operationKey: path.operationKey
          id: path.id
      - text: Grant group {groupId} {operationKey} permission on page {id}.
        slots:
          groupId: path.groupId
          operationKey: path.operationKey
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/byGroupId/{groupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a group from a page restriction by group ID
      effect: destructive
      questions:
      - How do I take away a group's update permission on a page using its group ID?
      - Can I remove a group ID from a page's read restriction?
      instructions:
      - text: Remove group ID {groupId} from the {operationKey} restriction on content {id}.
        slots:
          groupId: path.groupId
          operationKey: path.operationKey
          id: path.id
      - text: Revoke group {groupId}'s {operationKey} permission on page {id}.
        slots:
          groupId: path.groupId
          operationKey: path.operationKey
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/user'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if a user is in a page restriction
      effect: read
      questions:
      - Is a particular person included in a page's read restriction?
      - Can I check by account ID whether someone may edit restricted content?
      instructions:
      - text: Check whether user {accountId} is in the {operationKey} restriction on content {id}.
        slots:
          accountId: query.accountId
          operationKey: path.operationKey
          id: path.id
      - text: Tell me if account {accountId} holds {operationKey} on page {id}.
        slots:
          accountId: query.accountId
          operationKey: path.operationKey
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/user'].put
  update:
    x-apievangelist-phrasing:
      intent: Add a user to a page restriction
      effect: write
      questions:
      - How do I let one specific person view a restricted Confluence page?
      - Can I grant an individual user edit rights on restricted content?
      instructions:
      - text: Add user {accountId} to the {operationKey} restriction on content {id}.
        slots:
          accountId: query.accountId
          operationKey: path.operationKey
          id: path.id
      - text: Grant account {accountId} {operationKey} permission on page {id}.
        slots:
          accountId: query.accountId
          operationKey: path.operationKey
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/user'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user from a page restriction
      effect: destructive
      questions:
      - How do I take one person off a page's restriction list?
      - Can I revoke an individual user's edit rights on restricted content?
      instructions:
      - text: Remove user {accountId} from the {operationKey} restriction on content {id}.
        slots:
          accountId: query.accountId
          operationKey: path.operationKey
          id: path.id
      - text: Revoke account {accountId}'s {operationKey} permission on page {id}.
        slots:
          accountId: query.accountId
          operationKey: path.operationKey
          id: path.id
      method: generated
      generated: '2026-10-01'