dotCMS · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for dotCMS REST Navigation API

3 actions 3 updates phrasing extends openapi/dotcms-navigation-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/menu'].get

$.paths['/api/v1/nav/{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 Navigation API
  version: 1.0.0
extends: openapi/dotcms-navigation-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/menu'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the back-end admin menus
      effect: read
      questions:
      - Which admin menu sections and portlets can the current user see?
      - Can I load the dotCMS back-end navigation menu?
      instructions:
      - text: Get the admin menu for my user.
      - text: List the back-end menu sections I have access to.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/nav/{uri}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the site navigation tree from a folder
      effect: read
      questions:
      - How do I build my site's menu from folders marked show on menu?
      - Why does the navigation call fail when I pass a page URI instead of a folder?
      instructions:
      - text: Get the navigation tree under folder {uri}.
        slots:
          uri: path.uri
      - text: Build site navigation from {uri} to depth {depth} in language {languageId}.
        slots:
          uri: path.uri
          depth: query.depth
          languageId: query.languageId
      method: generated
      generated: '2026-09-26'