Cumulocity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cumulocity User Groups API

6 actions 6 updates phrasing extends openapi/cumulocity-groups-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['/user/{tenantId}/groups'].get

$.paths['/user/{tenantId}/groups'].post

$.paths['/user/{tenantId}/groups/{groupId}'].get

$.paths['/user/{tenantId}/groups/{groupId}'].put

$.paths['/user/{tenantId}/groups/{groupId}'].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 User Groups API
  version: 1.0.0
extends: openapi/cumulocity-groups-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['/user/{tenantId}/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List user groups in a tenant
      effect: read
      questions:
      - Which user groups exist in my tenant?
      - What permission groups can I assign users to?
      instructions:
      - text: List the user groups in tenant {tenantId}.
        slots:
          tenantId: path.tenantId
      - text: Show all groups defined for tenant {tenantId}.
        slots:
          tenantId: path.tenantId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user/{tenantId}/groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a user group
      effect: write
      questions:
      - How do I create a new user group with its own roles?
      - Can I add users and roles to a group at the moment I create it?
      instructions:
      - text: Create group {name} in tenant {tenantId}.
        slots:
          name: requestBody.name
          tenantId: path.tenantId
      - text: Create group {name} in tenant {tenantId} with roles {roles}.
        slots:
          name: requestBody.name
          tenantId: path.tenantId
          roles: requestBody.roles
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user/{tenantId}/groups/{groupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one user group
      effect: read
      questions:
      - How do I see which roles and users belong to one group?
      - What does a specific user group grant?
      instructions:
      - text: Show group {groupId} in tenant {tenantId}.
        slots:
          groupId: path.groupId
          tenantId: path.tenantId
      - text: Get the roles and members of group {groupId} in tenant {tenantId}.
        slots:
          groupId: path.groupId
          tenantId: path.tenantId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user/{tenantId}/groups/{groupId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a user group
      effect: write
      questions:
      - Can I rename a user group or change its description?
      - How do I change the roles assigned to an existing group?
      instructions:
      - text: Rename group {groupId} in tenant {tenantId} to {name}.
        slots:
          groupId: path.groupId
          tenantId: path.tenantId
          name: requestBody.name
      - text: Set the roles of group {groupId} in tenant {tenantId} to {roles}.
        slots:
          groupId: path.groupId
          tenantId: path.tenantId
          roles: requestBody.roles
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user/{tenantId}/groups/{groupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user group
      effect: destructive
      questions:
      - How do I delete a user group that is no longer used?
      - Can I remove a permission group from a tenant?
      instructions:
      - text: Delete group {groupId} from tenant {tenantId}.
        slots:
          groupId: path.groupId
          tenantId: path.tenantId
      - text: Remove user group {groupId} in tenant {tenantId}.
        slots:
          groupId: path.groupId
          tenantId: path.tenantId
      method: generated
      generated: '2026-10-01'