API Evangelist conversational phrasing for Adobe Analytics Component Meta Data API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Adobe Analytics Component Meta Data API
  version: 1.0.0
extends: openapi/adobe-suite-component-meta-data-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: 16
- target: $.paths['/{globalCompanyId}/componentmetadata/shares'].get
  update:
    x-apievangelist-phrasing:
      intent: List components a user has shared out
      effect: read
      questions:
      - Which segments and projects have I shared with other people?
      - Can I list the shares a particular user has created, page by page?
      instructions:
      - text: List the components I have shared out in company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
      - text: Show the shares created by user {userid} in {globalCompanyId}.
        slots:
          userid: query.userid
          globalCompanyId: path.globalCompanyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{globalCompanyId}/componentmetadata/shares'].put
  update:
    x-apievangelist-phrasing:
      intent: Overwrite who analytics components are shared with
      effect: destructive
      questions:
      - Can I set the full share list for segments or other components in one call?
      - Does updating component shares wipe out the existing shares first?
      instructions:
      - text: Replace the shares on my components in company {globalCompanyId} with the list I give you.
        slots:
          globalCompanyId: path.globalCompanyId
      - text: Reset sharing for these components in {globalCompanyId} so only the users I name have access.
        slots:
          globalCompanyId: path.globalCompanyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/componentmetadata/shares'].post
  update:
    x-apievangelist-phrasing:
      intent: Share a segment or project with someone
      effect: write
      questions:
      - How do I share one segment with a single colleague without touching its other shares?
      - Can I share a project with everyone in my organization at once?
      instructions:
      - text: Share {componentType} {componentId} with user {shareToId} in company {globalCompanyId}.
        slots:
          componentType: requestBody.componentType
          componentId: requestBody.componentId
          shareToId: requestBody.shareToId
          globalCompanyId: path.globalCompanyId
      - text: Add a {shareToType} share for component {componentId} in {globalCompanyId}, keeping existing shares.
        slots:
          shareToType: requestBody.shareToType
          componentId: requestBody.componentId
          globalCompanyId: path.globalCompanyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{globalCompanyId}/componentmetadata/shares/component/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search shares for specific components
      effect: read
      questions:
      - Who has a given segment or calculated metric been shared with?
      - Can I look up the shares for a list of component IDs of one type?
      instructions:
      - text: Find the shares on {componentType} components {componentIds} in {globalCompanyId}.
        slots:
          componentType: requestBody.componentType
          componentIds: requestBody.componentIds
          globalCompanyId: path.globalCompanyId
      - text: Search component shares in {globalCompanyId}, page {page} with {limit} per page.
        slots:
          globalCompanyId: path.globalCompanyId
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/componentmetadata/shares/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a component share by ID
      effect: read
      questions:
      - What does one component share record contain?
      - Can I look up the details of a share if I have its share ID?
      instructions:
      - text: Get share {id} in company {globalCompanyId}.
        slots:
          id: path.id
          globalCompanyId: path.globalCompanyId
      - text: Show me the details of component share {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/componentmetadata/shares/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a component share
      effect: destructive
      questions:
      - Can I delete a share so it is removed from every component it was on?
      - How do I revoke a single component share by its share ID?
      instructions:
      - text: Delete share {id} in company {globalCompanyId}.
        slots:
          id: path.id
          globalCompanyId: path.globalCompanyId
      - text: Revoke component share {id} from all its components.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/componentmetadata/shares/sharedto/me'].get
  update:
    x-apievangelist-phrasing:
      intent: List components shared with me
      effect: read
      questions:
      - Which segments have other people shared with me in Adobe Analytics?
      - Can I see component IDs of a certain type that were shared to my user?
      instructions:
      - text: List the {componentType} components shared with me in {globalCompanyId}.
        slots:
          componentType: query.componentType
          globalCompanyId: path.globalCompanyId
      - text: Show which {componentType} IDs other users have shared to me.
        slots:
          componentType: query.componentType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/componentmetadata/tags/component/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search tags applied to components
      effect: read
      questions:
      - Which tags are attached to a list of analytics components?
      - Can I search component tags by component type and ID?
      instructions:
      - text: Find the tags on {componentType} components {componentIds} in {globalCompanyId}.
        slots:
          componentType: requestBody.componentType
          componentIds: requestBody.componentIds
          globalCompanyId: path.globalCompanyId
      - text: Search component tags in {globalCompanyId}, returning page {page}.
        slots:
          globalCompanyId: path.globalCompanyId
          page: query.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/componentmetadata/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List all component tags for my company
      effect: read
      questions:
      - What tags does my Analytics company use for organizing components?
      - Can I page through every tag defined for the company?
      instructions:
      - text: List all tags in company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
      - text: Show tags for {globalCompanyId}, {limit} per page.
        slots:
          globalCompanyId: path.globalCompanyId
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/componentmetadata/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Create tags and apply them to a component
      effect: write
      questions:
      - How do I create a new tag and put it on a component?
      - Can I add fresh tags for my company while tagging a segment?
      instructions:
      - text: Create the tags I list in company {globalCompanyId} and apply them to my component.
        slots:
          globalCompanyId: path.globalCompanyId
      - text: Add a new tag in {globalCompanyId} for the segment I name.
        slots:
          globalCompanyId: path.globalCompanyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/componentmetadata/tags'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove all tags from components
      effect: destructive
      questions:
      - Can I strip every tag from a set of components at once?
      - Is untagging several components a single combined operation?
      instructions:
      - text: Remove all tags from {componentType} components {componentIds} in {globalCompanyId}.
        slots:
          componentType: query.componentType
          componentIds: query.componentIds
          globalCompanyId: path.globalCompanyId
      - text: Clear the tags on components {componentIds}.
        slots:
          componentIds: query.componentIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/componentmetadata/tags/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the tags on one component
      effect: read
      questions:
      - What tags are currently on a specific segment?
      - Can I list the tags for a single component ID?
      instructions:
      - text: Show the tags on {componentType} {componentId} in {globalCompanyId}.
        slots:
          componentType: query.componentType
          componentId: query.componentId
          globalCompanyId: path.globalCompanyId
      - text: List tags attached to segment {componentId}.
        slots:
          componentId: query.componentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/componentmetadata/tags/tagitems'].put
  update:
    x-apievangelist-phrasing:
      intent: Overwrite the tags on components
      effect: destructive
      questions:
      - Can I replace a component's tags so only the ones I pass remain?
      - Does setting tag items delete the tags already associated with a component?
      instructions:
      - text: Set the tags on my components in {globalCompanyId} to exactly the list I give you.
        slots:
          globalCompanyId: path.globalCompanyId
      - text: Overwrite component tag associations in company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/componentmetadata/tags/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a tag by ID
      effect: read
      questions:
      - What is the name and description of a tag with a given ID?
      - Can I fetch one tag record directly?
      instructions:
      - text: Get tag {id} in company {globalCompanyId}.
        slots:
          id: path.id
          globalCompanyId: path.globalCompanyId
      - text: Show me tag {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/componentmetadata/tags/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tag everywhere it is used
      effect: destructive
      questions:
      - If I delete a tag, is it removed from every component that had it?
      - How do I delete a tag by its tag ID?
      instructions:
      - text: Delete tag {id} in company {globalCompanyId}.
        slots:
          id: path.id
          globalCompanyId: path.globalCompanyId
      - text: Remove tag {id} from all components.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/componentmetadata/tags/tagnames'].get
  update:
    x-apievangelist-phrasing:
      intent: Find components by tag name
      effect: read
      questions:
      - Which segments are tagged with a particular tag name?
      - Can I look up components using several tag names at once?
      instructions:
      - text: Find {componentType} components tagged {tagNames} in {globalCompanyId}.
        slots:
          componentType: query.componentType
          tagNames: query.tagNames
          globalCompanyId: path.globalCompanyId
      - text: List component IDs carrying the tags {tagNames}.
        slots:
          tagNames: query.tagNames
      method: generated
      generated: '2026-09-26'