Confluence · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluence Cloud REST API v2 Operation API

12 actions 12 updates phrasing extends openapi/confluence-operation-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 12

$.info
$.paths['/attachments/{id}/operations'].get
$.paths['/blogposts/{id}/operations'].get
$.paths['/custom-content/{id}/operations'].get
$.paths['/pages/{id}/operations'].get
$.paths['/whiteboards/{id}/operations'].get
$.paths['/databases/{id}/operations'].get
$.paths['/embeds/{id}/operations'].get
$.paths['/folders/{id}/operations'].get
$.paths['/spaces/{id}/operations'].get
$.paths['/footer-comments/{id}/operations'].get
$.paths['/inline-comments/{id}/operations'].get

OpenAPI Overlay

Raw ↑
# 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 API v2 Operation API
  version: 1.0.0
extends: openapi/confluence-operation-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: 11
- target: $.paths['/attachments/{id}/operations'].get
  update:
    x-apievangelist-phrasing:
      intent: See what I can do with an attachment
      effect: read
      questions:
      - Which actions am I allowed to take on an uploaded file?
      - Can I check whether I may delete or update a specific attachment?
      instructions:
      - text: List my permitted operations on attachment {id}.
        slots:
          id: path.id
      - text: Check what I'm allowed to do with attachment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/blogposts/{id}/operations'].get
  update:
    x-apievangelist-phrasing:
      intent: See what I can do with a blog post
      effect: read
      questions:
      - Am I allowed to edit or delete a given blog post?
      - Which operations are permitted for me on a blog post?
      instructions:
      - text: List my permitted operations on blog post {id}.
        slots:
          id: path.id
      - text: Check what actions I can take on blog post {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-content/{id}/operations'].get
  update:
    x-apievangelist-phrasing:
      intent: See what I can do with custom content
      effect: read
      questions:
      - Which actions are permitted on an app's custom content item?
      - Can I tell if I'm allowed to update a custom content item before trying?
      instructions:
      - text: List my permitted operations on custom content {id}.
        slots:
          id: path.id
      - text: Check what I can do with custom content item {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pages/{id}/operations'].get
  update:
    x-apievangelist-phrasing:
      intent: See what I can do with a page
      effect: read
      questions:
      - Am I allowed to edit a particular Confluence page?
      - Which operations does my account have on a page?
      instructions:
      - text: List my permitted operations on page {id}.
        slots:
          id: path.id
      - text: Check whether I can update or delete page {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/whiteboards/{id}/operations'].get
  update:
    x-apievangelist-phrasing:
      intent: See what I can do with a whiteboard
      effect: read
      questions:
      - Which actions am I permitted to take on a whiteboard?
      - Can I check my permissions on a whiteboard before editing it?
      instructions:
      - text: List my permitted operations on whiteboard {id}.
        slots:
          id: path.id
      - text: Check what I'm allowed to do with whiteboard {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/databases/{id}/operations'].get
  update:
    x-apievangelist-phrasing:
      intent: See what I can do with a database
      effect: read
      questions:
      - Which operations can I perform on a Confluence database?
      - Am I allowed to delete a specific database?
      instructions:
      - text: List my permitted operations on database {id}.
        slots:
          id: path.id
      - text: Check what actions I can take on database {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/embeds/{id}/operations'].get
  update:
    x-apievangelist-phrasing:
      intent: See what I can do with a Smart Link
      effect: read
      questions:
      - Which actions am I permitted on a Smart Link in the content tree?
      - Can I check whether I may remove an embedded Smart Link?
      instructions:
      - text: List my permitted operations on Smart Link {id}.
        slots:
          id: path.id
      - text: Check what I'm allowed to do with Smart Link {id} in the content tree.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/folders/{id}/operations'].get
  update:
    x-apievangelist-phrasing:
      intent: See what I can do with a folder
      effect: read
      questions:
      - Which operations are permitted on a Confluence folder?
      - Am I allowed to change a given folder?
      instructions:
      - text: List my permitted operations on folder {id}.
        slots:
          id: path.id
      - text: Check what actions I can take on folder {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/spaces/{id}/operations'].get
  update:
    x-apievangelist-phrasing:
      intent: See what I can do in a space
      effect: read
      questions:
      - Which space-level actions does my account have?
      - Can I check whether I can administer or create content in a space?
      instructions:
      - text: List my permitted operations in space {id}.
        slots:
          id: path.id
      - text: Check what I'm allowed to do in space {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/footer-comments/{id}/operations'].get
  update:
    x-apievangelist-phrasing:
      intent: See what I can do with a footer comment
      effect: read
      questions:
      - Am I allowed to edit or delete a particular footer comment?
      - Which operations are permitted on a page-bottom comment?
      instructions:
      - text: List my permitted operations on footer comment {id}.
        slots:
          id: path.id
      - text: Check whether I can delete footer comment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/inline-comments/{id}/operations'].get
  update:
    x-apievangelist-phrasing:
      intent: See what I can do with an inline comment
      effect: read
      questions:
      - Which actions am I allowed on an inline comment?
      - Can I check whether I may resolve or delete an inline comment?
      instructions:
      - text: List my permitted operations on inline comment {id}.
        slots:
          id: path.id
      - text: Check what I'm allowed to do with inline comment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'