dotCMS · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for dotCMS REST Test Resource API

3 actions 3 updates phrasing extends openapi/dotcms-testresource-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/testResource/testGet/{params}'].get
$.paths['/api/testResource/testPost'].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 Test Resource API
  version: 1.0.0
extends: openapi/dotcms-testresource-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/testResource/testGet/{params}'].get
  update:
    x-apievangelist-phrasing:
      intent: Call the test GET resource
      effect: read
      questions:
      - Is there a test GET endpoint I can hit to check the REST layer works?
      - What does the testResource GET call return?
      instructions:
      - text: Call the test GET resource with {params}.
        slots:
          params: path.params
      - text: Hit testGet using {params} to confirm the API responds.
        slots:
          params: path.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/testResource/testPost'].post
  update:
    x-apievangelist-phrasing:
      intent: Call the test POST resource
      effect: write
      questions:
      - Is there a test POST endpoint for trying out form submissions?
      - Can I post test parameters with a JSONP callback?
      instructions:
      - text: Post to the test resource with param1 {param1} and param2 {param2}.
        slots:
          param1: requestBody.param1
          param2: requestBody.param2
      - text: Send a test POST of type {type} with callback {callback}.
        slots:
          type: requestBody.type
          callback: requestBody.callback
      method: generated
      generated: '2026-09-26'