MoEngage · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for MoEngage Catalog Items API

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

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/catalog/{catalog_id}/items'].post
$.paths['/catalog/{catalog_id}/items'].patch
$.paths['/catalog/{catalog_id}/items/bulk-delete'].post
$.paths['/catalog/{catalog_id}/items/search'].post

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 MoEngage Catalog Items API
  version: 1.0.0
extends: openapi/moengage-items-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: 4
- target: $.paths['/catalog/{catalog_id}/items'].post
  update:
    x-apievangelist-phrasing:
      intent: Add items to a catalog
      effect: write
      questions:
      - How do I load products into an existing catalog?
      - Do the items I add have to match the catalog's attributes?
      instructions:
      - text: Add these items {items} to catalog {catalog_id}.
        slots:
          items: requestBody.items
          catalog_id: path.catalog_id
      - text: Ingest new products into catalog {catalog_id}.
        slots:
          catalog_id: path.catalog_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/catalog/{catalog_id}/items'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update item attributes in a catalog
      effect: write
      questions:
      - How do I change the price or title of products already in a catalog?
      - Do updated item values need to match the attribute data types?
      instructions:
      - text: Update items {items} in catalog {catalog_id}.
        slots:
          items: requestBody.items
          catalog_id: path.catalog_id
      - text: Change existing product values in catalog {catalog_id}.
        slots:
          catalog_id: path.catalog_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/catalog/{catalog_id}/items/bulk-delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete items from a catalog
      effect: destructive
      questions:
      - How do I remove discontinued products from a catalog?
      - Can I bulk delete several catalog items at once?
      instructions:
      - text: Delete items {items} from catalog {catalog_id}.
        slots:
          items: requestBody.items
          catalog_id: path.catalog_id
      - text: Bulk remove these products from catalog {catalog_id}.
        slots:
          catalog_id: path.catalog_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/catalog/{catalog_id}/items/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up catalog items by ID
      effect: read
      questions:
      - How do I get the title, price and link of specific catalog items by their IDs?
      - When was a particular catalog item created?
      instructions:
      - text: Get the details of items {items} in catalog {catalog_id}.
        slots:
          items: requestBody.items
          catalog_id: path.catalog_id
      - text: Look up product attributes for these item IDs in catalog {catalog_id}.
        slots:
          catalog_id: path.catalog_id
      method: generated
      generated: '2026-10-01'