Cumulocity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cumulocity User Current User API

3 actions 3 updates phrasing extends openapi/cumulocity-current-user-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['/user/currentUser'].get
$.paths['/user/currentUser'].put

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 Current User API
  version: 1.0.0
extends: openapi/cumulocity-current-user-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['/user/currentUser'].get
  update:
    x-apievangelist-phrasing:
      intent: Show the signed-in user's profile
      effect: read
      questions:
      - Who am I logged in as, and what roles do I have?
      - How do I read my own user profile?
      instructions:
      - text: Show my user profile.
      - text: Get the roles and groups of the current user.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user/currentUser'].put
  update:
    x-apievangelist-phrasing:
      intent: Update my own user profile
      effect: write
      questions:
      - How do I change my own password or email?
      - Can I update my display name and phone number myself?
      instructions:
      - text: Change my email to {email}.
        slots:
          email: requestBody.email
      - text: Set my display name to {displayName} and phone to {phone}.
        slots:
          displayName: requestBody.displayName
          phone: requestBody.phone
      method: generated
      generated: '2026-10-01'