# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Confluence Cloud REST Content restrictions API
  version: 1.0.0
extends: openapi/confluence-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: 12
- target: $.paths['/wiki/rest/api/content/{id}/restriction'].get
  update:
    x-apievangelist-phrasing:
      intent: List the restrictions on content
      effect: read
      questions:
      - Who is restricted from viewing or editing a particular page?
      - Can I see all read and update restrictions on a piece of content as a list?
      instructions:
      - text: List the restrictions on content {id}.
        slots:
          id: path.id
      - text: Show up to {limit} restrictions on page {id}.
        slots:
          id: path.id
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/restriction'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace all restrictions on content
      effect: write
      questions:
      - How do I overwrite a page's existing restrictions with a new set?
      - Will replacing restrictions remove the ones already on the content?
      instructions:
      - text: Replace the restrictions on content {id} with a new set.
        slots:
          id: path.id
      - text: Overwrite every existing restriction 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 content
      effect: write
      questions:
      - Can I add a restriction to a page without touching the restrictions already there?
      - What's the way to layer extra view or edit restrictions onto content?
      instructions:
      - text: Add restrictions to content {id}, keeping the existing ones.
        slots:
          id: path.id
      - text: Append new read or update restrictions to page {id}.
        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 content
      effect: destructive
      questions:
      - How do I clear every read and edit restriction from a page?
      - Can I open a restricted page back up to everyone in the space?
      instructions:
      - text: Remove all restrictions from content {id}.
        slots:
          id: path.id
      - text: Lift every read and update 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 content restrictions grouped by operation
      effect: read
      questions:
      - Can I see a page's restrictions organised by read versus update?
      - Which restrictions apply to viewing a page and which to editing it?
      instructions:
      - text: Get the restrictions on content {id} grouped by operation.
        slots:
          id: path.id
      - text: Break down page {id}'s restrictions into 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 content restrictions for one operation
      effect: read
      questions:
      - Who exactly is allowed to edit a restricted page?
      - Can I list only the read restrictions on a piece of content?
      instructions:
      - text: Show the {operationKey} restrictions on content {id}.
        slots:
          id: path.id
          operationKey: path.operationKey
      - text: List up to {limit} {operationKey} restrictions for page {id}.
        slots:
          id: path.id
          operationKey: path.operationKey
          limit: query.limit
      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 is in a content restriction
      effect: read
      questions:
      - Does a particular group have read access under a page's restriction?
      - Can I check whether a group is included in an edit restriction on content?
      instructions:
      - text: Check whether group {groupId} is in the {operationKey} restriction on content {id}.
        slots:
          id: path.id
          operationKey: path.operationKey
          groupId: path.groupId
      - text: Confirm if the {operationKey} restriction on page {id} applies to group {groupId}.
        slots:
          id: path.id
          operationKey: path.operationKey
          groupId: path.groupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/byGroupId/{groupId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Grant a group access via a content restriction
      effect: write
      questions:
      - How do I let one group edit a page that's otherwise restricted?
      - Can I add a group to a page's read restriction by its group ID?
      instructions:
      - text: Add group {groupId} to the {operationKey} restriction on content {id}.
        slots:
          id: path.id
          operationKey: path.operationKey
          groupId: path.groupId
      - text: Give group {groupId} {operationKey} permission on restricted page {id}.
        slots:
          id: path.id
          operationKey: path.operationKey
          groupId: path.groupId
      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 content restriction
      effect: destructive
      questions:
      - How do I take a group off a page's view restriction?
      - Can I revoke one group's edit access on restricted content?
      instructions:
      - text: Remove group {groupId} from the {operationKey} restriction on content {id}.
        slots:
          id: path.id
          operationKey: path.operationKey
          groupId: path.groupId
      - text: Revoke group {groupId}'s {operationKey} permission on page {id}.
        slots:
          id: path.id
          operationKey: path.operationKey
          groupId: path.groupId
      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 content restriction
      effect: read
      questions:
      - Is a specific person allowed through a page's read restriction?
      - Can I check whether a user's account is part of an edit restriction?
      instructions:
      - text: Check whether user {accountId} is in the {operationKey} restriction on content {id}.
        slots:
          id: path.id
          operationKey: path.operationKey
          accountId: query.accountId
      - text: Confirm if the {operationKey} restriction on page {id} applies to account {accountId}.
        slots:
          id: path.id
          operationKey: path.operationKey
          accountId: query.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/user'].put
  update:
    x-apievangelist-phrasing:
      intent: Grant a user access via a content restriction
      effect: write
      questions:
      - How do I let one person view a page that's restricted?
      - Can I add a single user to a page's edit restriction?
      instructions:
      - text: Add user {accountId} to the {operationKey} restriction on content {id}.
        slots:
          id: path.id
          operationKey: path.operationKey
          accountId: query.accountId
      - text: Give account {accountId} {operationKey} permission on restricted page {id}.
        slots:
          id: path.id
          operationKey: path.operationKey
          accountId: query.accountId
      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 content restriction
      effect: destructive
      questions:
      - How do I take one person off a page's restriction?
      - Can I revoke a specific user's view access on restricted content?
      instructions:
      - text: Remove user {accountId} from the {operationKey} restriction on content {id}.
        slots:
          id: path.id
          operationKey: path.operationKey
          accountId: query.accountId
      - text: Revoke account {accountId}'s {operationKey} permission on page {id}.
        slots:
          id: path.id
          operationKey: path.operationKey
          accountId: query.accountId
      method: generated
      generated: '2026-10-01'