Confluence · OpenAPI Overlay 1.0.0

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

4 actions 4 updates phrasing extends openapi/confluence-folder-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 4

$.info

$.paths['/folders'].post

$.paths['/folders/{id}'].get

$.paths['/folders/{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 Confluence Cloud REST API v2 Folder API
  version: 1.0.0
extends: openapi/confluence-folder-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['/folders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a folder in a space
      effect: write
      questions:
      - How do I create a folder to organize pages in a Confluence space?
      - Can I nest a new folder under an existing page or folder?
      instructions:
      - text: Create a folder titled {title} in space {spaceId}.
        slots:
          title: requestBody.title
          spaceId: requestBody.spaceId
      - text: Create folder {title} in space {spaceId} under parent {parentId}.
        slots:
          title: requestBody.title
          spaceId: requestBody.spaceId
          parentId: requestBody.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/folders/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a folder by id
      effect: read
      questions:
      - What details can I get about a specific folder?
      - Can I include a folder's collaborators and direct children in one request?
      instructions:
      - text: Show folder {id}.
        slots:
          id: path.id
      - text: Get folder {id} including its direct children.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/folders/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Move a folder to the trash
      effect: destructive
      questions:
      - Can I restore a folder after deleting it?
      - How do I delete a folder from a space?
      instructions:
      - text: Delete folder {id}.
        slots:
          id: path.id
      - text: Send folder {id} to the trash.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'