dotCMS · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for dotCMS REST Browser Tree API

6 actions 6 updates phrasing extends openapi/dotcms-browser-tree-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 6

$.info

$.paths['/api/v1/browser'].post

$.paths['/api/v1/browser/selectedfolder'].get

$.paths['/api/v1/browser/selectedfolder'].put

$.paths['/api/v1/browsertree/sitename/{sitename}/uri'].get

$.paths['/api/v1/browsertree/sitename/{sitename}/uri/{uri}'].get

OpenAPI Overlay

# 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 Browser Tree API
  version: 1.0.0
extends: openapi/dotcms-browser-tree-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: 5
- target: $.paths['/api/v1/browser'].post
  update:
    x-apievangelist-phrasing:
      intent: Browse a folder's files, pages and subfolders
      effect: read
      questions:
      - How do I list what's inside a folder in the site browser, including pages and files?
      - Can I filter folder contents by MIME type or file extension?
      - Is it possible to include archived or working versions when browsing a folder?
      instructions:
      - text: List the contents of folder {hostFolderId}.
        slots:
          hostFolderId: requestBody.hostFolderId
      - text: Browse {hostFolderId} showing only files with extensions {extensions}, sorted by {sortBy}.
        slots:
          hostFolderId: requestBody.hostFolderId
          extensions: requestBody.extensions
          sortBy: requestBody.sortBy
      - text: Show up to {maxResults} items in {hostFolderId} matching {filter}.
        slots:
          maxResults: requestBody.maxResults
          hostFolderId: requestBody.hostFolderId
          filter: requestBody.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/browser/selectedfolder'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the folder currently selected in the browser
      effect: read
      questions:
      - Which folder did I last select in the site browser?
      - How can I restore the site browser to my last selected folder?
      instructions:
      - text: Show my currently selected site browser folder.
      - text: Get the folder I last had open in the browser.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/browser/selectedfolder'].put
  update:
    x-apievangelist-phrasing:
      intent: Set the selected folder in the site browser
      effect: write
      questions:
      - How do I make the site browser remember a folder as selected?
      - Can I set my selected folder by its path?
      instructions:
      - text: Select folder {path} in the site browser.
        slots:
          path: requestBody.path
      - text: Remember {path} as my current browser folder.
        slots:
          path: requestBody.path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/browsertree/sitename/{sitename}/uri'].get
  update:
    x-apievangelist-phrasing:
      intent: Load the asset tree at a site's root
      effect: read
      questions:
      - How do I get the folders and assets at the top level of a site?
      - What lives at the root of a given site by hostname?
      instructions:
      - text: Load the asset tree at the root of site {sitename}.
        slots:
          sitename: path.sitename
      - text: Show top-level folders and assets for {sitename}.
        slots:
          sitename: path.sitename
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/browsertree/sitename/{sitename}/uri/{uri}'].get
  update:
    x-apievangelist-phrasing:
      intent: Load the asset tree under a site path
      effect: read
      questions:
      - How do I list assets under a specific URI path of a site?
      - Can I browse a nested folder path by site name and URI?
      instructions:
      - text: Load assets under {uri} on site {sitename}.
        slots:
          uri: path.uri
          sitename: path.sitename
      - text: Show the folder tree at path {uri} for {sitename}.
        slots:
          uri: path.uri
          sitename: path.sitename
      method: generated
      generated: '2026-09-26'