dotCMS · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for dotCMS REST Usage API

2 actions 2 updates phrasing extends openapi/dotcms-usage-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 2

$.info
$.paths['/api/v1/usage/summary'].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 Usage API
  version: 1.0.0
extends: openapi/dotcms-usage-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: 1
- target: $.paths['/api/v1/usage/summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the usage dashboard summary
      effect: read
      questions:
      - How much content, how many sites and users does my dotCMS instance have?
      - Can I get a lighter or fuller usage summary by choosing a profile?
      instructions:
      - text: Show the usage dashboard summary.
      - text: Get the usage summary with the {profile} metric profile.
        slots:
          profile: query.profile
      method: generated
      generated: '2026-09-26'