dotCMS · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for dotCMS REST System Storage API

3 actions 3 updates phrasing extends openapi/dotcms-system-storage-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/storages/hello'].get

$.paths['/api/v1/storages/chain/_replicate/{from}/to/{to}'].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 System Storage API
  version: 1.0.0
extends: openapi/dotcms-system-storage-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/storages/hello'].get
  update:
    x-apievangelist-phrasing:
      intent: Ping the storage service
      effect: read
      questions:
      - Is the dotCMS storage API responding?
      - Can I do a quick hello check against the storage endpoints?
      instructions:
      - text: Ping the storage service.
      - text: Say hello to the storage API to confirm it's up.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/storages/chain/_replicate/{from}/to/{to}'].get
  update:
    x-apievangelist-phrasing:
      intent: Replicate one storage to another
      effect: write
      questions:
      - How do I copy binaries from one storage provider to another in the chain?
      - Can I replicate file system storage into a database storage?
      instructions:
      - text: Replicate storage {from} to {to}.
        slots:
          from: path.from
          to: path.to
      - text: Copy everything in the {from} storage into {to}.
        slots:
          from: path.from
          to: path.to
      method: generated
      generated: '2026-09-26'