Confluence · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluence Cloud REST API v2 Data Policies API

3 actions 3 updates phrasing extends openapi/confluence-data-policies-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['/data-policies/metadata'].get
$.paths['/data-policies/spaces'].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 Data Policies API
  version: 1.0.0
extends: openapi/confluence-data-policies-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['/data-policies/metadata'].get
  update:
    x-apievangelist-phrasing:
      intent: Get workspace data policy metadata
      effect: read
      questions:
      - Does my Confluence workspace have any data policies that block app access?
      - Can only apps read the workspace data policy metadata?
      instructions:
      - text: Get the data policy metadata for this workspace.
      - text: Show whether data policies are in effect on the workspace.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-policies/spaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List spaces with their data policy status
      effect: read
      questions:
      - Which spaces are affected by data policies that restrict apps?
      - Can I check data policy status for specific space keys?
      instructions:
      - text: List spaces along with their data policy information.
      - text: Show the data policy status of spaces {keys}.
        slots:
          keys: query.keys
      method: generated
      generated: '2026-10-01'