Cumulocity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cumulocity Tenant Tenants API

6 actions 6 updates phrasing extends openapi/cumulocity-tenants-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['/tenant/tenants'].get

$.paths['/tenant/tenants'].post

$.paths['/tenant/tenants/{tenantId}'].get

$.paths['/tenant/tenants/{tenantId}'].put

$.paths['/tenant/tenants/{tenantId}'].delete

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 Tenant Tenants API
  version: 1.0.0
extends: openapi/cumulocity-tenants-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['/tenant/tenants'].get
  update:
    x-apievangelist-phrasing:
      intent: List subtenants
      effect: read
      questions:
      - Which subtenants exist under my enterprise tenant?
      - What customer tenants have I created?
      instructions:
      - text: List all tenants.
      - text: Show every subtenant I manage.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tenant/tenants'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a subtenant
      effect: write
      questions:
      - How do I create a new customer tenant with its own admin?
      - Can I set the domain and admin email when creating a tenant?
      instructions:
      - text: Create a tenant for {company} on domain {domain}.
        slots:
          company: requestBody.company
          domain: requestBody.domain
      - text: Create tenant {company} with admin {adminName} at {adminEmail}.
        slots:
          company: requestBody.company
          adminName: requestBody.adminName
          adminEmail: requestBody.adminEmail
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tenant/tenants/{tenantId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one tenant
      effect: read
      questions:
      - How do I see the details of one subtenant?
      - What domain and status does a given tenant have?
      instructions:
      - text: Show me tenant {tenantId}.
        slots:
          tenantId: path.tenantId
      - text: Get the domain, status and contact of tenant {tenantId}.
        slots:
          tenantId: path.tenantId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tenant/tenants/{tenantId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a tenant's details
      effect: write
      questions:
      - Can I suspend a subtenant or change its contact details?
      - How do I update the company name on a tenant?
      instructions:
      - text: Set the status of tenant {tenantId} to {status}.
        slots:
          tenantId: path.tenantId
          status: requestBody.status
      - text: Change the contact of tenant {tenantId} to {contactName}, {contactPhone}.
        slots:
          tenantId: path.tenantId
          contactName: requestBody.contactName
          contactPhone: requestBody.contactPhone
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tenant/tenants/{tenantId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tenant
      effect: destructive
      questions:
      - How do I permanently remove a subtenant?
      - Can I delete a customer tenant that's been closed?
      instructions:
      - text: Delete tenant {tenantId}.
        slots:
          tenantId: path.tenantId
      - text: Remove subtenant {tenantId} permanently.
        slots:
          tenantId: path.tenantId
      method: generated
      generated: '2026-10-01'