Contentstack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Contentstack Assets API

4 actions 4 updates phrasing extends openapi/contentstack-assets-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Contentstack's API. It is a proposal applied on top of the contract, not a document Contentstack publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/assets'].get
$.paths['/assets'].post
$.paths['/assets/{asset_uid}'].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 Contentstack Assets API
  version: 1.0.0
extends: openapi/contentstack-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: 3
- target: $.paths['/assets'].get
  update:
    x-apievangelist-phrasing:
      intent: List published assets
      effect: read
      questions:
      - How do I list all images and files in my Contentstack stack?
      - Can I page through assets and get a total count?
      instructions:
      - text: List the published assets in stack {api_key}.
        slots:
          api_key: header.api_key
      - text: Get {limit} assets from stack {api_key} starting after {skip}.
        slots:
          limit: query.limit
          api_key: header.api_key
          skip: query.skip
      method: generated
      generated: '2026-09-26'
- target: $.paths['/assets'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload an asset file
      effect: write
      questions:
      - How do I upload an image or PDF to my stack?
      - Can I set a title and description when uploading a file?
      instructions:
      - text: Upload file {file} to stack {api_key}.
        slots:
          file: requestBody.asset[upload]
          api_key: header.api_key
      - text: Upload {file} to stack {api_key} titled {title} with description {description}.
        slots:
          file: requestBody.asset[upload]
          api_key: header.api_key
          title: requestBody.asset[title]
          description: requestBody.asset[description]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/assets/{asset_uid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one asset's details
      effect: read
      questions:
      - How do I get the file URL and size of a specific asset?
      - What are the dimensions of an image asset?
      instructions:
      - text: Get asset {asset}.
        slots:
          asset: path.asset_uid
      - text: Show the URL, dimensions and file size of asset {asset} in stack {api_key}.
        slots:
          asset: path.asset_uid
          api_key: header.api_key
      method: generated
      generated: '2026-09-26'