Microsoft Entra ID (formerly Azure AD) · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Groups Group Settings.group Setting API

7 actions 7 updates phrasing extends openapi/azure-ad-groupsettings-groupsetting-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Microsoft Entra ID (formerly Azure AD)'s API. It is a proposal applied on top of the contract, not a document Microsoft Entra ID (formerly Azure AD) publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/groupSettings'].get
$.paths['/groupSettings'].post
$.paths['/groupSettings/{groupSetting-id}'].get
$.paths['/groupSettings/{groupSetting-id}'].delete
$.paths['/groupSettings/{groupSetting-id}'].patch
$.paths['/groupSettings/$count'].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 Groups Group Settings.group Setting API
  version: 1.0.0
extends: openapi/azure-ad-groupsettings-groupsetting-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: 6
- target: $.paths['/groupSettings'].get
  update:
    x-apievangelist-phrasing:
      intent: List group settings
      effect: read
      questions:
      - Which tenant-wide and group-specific settings objects exist?
      - Can I filter the list of group settings?
      instructions:
      - text: List all group settings in the tenant.
      - text: Show group settings matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groupSettings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create group settings from a template
      effect: write
      questions:
      - How do I create a tenant-wide group setting from a settings template?
      - Can I supply name-value pairs when creating a new group setting?
      instructions:
      - text: Create a group setting from template {template} with values {values}.
        slots:
          template: requestBody.templateId
          values: requestBody.values
      - text: Create group setting {name} based on template {template}.
        slots:
          name: requestBody.displayName
          template: requestBody.templateId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groupSettings/{groupSetting-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a group setting
      effect: read
      questions:
      - How do I look up a single group setting by ID?
      - What values are stored in a specific group settings object?
      instructions:
      - text: Get group setting {setting}.
        slots:
          setting: path.groupSetting-id
      - text: Show the values of group setting {setting}.
        slots:
          setting: path.groupSetting-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groupSettings/{groupSetting-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a group setting
      effect: destructive
      questions:
      - How do I delete a tenant-level or group-specific setting?
      - Can I delete a group setting only when its ETag matches?
      instructions:
      - text: Delete group setting {setting}.
        slots:
          setting: path.groupSetting-id
      - text: Remove group setting {setting} if the ETag is {etag}.
        slots:
          setting: path.groupSetting-id
          etag: header.If-Match
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groupSettings/{groupSetting-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a group setting
      effect: write
      questions:
      - How do I change the values of an existing group setting?
      - Can I rename a group settings object I already created?
      instructions:
      - text: Update group setting {setting} with values {values}.
        slots:
          setting: path.groupSetting-id
          values: requestBody.values
      - text: Change the display name of group setting {setting} to {name}.
        slots:
          setting: path.groupSetting-id
          name: requestBody.displayName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groupSettings/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count group settings
      effect: read
      questions:
      - How many group settings objects are there in the tenant?
      - Can I count group settings matching a filter?
      instructions:
      - text: Count the group settings in the tenant.
      - text: Count group settings matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'