Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Confluence Cloud REST Themes API

7 actions 7 updates phrasing extends openapi/atlassian-themes-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Atlassian's API. It is a proposal applied on top of the contract, not a document Atlassian publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/wiki/rest/api/settings/theme'].get
$.paths['/wiki/rest/api/settings/theme/selected'].get
$.paths['/wiki/rest/api/settings/theme/{themeKey}'].get
$.paths['/wiki/rest/api/space/{spaceKey}/theme'].get
$.paths['/wiki/rest/api/space/{spaceKey}/theme'].put
$.paths['/wiki/rest/api/space/{spaceKey}/theme'].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 Atlassian The Confluence Cloud REST Themes API
  version: 1.0.0
extends: openapi/atlassian-themes-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: 6
- target: $.paths['/wiki/rest/api/settings/theme'].get
  update:
    x-apievangelist-phrasing:
      intent: List the installed Confluence themes
      effect: read
      questions:
      - Which themes are installed on our Confluence site besides the default?
      - What look-and-feel options can I pick from for spaces?
      instructions:
      - text: List all installed themes.
      - text: Show {limit} themes starting at {start}.
        slots:
          limit: query.limit
          start: query.start
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/settings/theme/selected'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the site-wide theme
      effect: read
      questions:
      - What theme is applied globally across the whole site?
      - Which theme do spaces inherit when they have none of their own?
      instructions:
      - text: Show the globally selected theme.
      - text: Tell me which theme the site uses by default.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/settings/theme/{themeKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a theme's details by key
      effect: read
      questions:
      - What is the name, description and icon of a particular theme?
      - Can I look up a theme's details from its theme key?
      instructions:
      - text: Get the details of theme {themeKey}.
        slots:
          themeKey: path.themeKey
      - text: Describe the theme with key {themeKey}.
        slots:
          themeKey: path.themeKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/space/{spaceKey}/theme'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the theme set on a space
      effect: read
      questions:
      - Which theme is a particular space using?
      - Is a space inheriting the global look and feel or using its own theme?
      instructions:
      - text: Show the theme for space {spaceKey}.
        slots:
          spaceKey: path.spaceKey
      - text: Check whether space {spaceKey} has its own theme set.
        slots:
          spaceKey: path.spaceKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/space/{spaceKey}/theme'].put
  update:
    x-apievangelist-phrasing:
      intent: Apply a theme to a space
      effect: write
      questions:
      - How do I give one space a different theme from the rest of the site?
      - Can I change a space's theme by key?
      instructions:
      - text: Set the theme of space {spaceKey} to {themeKey}.
        slots:
          spaceKey: path.spaceKey
          themeKey: requestBody.themeKey
      - text: Apply theme {themeKey} to the {spaceKey} space.
        slots:
          themeKey: requestBody.themeKey
          spaceKey: path.spaceKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/space/{spaceKey}/theme'].delete
  update:
    x-apievangelist-phrasing:
      intent: Reset a space to the global theme
      effect: destructive
      questions:
      - How do I make a space go back to the site's default look and feel?
      - Can I clear a custom theme from a space?
      instructions:
      - text: Reset the theme of space {spaceKey}.
        slots:
          spaceKey: path.spaceKey
      - text: Remove the custom theme from {spaceKey} so it inherits the global one.
        slots:
          spaceKey: path.spaceKey
      method: generated
      generated: '2026-10-01'