Mirakl · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mirakl Connect Catalog API

4 actions 4 updates phrasing extends openapi/mirakl-catalog-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Mirakl's API. It is a proposal applied on top of the contract, not a document Mirakl publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/products'].get

$.paths['/products'].post

$.paths['/products'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Mirakl Connect Catalog API
  version: 1.0.0
extends: openapi/mirakl-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['/products'].get
  update:
    x-apievangelist-phrasing:
      intent: List products in the Connect catalog
      effect: read
      questions:
      - How do I see all products imported into my Mirakl Connect catalog?
      - Can I page through Connect catalog products with a page token?
      instructions:
      - text: List Connect catalog products, {limit} per page.
        slots:
          limit: query.limit
      - text: Get the next page of catalog products after {page_token}.
        slots:
          page_token: query.page_token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/products'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update Connect catalog products
      effect: write
      questions:
      - How do I add or update products in my Mirakl Connect catalog?
      - Will fields I leave out of a product upsert be wiped or kept?
      instructions:
      - text: 'Upsert these products into my Connect catalog: {products}.'
        slots:
          products: requestBody.products
      - text: Update product data for {products}, keeping omitted fields.
        slots:
          products: requestBody.products
      method: generated
      generated: '2026-09-26'
- target: $.paths['/products'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete products from the Connect catalog
      effect: destructive
      questions:
      - How do I remove products from my Mirakl Connect catalog in bulk?
      - What's the maximum number of products I can delete per request?
      instructions:
      - text: Delete products {products} from my Connect catalog.
        slots:
          products: requestBody.products
      - text: 'Bulk-remove these catalog products: {products}.'
        slots:
          products: requestBody.products
      method: generated
      generated: '2026-09-26'