# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Schema Registry Field groups API
  version: 1.0.0
extends: openapi/adobe-suite-field-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: 6
- target: $.paths['/{CONTAINER_ID}/fieldgroups'].get
  update:
    x-apievangelist-phrasing:
      intent: List XDM field groups in a container
      effect: read
      questions:
      - Which schema field groups are available in the global or tenant container?
      - Can I sort and page through the field groups in the Schema Registry?
      instructions:
      - text: List the field groups in the {CONTAINER_ID} container.
        slots:
          CONTAINER_ID: path.CONTAINER_ID
      - text: List {limit} field groups from {CONTAINER_ID} ordered by {orderby}.
        slots:
          CONTAINER_ID: path.CONTAINER_ID
          limit: query.limit
          orderby: query.orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{CONTAINER_ID}/fieldgroups/{FIELD_GROUP_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one XDM field group
      effect: read
      questions:
      - How do I look at the fields defined in a specific field group?
      - Can I retrieve a field group by its meta:altId?
      instructions:
      - text: Show field group {FIELD_GROUP_ID} from the {CONTAINER_ID} container.
        slots:
          FIELD_GROUP_ID: path.FIELD_GROUP_ID
          CONTAINER_ID: path.CONTAINER_ID
      - text: Get the definition of field group {FIELD_GROUP_ID} in {CONTAINER_ID}.
        slots:
          FIELD_GROUP_ID: path.FIELD_GROUP_ID
          CONTAINER_ID: path.CONTAINER_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenant/fieldgroups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom field group
      effect: write
      questions:
      - How do I add my own custom field group to extend an XDM schema class?
      - What must the payload include to create a tenant field group?
      instructions:
      - text: 'Create a custom field group from this definition: {body}.'
        slots:
          body: body.body
      - text: Add a new tenant field group using the payload {body}.
        slots:
          body: body.body
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenant/fieldgroups/{FIELD_GROUP_ID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a custom field group entirely
      effect: write
      questions:
      - Can I rewrite a whole custom field group in one request?
      - Does a full replace of a field group need every field it was created with?
      instructions:
      - text: Replace field group {FIELD_GROUP_ID} with the full definition {body}.
        slots:
          FIELD_GROUP_ID: path.FIELD_GROUP_ID
          body: body.body
      - text: Rewrite custom field group {FIELD_GROUP_ID} entirely using {body}.
        slots:
          FIELD_GROUP_ID: path.FIELD_GROUP_ID
          body: body.body
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenant/fieldgroups/{FIELD_GROUP_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom field group
      effect: destructive
      questions:
      - How do I delete a custom field group I created?
      - What does the Schema Registry return after a field group is removed?
      instructions:
      - text: Delete custom field group {FIELD_GROUP_ID}.
        slots:
          FIELD_GROUP_ID: path.FIELD_GROUP_ID
      - text: Remove field group {FIELD_GROUP_ID} from my tenant.
        slots:
          FIELD_GROUP_ID: path.FIELD_GROUP_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenant/fieldgroups/{FIELD_GROUP_ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch attributes of a custom field group
      effect: write
      questions:
      - Can I add or replace just one attribute of a field group with JSON Patch?
      - Which JSON Patch operations does the field group update support?
      instructions:
      - text: Apply the JSON Patch {body} to field group {FIELD_GROUP_ID}.
        slots:
          FIELD_GROUP_ID: path.FIELD_GROUP_ID
          body: body.body
      - text: Change only the title of field group {FIELD_GROUP_ID} using patch {body}.
        slots:
          FIELD_GROUP_ID: path.FIELD_GROUP_ID
          body: body.body
      method: generated
      generated: '2026-09-26'