Atlassian · OpenAPI Overlay 1.0.0

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

7 actions 7 updates phrasing extends openapi/atlassian-settings-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/lookandfeel'].get
$.paths['/wiki/rest/api/settings/lookandfeel'].put
$.paths['/wiki/rest/api/settings/lookandfeel/custom'].post
$.paths['/wiki/rest/api/settings/lookandfeel/custom'].delete
$.paths['/wiki/rest/api/settings/lookandfeel/selected'].put
$.paths['/wiki/rest/api/settings/systemInfo'].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 Atlassian The Confluence Cloud REST Settings API
  version: 1.0.0
extends: openapi/atlassian-settings-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/lookandfeel'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Confluence look and feel settings
      effect: read
      questions:
      - What colors and header styling does our Confluence site use?
      - Can I see the look and feel for one space rather than the whole site?
      instructions:
      - text: Get the site-wide Confluence look and feel settings.
      - text: Show the look and feel settings for space {spaceKey}.
        slots:
          spaceKey: query.spaceKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/settings/lookandfeel'].put
  update:
    x-apievangelist-phrasing:
      intent: Choose global, custom or theme look for a space
      effect: write
      questions:
      - Can I switch a space to use its theme's look and feel instead of global settings?
      - Which look and feel types can a space select?
      instructions:
      - text: Select look and feel type {lookAndFeelType} for space {spaceKey}.
        slots:
          lookAndFeelType: requestBody.lookAndFeelType
          spaceKey: requestBody.spaceKey
      - text: Switch space {spaceKey} to the {lookAndFeelType} look and feel.
        slots:
          spaceKey: requestBody.spaceKey
          lookAndFeelType: requestBody.lookAndFeelType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/settings/lookandfeel/custom'].post
  update:
    x-apievangelist-phrasing:
      intent: Update custom look and feel styling
      effect: write
      questions:
      - How do I change the header, link and menu colors in Confluence?
      - Does updating custom styling make it active automatically?
      instructions:
      - text: Update the custom header styling for space {spaceKey} to {header}.
        slots:
          spaceKey: query.spaceKey
          header: requestBody.header
      - text: Set custom link colors {links} and menus {menus} on the site look and feel.
        slots:
          links: requestBody.links
          menus: requestBody.menus
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/settings/lookandfeel/custom'].delete
  update:
    x-apievangelist-phrasing:
      intent: Reset custom look and feel to defaults
      effect: destructive
      questions:
      - Can I wipe our custom Confluence styling back to the defaults?
      - Does resetting custom look and feel change which settings are selected?
      instructions:
      - text: Reset the custom look and feel for space {spaceKey} to default values.
        slots:
          spaceKey: query.spaceKey
      - text: Reset the site's custom look and feel values to the defaults.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/settings/lookandfeel/selected'].put
  update:
    x-apievangelist-phrasing:
      intent: Apply default or custom look and feel
      effect: write
      questions:
      - How do I turn on our custom look and feel for the whole site?
      - Can a space go back to the inherited default styling?
      instructions:
      - text: Apply the selected default-or-custom look and feel to space {spaceKey}.
        slots:
          spaceKey: query.spaceKey
      - text: Activate the custom look and feel for the whole site.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/settings/systemInfo'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Confluence Cloud system info
      effect: read
      questions:
      - What system details does our Confluence Cloud tenant report?
      - Can I find the cloud ID and base URL of our Confluence site?
      instructions:
      - text: Get the system information for this Confluence Cloud tenant.
      - text: Show the Confluence site's system info.
      method: generated
      generated: '2026-10-01'