Cumulocity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cumulocity Application Applications API

6 actions 6 updates phrasing extends openapi/cumulocity-applications-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 6

$.info
$.paths['/application/applications'].get
$.paths['/application/applications'].post
$.paths['/application/applications/{id}'].get
$.paths['/application/applications/{id}'].put
$.paths['/application/applications/{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 Cumulocity Application Applications API
  version: 1.0.0
extends: openapi/cumulocity-applications-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: 5
- target: $.paths['/application/applications'].get
  update:
    x-apievangelist-phrasing:
      intent: List applications in the tenant
      effect: read
      questions:
      - Which applications and microservices are available in my tenant?
      - What apps are installed on my Cumulocity tenant?
      instructions:
      - text: List all applications.
      - text: Show every application available to my tenant.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/application/applications'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a new application
      effect: write
      questions:
      - How do I register a new web app or microservice in Cumulocity?
      - Can I set the context path and required roles when creating an application?
      instructions:
      - text: Create an application named {name} with key {key} of type {type}.
        slots:
          name: requestBody.name
          key: requestBody.key
          type: requestBody.type
      - text: Register a new {availability} application {name} at context path {contextPath}.
        slots:
          availability: requestBody.availability
          name: requestBody.name
          contextPath: requestBody.contextPath
      method: generated
      generated: '2026-10-01'
- target: $.paths['/application/applications/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one application by ID
      effect: read
      questions:
      - How do I get the details of a specific application?
      - What is the context path and availability of one application?
      instructions:
      - text: Show me application {id}.
        slots:
          id: path.id
      - text: Get the manifest and required roles of application {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/application/applications/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an application's settings
      effect: write
      questions:
      - Can I rename an existing application or change its availability?
      - How do I update the required roles on an application?
      instructions:
      - text: Rename application {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set the availability of application {id} to {availability}.
        slots:
          id: path.id
          availability: requestBody.availability
      method: generated
      generated: '2026-10-01'
- target: $.paths['/application/applications/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an application
      effect: destructive
      questions:
      - How do I remove an application from my tenant entirely?
      - Can I delete a microservice application I no longer use?
      instructions:
      - text: Delete application {id}.
        slots:
          id: path.id
      - text: Remove the application with ID {id} from the tenant.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'