Amazon Pinpoint · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Amazon Pinpoint Tags API

4 actions 4 updates phrasing extends openapi/amazon-pinpoint-tags-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Amazon Pinpoint's API. It is a proposal applied on top of the contract, not a document Amazon Pinpoint publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/v1/tags/{resource-arn}'].get
$.paths['/v1/tags/{resource-arn}'].post
$.paths['/v1/tags/{resource-arn}#tagKeys'].delete

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 Amazon Pinpoint Tags API
  version: 1.0.0
extends: openapi/amazon-pinpoint-tags-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: 3
- target: $.paths['/v1/tags/{resource-arn}'].get
  update:
    x-apievangelist-phrasing:
      intent: List the tags on a Pinpoint resource
      effect: read
      questions:
      - What tags are attached to my Amazon Pinpoint campaign or project?
      - Can I see the tag keys and values on a message template?
      instructions:
      - text: List the tags on resource {arn}.
        slots:
          arn: path.resource-arn
      - text: Show all tag keys and values for {arn}.
        slots:
          arn: path.resource-arn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tags/{resource-arn}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add tags to a Pinpoint resource
      effect: write
      questions:
      - How do I tag an application, campaign, template or segment for cost tracking?
      - Can I add several tags to a resource in one request?
      instructions:
      - text: Add tags {tags} to resource {arn}.
        slots:
          tags: requestBody.TagsModel
          arn: path.resource-arn
      - text: Tag {arn} with our team and cost center labels.
        slots:
          arn: path.resource-arn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tags/{resource-arn}#tagKeys'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove tags from a Pinpoint resource
      effect: destructive
      questions:
      - How do I remove a tag from a campaign or segment?
      - Can I delete several tag keys from a resource at once?
      instructions:
      - text: Remove tag {tag_key} from resource {arn}.
        slots:
          tag_key: query.tagKeys
          arn: path.resource-arn
      - text: Untag {arn} by deleting the keys {tag_key}.
        slots:
          arn: path.resource-arn
          tag_key: query.tagKeys
      method: generated
      generated: '2026-09-26'