Netlify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Netlify's API documentation Asset API

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

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/sites/{site_id}/assets'].get
$.paths['/sites/{site_id}/assets'].post
$.paths['/sites/{site_id}/assets/{asset_id}'].get
$.paths['/sites/{site_id}/assets/{asset_id}'].put
$.paths['/sites/{site_id}/assets/{asset_id}'].delete

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 Netlify's API documentation Asset API
  version: 1.0.0
extends: openapi/netlify-asset-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['/sites/{site_id}/assets'].get
  update:
    x-apievangelist-phrasing:
      intent: List a site's uploaded assets
      effect: read
      questions:
      - What assets have been uploaded to my site?
      - Can I see every stored asset for a site?
      instructions:
      - text: List assets for site {site}.
        slots:
          site: path.site_id
      - text: Show all uploaded assets on site {site}.
        slots:
          site: path.site_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/assets'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an asset upload for a site
      effect: write
      questions:
      - How do I upload a file as a site asset?
      - Can I make an uploaded asset public or private?
      instructions:
      - text: Create asset {name} of {size} bytes and type {content_type} on site {site}.
        slots:
          name: query.name
          size: query.size
          content_type: query.content_type
          site: path.site_id
      - text: Upload {name} ({content_type}, {size} bytes) to site {site} with visibility {visibility}.
        slots:
          name: query.name
          content_type: query.content_type
          size: query.size
          site: path.site_id
          visibility: query.visibility
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/assets/{asset_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a site asset's details
      effect: read
      questions:
      - Can I check the details of one uploaded asset?
      - What state is my asset upload in?
      instructions:
      - text: Get info for asset {asset} on site {site}.
        slots:
          site: path.site_id
          asset: path.asset_id
      - text: Show the upload state of asset {asset} on site {site}.
        slots:
          site: path.site_id
          asset: path.asset_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/assets/{asset_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a site asset's state
      effect: write
      questions:
      - How do I mark an asset upload as finished?
      - Can I change the state of an uploaded asset?
      instructions:
      - text: Set asset {asset} on site {site} to state {state}.
        slots:
          asset: path.asset_id
          site: path.site_id
          state: query.state
      - text: Mark asset {asset} of site {site} as {state}.
        slots:
          asset: path.asset_id
          site: path.site_id
          state: query.state
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/assets/{asset_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a site asset
      effect: destructive
      questions:
      - How do I delete an uploaded asset?
      - Can I remove one file from my site's assets?
      instructions:
      - text: Delete asset {asset} from site {site}.
        slots:
          site: path.site_id
          asset: path.asset_id
      - text: Remove uploaded asset {asset} on site {site}.
        slots:
          site: path.site_id
          asset: path.asset_id
      method: generated
      generated: '2026-09-26'