dotCMS · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for dotCMS REST Announcements API

2 actions 2 updates phrasing extends openapi/dotcms-announcements-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/announcements'].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 Announcements API
  version: 1.0.0
extends: openapi/dotcms-announcements-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/announcements'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the latest dotCMS announcements
      effect: read
      questions:
      - What product announcements are showing in my dotCMS dashboard?
      - Can I force the announcements list to refresh instead of using the cache?
      instructions:
      - text: Show the latest announcements.
      - text: Get the {limit} newest announcements with cache refresh {refreshCache}.
        slots:
          limit: query.limit
          refreshCache: query.refreshCache
      method: generated
      generated: '2026-09-26'