Confluence · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluence Cloud REST Content permissions API

2 actions 2 updates phrasing extends openapi/confluence-content-permissions-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

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

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 Confluence Cloud REST Content permissions API
  version: 1.0.0
extends: openapi/confluence-content-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: 1
- target: $.paths['/wiki/rest/api/content/{id}/permission/check'].post
  update:
    x-apievangelist-phrasing:
      intent: Check if someone can act on content
      effect: read
      questions:
      - Can a given user edit a specific page?
      - Does a group have permission to read a piece of content?
      instructions:
      - text: Check whether {subject} can {operation} content {id}.
        slots:
          id: path.id
          subject: requestBody.subject
          operation: requestBody.operation
      - text: Verify if user or group {subject} has {operation} permission on page {id}.
        slots:
          id: path.id
          subject: requestBody.subject
          operation: requestBody.operation
      method: generated
      generated: '2026-10-01'