dotCMS · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for dotCMS REST Content Report API

3 actions 3 updates phrasing extends openapi/dotcms-content-report-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/contentreport/folder/{folder}'].get
$.paths['/api/v1/contentreport/site/{site}'].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 Content Report API
  version: 1.0.0
extends: openapi/dotcms-content-report-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/contentreport/folder/{folder}'].get
  update:
    x-apievangelist-phrasing:
      intent: Report content counts by type within a folder
      effect: read
      questions:
      - How many items of each content type live under a folder?
      - Can I run a folder content report by folder path instead of id?
      instructions:
      - text: Generate a content report for folder {folder}.
        slots:
          folder: path.folder
      - text: Report content types under folder path {folder} on site {site}.
        slots:
          folder: path.folder
          site: query.site
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/contentreport/site/{site}'].get
  update:
    x-apievangelist-phrasing:
      intent: Report content counts by type across a site
      effect: read
      questions:
      - Which content types exist on a site and how many items each has?
      - How can I size up a site's content before deleting it?
      instructions:
      - text: Generate a content report for site {site}.
        slots:
          site: path.site
      - text: Show page {page} of the content type counts for site {site}, ordered by {orderby}.
        slots:
          page: query.page
          site: path.site
          orderby: query.orderby
      method: generated
      generated: '2026-09-26'