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.
# 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 Checker API
version: 1.0.0
extends: openapi/dotcms-accessibility-checker-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: 4
- target: $.paths['/api/v1/achecker/guidelines'].get
update:
x-apievangelist-phrasing:
intent: List the accessibility guidelines available
effect: read
questions:
- Which accessibility guidelines, like WCAG levels, can content be validated against?
- What standards does the accessibility checker support?
instructions:
- text: List the available accessibility guidelines.
- text: Show the guidelines I can validate content against.
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/achecker/_validate'].post
update:
x-apievangelist-phrasing:
intent: Validate content against accessibility guidelines
effect: read
questions:
- How do I check a piece of HTML content for accessibility problems?
- Can I validate content against more than one accessibility guideline at once?
instructions:
- text: Validate this content against the selected accessibility guidelines.
- text: Run an accessibility check on this HTML snippet and list the issues.
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/page-scanner/a11y/check'].post
update:
x-apievangelist-phrasing:
intent: Scan a live page URL for accessibility issues
effect: read
questions:
- Can I run an accessibility scan on a published page by its URL?
- How do I find accessibility errors on a live page?
instructions:
- text: Scan {url} for accessibility issues.
slots:
url: requestBody.url
- text: Run the page scanner's a11y check on {url}.
slots:
url: requestBody.url
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/page-scanner/geo/check'].post
update:
x-apievangelist-phrasing:
intent: Scan a page URL for generative engine optimization
effect: read
questions:
- How well is a page optimized for AI answer engines (GEO)?
- Can I run a GEO check on a page by URL?
instructions:
- text: Run a GEO check on {url}.
slots:
url: requestBody.url
- text: Scan page {url} for generative engine optimization issues.
slots:
url: requestBody.url
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.