dotCMS · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for dotCMS REST Personas API

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

$.paths['/api/v1/personas/{id}'].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 Personas API
  version: 1.0.0
extends: openapi/dotcms-personas-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/personas'].get
  update:
    x-apievangelist-phrasing:
      intent: List personas for the current site
      effect: read
      questions:
      - What personas are defined for my site?
      - Which audience personas can I target on the current site?
      instructions:
      - text: List all personas for the current site.
      - text: Show me this site's personas.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/personas/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a persona
      effect: read
      questions:
      - How do I look up one persona's details by its identifier?
      - What is configured on a specific persona?
      instructions:
      - text: Get persona {id} on site {siteId}.
        slots:
          id: path.id
          siteId: path.siteId
      - text: Show the details of persona {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'