Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Optimizely CMP Open API Documentation Uploader API

5 actions 5 updates phrasing extends openapi/optimizely-uploader-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Optimizely's API. It is a proposal applied on top of the contract, not a document Optimizely publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/upload-url'].get

$.paths['/multipart-uploads'].post

$.paths['/multipart-uploads/{id}/status'].get

$.paths['/multipart-uploads/{id}/complete'].post

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 Optimizely CMP Open API Documentation Uploader API
  version: 1.0.0
extends: openapi/optimizely-uploader-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: 4
- target: $.paths['/upload-url'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a presigned URL to upload a file
      effect: read
      questions:
      - How do I get a presigned URL for uploading a single file?
      - How long is an upload URL valid before it expires?
      instructions:
      - text: Get a presigned upload URL for a file.
      - text: Give me a one-time upload URL and its meta fields for a single file.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/multipart-uploads'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a multipart upload for a large file
      effect: write
      questions:
      - How do I upload a very large file in parts?
      - Can I choose the part size when starting a multipart upload?
      instructions:
      - text: Start a multipart upload for a file of {file_size} bytes.
        slots:
          file_size: requestBody.file_size
      - text: Create multipart upload URLs for a {file_size}-byte file split into {part_size}-byte parts.
        slots:
          file_size: requestBody.file_size
          part_size: requestBody.part_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/multipart-uploads/{id}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a multipart upload's status
      effect: read
      questions:
      - How do I check the progress of a multipart upload?
      - Has my large-file multipart upload finished processing yet?
      instructions:
      - text: Get the status of multipart upload {id}.
        slots:
          id: path.id
      - text: Check whether multipart upload {id} is complete.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/multipart-uploads/{id}/complete'].post
  update:
    x-apievangelist-phrasing:
      intent: Finish a multipart upload
      effect: write
      questions:
      - What do I call after all parts of a large file are uploaded?
      - Can I finalize a multipart upload once every part is in?
      instructions:
      - text: Complete multipart upload {id}.
        slots:
          id: path.id
      - text: Finalize multipart upload {id} now that all parts are uploaded.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'