Confluence · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluence Cloud REST API v2 Admin Key API

4 actions 4 updates phrasing extends openapi/confluence-admin-key-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['/admin-key'].get
$.paths['/admin-key'].post
$.paths['/admin-key'].delete

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 Admin Key API
  version: 1.0.0
extends: openapi/confluence-admin-key-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['/admin-key'].get
  update:
    x-apievangelist-phrasing:
      intent: Check my current admin key
      effect: read
      questions:
      - Do I currently have an admin key enabled on this site?
      - When does my admin key expire?
      instructions:
      - text: Show my current admin key status.
      - text: Check whether an admin key is active for me and when it expires.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin-key'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable an admin key
      effect: write
      questions:
      - How do I turn on an admin key for elevated access?
      - Can I choose how many minutes my admin key stays valid?
      instructions:
      - text: Enable an admin key for me.
      - text: Enable an admin key that lasts {durationInMinutes} minutes.
        slots:
          durationInMinutes: requestBody.durationInMinutes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin-key'].delete
  update:
    x-apievangelist-phrasing:
      intent: Disable my admin key
      effect: destructive
      questions:
      - How do I switch off my admin key before it expires?
      - Can I revoke admin key access for myself?
      instructions:
      - text: Disable my admin key.
      - text: Revoke my admin key access on this site now.
      method: generated
      generated: '2026-10-01'