Dynatrace · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Dynatrace Account Management Groups API

6 actions 6 updates phrasing extends openapi/dynatrace-groups-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Dynatrace's API. It is a proposal applied on top of the contract, not a document Dynatrace publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/iam/v1/accounts/{accountUuid}/groups'].get

$.paths['/iam/v1/accounts/{accountUuid}/groups'].post

$.paths['/iam/v1/accounts/{accountUuid}/groups/{groupId}'].get

$.paths['/iam/v1/accounts/{accountUuid}/groups/{groupId}'].put

$.paths['/iam/v1/accounts/{accountUuid}/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 Dynatrace Account Management Groups API
  version: 1.0.0
extends: openapi/dynatrace-groups-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/iam/v1/accounts/{accountUuid}/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List user groups in an account
      effect: read
      questions:
      - Which groups control access and permissions in my account?
      - Can I page through user groups when there are hundreds?
      instructions:
      - text: List the user groups in account {account}.
        slots:
          account: path.accountUuid
      - text: Show {size} groups per page for account {account}.
        slots:
          size: query.pageSize
          account: path.accountUuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v1/accounts/{accountUuid}/groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a user group
      effect: write
      questions:
      - How do I create a new group so I can grant a team access?
      - Can I give a new group a description when I create it?
      instructions:
      - text: Create a group named {name} in account {account}.
        slots:
          name: requestBody.name
          account: path.accountUuid
      - text: Add a new group {name} described as {description} to {account}.
        slots:
          name: requestBody.name
          description: requestBody.description
          account: path.accountUuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v1/accounts/{accountUuid}/groups/{groupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a group's details and permissions
      effect: read
      questions:
      - What permissions has a specific group been assigned?
      - Can I look up one group's name and description by ID?
      instructions:
      - text: Get group {group} in account {account}.
        slots:
          group: path.groupId
          account: path.accountUuid
      - text: Show the permissions assigned to group {group} on {account}.
        slots:
          group: path.groupId
          account: path.accountUuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v1/accounts/{accountUuid}/groups/{groupId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a group's name and description
      effect: write
      questions:
      - Can I change a group's description without touching its permissions?
      - Where do I rename an existing group?
      instructions:
      - text: Update group {group} in {account} to name {name}.
        slots:
          group: path.groupId
          account: path.accountUuid
          name: requestBody.name
      - text: Change group {group} on account {account} to {name} with description {description}.
        slots:
          group: path.groupId
          account: path.accountUuid
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v1/accounts/{accountUuid}/groups/{groupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Permanently delete a group
      effect: destructive
      questions:
      - Do users lose access when their group is permanently deleted?
      - Can I permanently remove a group I no longer need?
      instructions:
      - text: Permanently delete group {group} from account {account}.
        slots:
          group: path.groupId
          account: path.accountUuid
      - text: Remove group {group} from {account} for good.
        slots:
          group: path.groupId
          account: path.accountUuid
      method: generated
      generated: '2026-09-26'