dotCMS · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for dotCMS REST Theme API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/api/v1/themes/id/{id}'].get
$.paths['/api/v1/themes'].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 dotCMS REST Theme API
  version: 1.0.0
extends: openapi/dotcms-theme-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/api/v1/themes/id/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a theme by ID
      effect: read
      questions:
      - What are the details of the theme a template is using?
      - Can I look up a theme by its folder inode ID?
      instructions:
      - text: Get theme {id}.
        slots:
          id: path.id
      - text: Show the theme whose folder inode is {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/themes'].get
  update:
    x-apievangelist-phrasing:
      intent: List a site's themes
      effect: read
      questions:
      - Which themes are available on one of my sites?
      - Can I search themes by name and sort them descending?
      instructions:
      - text: List the themes for site {hostId}.
        slots:
          hostId: query.hostId
      - text: Search themes on site {hostId} for {searchParam}, sorted {direction}.
        slots:
          hostId: query.hostId
          searchParam: query.searchParam
          direction: query.direction
      - text: Show page {page} of themes for site {hostId}, {per_page} per page.
        slots:
          page: query.page
          hostId: query.hostId
          per_page: query.per_page
      method: generated
      generated: '2026-09-26'