dotCMS · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for dotCMS REST Accessibility Agent API

4 actions 4 updates phrasing extends openapi/dotcms-accessibility-agent-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 4

$.info
$.paths['/api/v1/agents/a11y/fix'].post
$.paths['/api/v1/agents/a11y/fix/stream'].post
$.paths['/api/v1/agents/a11y/stop'].post

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 Accessibility Agent API
  version: 1.0.0
extends: openapi/dotcms-accessibility-agent-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: 3
- target: $.paths['/api/v1/agents/a11y/fix'].post
  update:
    x-apievangelist-phrasing:
      intent: Run the accessibility fix agent on a page
      effect: write
      questions:
      - Can dotCMS automatically fix accessibility issues on a page?
      - How do I run the a11y agent and get its report when it finishes?
      instructions:
      - text: Run the accessibility fix agent on page {identifier}.
        slots:
          identifier: requestBody.identifier
      - text: Fix accessibility on page {identifier} in language {languageId}, skipping CSS.
        slots:
          identifier: requestBody.identifier
          languageId: requestBody.languageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/agents/a11y/fix/stream'].post
  update:
    x-apievangelist-phrasing:
      intent: Run the accessibility agent with live progress
      effect: write
      questions:
      - Can I watch the accessibility fix agent's progress as it runs?
      - Is there a streaming version of the a11y fix that sends events?
      instructions:
      - text: Run the accessibility fix on page {identifier} and stream progress.
        slots:
          identifier: requestBody.identifier
      - text: Stream a11y fixes for page {identifier} in language {languageId}.
        slots:
          identifier: requestBody.identifier
          languageId: requestBody.languageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/agents/a11y/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop an accessibility fix run
      effect: destructive
      questions:
      - How do I stop an accessibility fix that's still running?
      - Are fixes already applied kept if I abort the a11y agent?
      instructions:
      - text: Stop accessibility run {runId}.
        slots:
          runId: requestBody.runId
      - text: Abort a11y agent run {runId} at its next checkpoint.
        slots:
          runId: requestBody.runId
      method: generated
      generated: '2026-09-26'