dotCMS · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for dotCMS REST File Assets API

6 actions 6 updates phrasing extends openapi/dotcms-file-assets-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 6

$.info

$.paths['/api/v1/content/fileassets/{inode}/resourcelink'].get

$.paths['/api/v2/assets/{identifier}'].get

$.paths['/api/v2/assets'].get

$.paths['/api/v2/assets/publish'].put

$.paths['/api/v2/assets/save'].put

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 File Assets API
  version: 1.0.0
extends: openapi/dotcms-file-assets-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: 5
- target: $.paths['/api/v1/content/fileassets/{inode}/resourcelink'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the resource link for a file asset
      effect: read
      questions:
      - What is the public link to a file asset I uploaded?
      - Can I get a file asset's resource URL from its inode?
      instructions:
      - text: Get the resource link for file asset {inode}.
        slots:
          inode: path.inode
      - text: Show the URL where file {inode} is served.
        slots:
          inode: path.inode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/assets/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a file asset by identifier
      effect: read
      questions:
      - How do I download the raw bytes of a file asset using its identifier?
      - Can I fetch the live published copy of a file instead of the working one?
      instructions:
      - text: Download file asset {identifier}.
        slots:
          identifier: path.identifier
      - text: Download the {version} version of file {identifier} in language {language}.
        slots:
          version: query.version
          identifier: path.identifier
          language: query.language
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/assets'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a file asset by site path
      effect: read
      questions:
      - Can I download a file by its host and folder path, like //mysite/images/logo.png?
      - What happens if the file path I request doesn't exist?
      instructions:
      - text: Download the file at {path}.
        slots:
          path: query.path
      - text: Get the live version of file {path}.
        slots:
          path: query.path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/assets/publish'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload and publish a file asset
      effect: write
      questions:
      - How do I upload a file and make it live immediately?
      - Can I replace a published image and push it live in one step?
      instructions:
      - text: Upload this file to the given host path and publish it live.
      - text: Replace the published file at that path with this upload and make it live.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/assets/save'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload a file asset as a draft
      effect: write
      questions:
      - Can I upload a new version of a file without changing what's live?
      - How do I save a file asset as a working draft only?
      instructions:
      - text: Save this file to the host path as a working draft without publishing.
      - text: Upload a new working version of the file and leave the live one alone.
      method: generated
      generated: '2026-09-26'