Confluence · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/confluence-redactions-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 3

$.info
$.paths['/pages/{id}/redact'].post
$.paths['/blogposts/{id}/redact'].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 Cloud REST API v2 Redactions API
  version: 1.0.0
extends: openapi/confluence-redactions-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: 2
- target: $.paths['/pages/{id}/redact'].post
  update:
    x-apievangelist-phrasing:
      intent: Redact sensitive text in a page
      effect: destructive
      questions:
      - How do I black out sensitive text on a Confluence page?
      - Can I also scrub redacted content from a page's history?
      instructions:
      - text: Redact sensitive content in page {id} as of {createdAt}.
        slots:
          id: path.id
          createdAt: requestBody.createdAt
      - text: Redact page {id} at version {versionNumber}, timestamped {createdAt}, and clean its history.
        slots:
          id: path.id
          versionNumber: requestBody.versionNumber
          createdAt: requestBody.createdAt
      method: generated
      generated: '2026-10-01'
- target: $.paths['/blogposts/{id}/redact'].post
  update:
    x-apievangelist-phrasing:
      intent: Redact sensitive text in a blog post
      effect: destructive
      questions:
      - How do I redact confidential details from a blog post?
      - Can I redact a blog post's title as well as its body?
      instructions:
      - text: Redact sensitive content in blog post {id} as of {createdAt}.
        slots:
          id: path.id
          createdAt: requestBody.createdAt
      - text: Redact blog post {id} at version {versionNumber}, timestamped {createdAt}, and clean its history.
        slots:
          id: path.id
          versionNumber: requestBody.versionNumber
          createdAt: requestBody.createdAt
      method: generated
      generated: '2026-10-01'