Confluence · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluence Cloud REST Settings API

6 actions 6 updates phrasing extends openapi/confluence-settings-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 6

$.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/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 Confluence Cloud REST Settings API
  version: 1.0.0
extends: openapi/confluence-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: 5
- target: $.paths['/wiki/rest/api/settings/lookandfeel'].get
  update:
    x-apievangelist-phrasing:
      intent: Get look and feel settings
      effect: read
      questions:
      - What color scheme and styling does my site or a space use?
      - Can I see whether a space inherits the global look and feel?
      instructions:
      - text: Get the site's 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 which look and feel a space uses
      effect: write
      questions:
      - How do I switch a space between global, custom and theme styling?
      - Can I make a space use its theme's look and feel?
      instructions:
      - text: Set space {spaceKey} to use the {lookAndFeelType} look and feel.
        slots:
          spaceKey: requestBody.spaceKey
          lookAndFeelType: requestBody.lookAndFeelType
      - text: Switch the styling of space {spaceKey} to {lookAndFeelType}.
        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: Customize look and feel colors and styles
      effect: write
      questions:
      - How do I change heading, link and menu colors for my site?
      - Can I define custom look and feel settings for one space?
      instructions:
      - text: Update the custom look and feel for space {spaceKey} with headings {headings} and links {links}.
        slots:
          spaceKey: query.spaceKey
          headings: requestBody.headings
          links: requestBody.links
      - text: Save custom site styling with menus {menus}, header {header}, content {content} and borders {borders}.
        slots:
          menus: requestBody.menus
          header: requestBody.header
          content: requestBody.content
          borders: requestBody.bordersAndDividers
      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:
      - How do I undo my custom styling and go back to the defaults?
      - Can I reset a space's custom look and feel values?
      instructions:
      - text: Reset the site's custom look and feel to default values.
      - text: Reset the custom look and feel of space {spaceKey}.
        slots:
          spaceKey: query.spaceKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/settings/systemInfo'].get
  update:
    x-apievangelist-phrasing:
      intent: Get system info for the Confluence tenant
      effect: read
      questions:
      - What system information does my Confluence Cloud tenant report?
      - Where can I find build and tenant details for the site?
      instructions:
      - text: Get the system info for this Confluence site.
      - text: Show the tenant's system information.
      method: generated
      generated: '2026-10-01'