Cumulocity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cumulocity User Roles API

2 actions 2 updates phrasing extends openapi/cumulocity-roles-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 2

$.info
$.paths['/user/roles'].get

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 User Roles API
  version: 1.0.0
extends: openapi/cumulocity-roles-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: 1
- target: $.paths['/user/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List global user roles
      effect: read
      questions:
      - Which roles can I assign to users and groups?
      - What global permissions exist in the platform?
      instructions:
      - text: List all global roles.
      - text: Show every assignable user role.
      method: generated
      generated: '2026-10-01'