Confluence · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluence Content API

6 actions 6 updates phrasing extends openapi/confluence-content-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 6

$.info
$.paths['/wiki/rest/api/content/archive'].post
$.paths['/wiki/rest/api/content/blueprint/instance/{draftId}'].put
$.paths['/wiki/rest/api/content/blueprint/instance/{draftId}'].post
$.paths['/wiki/rest/api/content/search'].get
$.paths['/content/convert-ids-to-types'].post

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 Content API
  version: 1.0.0
extends: openapi/confluence-content-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: 5
- target: $.paths['/wiki/rest/api/content/archive'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive a batch of pages
      effect: write
      questions:
      - How do I archive several Confluence pages at once?
      - Does archiving pages run as a background task I need to track?
      instructions:
      - text: Archive pages {pages}.
        slots:
          pages: requestBody.pages
      - text: Send pages {pages} to the archive and give me the task id.
        slots:
          pages: requestBody.pages
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/blueprint/instance/{draftId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Publish a shared blueprint draft
      effect: write
      questions:
      - How do I publish a shared draft that was created from a blueprint?
      - Which fields must I send to publish a collaborative blueprint draft?
      instructions:
      - text: Publish shared draft {draftId} titled {title} as type {type} at version {version}.
        slots:
          draftId: path.draftId
          title: requestBody.title
          type: requestBody.type
          version: requestBody.version
      - text: Publish shared blueprint draft {draftId} under parent pages {ancestors} with title {title}, type {type}, version {version}.
        slots:
          draftId: path.draftId
          ancestors: requestBody.ancestors
          title: requestBody.title
          type: requestBody.type
          version: requestBody.version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/blueprint/instance/{draftId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a legacy blueprint draft
      effect: write
      questions:
      - Can I still publish an old-style legacy draft made from a blueprint?
      - Are legacy blueprint drafts going away?
      instructions:
      - text: Publish legacy draft {draftId} titled {title} as type {type} at version {version}.
        slots:
          draftId: path.draftId
          title: requestBody.title
          type: requestBody.type
          version: requestBody.version
      - text: Use the legacy endpoint to publish blueprint draft {draftId} into space {space} as {title}, type {type}, version {version}.
        slots:
          draftId: path.draftId
          space: requestBody.space
          title: requestBody.title
          type: requestBody.type
          version: requestBody.version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Find content objects with a CQL query
      effect: read
      questions:
      - Can I get full content objects back from a Confluence Query Language query?
      - What content matches a CQL expression like type=page and space=DEV?
      instructions:
      - text: Return the content objects matching CQL {cql}.
        slots:
          cql: query.cql
      - text: Fetch up to {limit} pages or blog posts matching CQL {cql} with content expansions.
        slots:
          limit: query.limit
          cql: query.cql
      method: generated
      generated: '2026-10-01'
- target: $.paths['/content/convert-ids-to-types'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up the content type for content ids
      effect: read
      questions:
      - I only stored content ids from the v1 API; how can I find out whether each is a page, blog post or comment?
      - Can I resolve a batch of content ids to their content types?
      instructions:
      - text: Convert content ids {contentIds} to their content types.
        slots:
          contentIds: requestBody.contentIds
      - text: Tell me what type of content each of {contentIds} is.
        slots:
          contentIds: requestBody.contentIds
      method: generated
      generated: '2026-10-01'