dotCMS · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for dotCMS REST Temporary Files API

3 actions 3 updates phrasing extends openapi/dotcms-temporary-files-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/temp/byUrl'].post
$.paths['/api/v1/temp'].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 Temporary Files API
  version: 1.0.0
extends: openapi/dotcms-temporary-files-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/temp/byUrl'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a temporary file from a URL
      effect: write
      questions:
      - Can I pull a file from a remote URL into dotCMS to attach to content?
      - Is there a size limit or timeout when fetching a file by URL?
      instructions:
      - text: Create a temp file from {remoteUrl}.
        slots:
          remoteUrl: requestBody.remoteUrl
      - text: Download {remoteUrl} as temp file {fileName} with a {urlTimeoutSeconds}-second timeout.
        slots:
          remoteUrl: requestBody.remoteUrl
          fileName: requestBody.fileName
          urlTimeoutSeconds: requestBody.urlTimeoutSeconds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/temp'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload temporary files
      effect: write
      questions:
      - How do I upload files from my computer to use when creating content?
      - Can I cap the size of temporary file uploads?
      instructions:
      - text: Upload these files as temporary files.
      - text: Upload my files as temp resources with a max size of {maxFileLength}.
        slots:
          maxFileLength: query.maxFileLength
      method: generated
      generated: '2026-09-26'