Attentive · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Attentive Product Catalog API

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

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/product-catalog/uploads'].get
$.paths['/product-catalog/uploads'].post
$.paths['/product-catalog/uploads/{uploadId}'].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 Attentive Product Catalog API
  version: 1.0.0
extends: openapi/attentive-product-catalog-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['/product-catalog/uploads'].get
  update:
    x-apievangelist-phrasing:
      intent: List recent product catalog uploads
      effect: read
      questions:
      - How do I see my recent product catalog uploads and their statuses?
      - Which of my catalog uploads have expired or failed ingestion?
      instructions:
      - text: List my recent product catalog uploads.
      - text: Show the status of every catalog upload started this week.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/product-catalog/uploads'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a product catalog upload
      effect: write
      questions:
      - How do I send my product catalog to Attentive?
      - Can I validate a catalog file without actually ingesting it?
      - Where do I get the pre-signed URL to upload my catalog file?
      instructions:
      - text: Start a new product catalog upload and give me the upload URL.
      - text: Begin a catalog upload with validate only set to {validateOnly}.
        slots:
          validateOnly: requestBody.validateOnly
      method: generated
      generated: '2026-09-26'
- target: $.paths['/product-catalog/uploads/{uploadId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one product catalog ingestion
      effect: read
      questions:
      - How do I check the ingestion result of a specific catalog upload?
      - Did the catalog file I uploaded earlier finish processing?
      instructions:
      - text: Look up catalog upload {uploadId}.
        slots:
          uploadId: path.uploadId
      - text: Tell me whether catalog ingestion {uploadId} succeeded.
        slots:
          uploadId: path.uploadId
      method: generated
      generated: '2026-09-26'