Archbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Archbee Public File Manager API

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

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/file-manager/file'].delete
$.paths['/file-manager/files'].get
$.paths['/file-manager/move'].post
$.paths['/file-manager/replace'].post
$.paths['/upload/file'].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 Archbee Public File Manager API
  version: 1.0.0
extends: openapi/archbee-file-manager-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['/file-manager/file'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a file or folder from the File Manager
      effect: destructive
      questions:
      - How do I delete an uploaded asset from the File Manager?
      - Does deleting a File Manager folder also remove everything inside it?
      instructions:
      - text: Delete File Manager file {fileId}.
        slots:
          fileId: requestBody.fileId
      - text: Remove folder {fileId} and all of its contents from the File Manager.
        slots:
          fileId: requestBody.fileId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/file-manager/files'].get
  update:
    x-apievangelist-phrasing:
      intent: List files and folders in the File Manager
      effect: read
      questions:
      - What images and files have been uploaded to my File Manager?
      - Can I list only the images inside one folder?
      - How do I find an uploaded asset by part of its filename?
      instructions:
      - text: List all files in the File Manager.
      - text: List the contents of File Manager folder {parentId}.
        slots:
          parentId: query.parentId
      - text: Find File Manager files named like {searchQuery}.
        slots:
          searchQuery: query.searchQuery
      method: generated
      generated: '2026-09-26'
- target: $.paths['/file-manager/move'].post
  update:
    x-apievangelist-phrasing:
      intent: Move a File Manager file to another folder
      effect: write
      questions:
      - How do I move an uploaded image into a different folder?
      - Can I move a File Manager folder back to the root?
      instructions:
      - text: Move File Manager file {fileId} into folder {newParentId}.
        slots:
          fileId: requestBody.fileId
          newParentId: requestBody.newParentId
      - text: Relocate folder {fileId} under {newParentId}.
        slots:
          fileId: requestBody.fileId
          newParentId: requestBody.newParentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/file-manager/replace'].post
  update:
    x-apievangelist-phrasing:
      intent: Replace an existing File Manager file
      effect: write
      questions:
      - How do I swap out an image everywhere it's embedded without changing its URL?
      - Does overwriting a file keep the same id and public link?
      instructions:
      - text: Overwrite File Manager file {fileId} with {file}.
        slots:
          fileId: requestBody.fileId
          file: requestBody.file
      - text: Replace the contents of existing asset {fileId} with the new upload {file}.
        slots:
          fileId: requestBody.fileId
          file: requestBody.file
      method: generated
      generated: '2026-09-26'
- target: $.paths['/upload/file'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a new file to the File Manager
      effect: write
      questions:
      - How do I upload a new file to the Archbee File Manager?
      - Can I make a newly uploaded file publicly accessible by link?
      instructions:
      - text: Upload {file} to the File Manager.
        slots:
          file: requestBody.file
      - text: Upload {file} as a new asset with public access set to {isPublic}.
        slots:
          file: requestBody.file
          isPublic: requestBody.isPublic
      method: generated
      generated: '2026-09-26'