Cumulocity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cumulocity Application Application Binaries API

3 actions 3 updates phrasing extends openapi/cumulocity-application-binaries-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/application/applications/{id}/binaries'].get

$.paths['/application/applications/{id}/binaries'].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 Cumulocity Application Application Binaries API
  version: 1.0.0
extends: openapi/cumulocity-application-binaries-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/application/applications/{id}/binaries'].get
  update:
    x-apievangelist-phrasing:
      intent: List an application's uploaded builds
      effect: read
      questions:
      - Which build archives have been uploaded for an application?
      - What versions of a microservice binary are stored?
      instructions:
      - text: List the binaries of application {id}.
        slots:
          id: path.id
      - text: Show uploaded build archives for application {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/application/applications/{id}/binaries'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a build for an application
      effect: write
      questions:
      - How do I deploy a new zip of my web app or microservice?
      - Can I upload a new build archive to an existing application?
      instructions:
      - text: Upload {file} as a new build of application {id}.
        slots:
          file: requestBody.file
          id: path.id
      - text: Deploy archive {file} to application {id}.
        slots:
          file: requestBody.file
          id: path.id
      method: generated
      generated: '2026-10-01'