dotCMS · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for dotCMS REST Tail Log API

3 actions 3 updates phrasing extends openapi/dotcms-taillog-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/logs/{fileName}/_tail'].get

$.paths['/api/v1/logs'].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 Tail Log API
  version: 1.0.0
extends: openapi/dotcms-taillog-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/logs/{fileName}/_tail'].get
  update:
    x-apievangelist-phrasing:
      intent: Tail a server log file
      effect: read
      questions:
      - How do I tail a dotCMS log file from the API?
      - Can I choose how many lines back to start tailing a log?
      instructions:
      - text: Tail log file {fileName}.
        slots:
          fileName: path.fileName
      - text: Show the last {linesBack} lines of {fileName}.
        slots:
          linesBack: query.linesBack
          fileName: path.fileName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: List available log files
      effect: read
      questions:
      - Which log files can I tail?
      - What log file names are available in the log folder?
      instructions:
      - text: List the available log files.
      - text: Show the log file names I can tail or download.
      method: generated
      generated: '2026-09-26'