Confluence · OpenAPI Overlay 1.0.0

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

4 actions 4 updates phrasing extends openapi/confluence-whiteboard-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['/whiteboards'].post

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

$.paths['/whiteboards/{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 Whiteboard API
  version: 1.0.0
extends: openapi/confluence-whiteboard-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['/whiteboards'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a whiteboard in a space
      effect: write
      questions:
      - How do I create a new Confluence whiteboard in a space?
      - Can I start a whiteboard from a template or in a specific locale?
      instructions:
      - text: Create a whiteboard titled {title} in space {spaceId}.
        slots:
          title: requestBody.title
          spaceId: requestBody.spaceId
      - text: Create whiteboard {title} in space {spaceId} from template {templateKey}.
        slots:
          title: requestBody.title
          spaceId: requestBody.spaceId
          templateKey: requestBody.templateKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/whiteboards/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a whiteboard by id
      effect: read
      questions:
      - How do I fetch a specific whiteboard's details?
      - Can I see a whiteboard's direct children and properties in one call?
      instructions:
      - text: Get whiteboard {id}.
        slots:
          id: path.id
      - text: Show whiteboard {id} including its properties.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/whiteboards/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Move a whiteboard to the trash
      effect: destructive
      questions:
      - How do I delete a whiteboard?
      - Can a trashed whiteboard be restored?
      instructions:
      - text: Delete whiteboard {id}.
        slots:
          id: path.id
      - text: Move whiteboard {id} to the trash.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'