dotCMS · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for dotCMS REST System Logging API

4 actions 4 updates phrasing extends openapi/dotcms-system-logging-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/logger'].get
$.paths['/api/v1/logger'].put
$.paths['/api/v1/logger/{loggerName}'].get

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 System Logging API
  version: 1.0.0
extends: openapi/dotcms-system-logging-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/logger'].get
  update:
    x-apievangelist-phrasing:
      intent: List loggers and their levels
      effect: read
      questions:
      - Which loggers are configured and at what level?
      - Can I see all log levels on the server?
      instructions:
      - text: List all loggers.
      - text: Show every logger with its current level.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/logger'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a logger's level
      effect: write
      questions:
      - How do I turn on debug logging for one class without a restart?
      - Can I change a logger's level at runtime?
      instructions:
      - text: Set logger {name} to level {level}.
        slots:
          name: requestBody.name
          level: requestBody.level
      - text: Change the log level of {name} to {level}.
        slots:
          name: requestBody.name
          level: requestBody.level
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/logger/{loggerName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one logger's level
      effect: read
      questions:
      - What level is a particular logger set to?
      - Is debug enabled for a specific logger?
      instructions:
      - text: Get logger {loggerName}.
        slots:
          loggerName: path.loggerName
      - text: Show the level of logger {loggerName}.
        slots:
          loggerName: path.loggerName
      method: generated
      generated: '2026-09-26'