Mirakl · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mirakl Connect Channel Platform Taxonomy API

3 actions 3 updates phrasing extends openapi/mirakl-taxonomy-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 3

$.info

$.paths['/v1/taxonomy/channels/{channel_id}/rules'].put

$.paths['/v1/taxonomy/channels/{channel_id}/product-types'].put

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 Channel Platform Taxonomy API
  version: 1.0.0
extends: openapi/mirakl-taxonomy-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: 2
- target: $.paths['/v1/taxonomy/channels/{channel_id}/rules'].put
  update:
    x-apievangelist-phrasing:
      intent: Create taxonomy rules for a channel
      effect: write
      questions:
      - How do I define taxonomy rules for a sales channel in Mirakl Connect?
      - Can I add several taxonomy rules to a channel at once?
      instructions:
      - text: Create taxonomy rules {rules} on channel {channel_id}.
        slots:
          rules: requestBody.rules
          channel_id: path.channel_id
      - text: Add taxonomy rules to channel {channel_id}.
        slots:
          channel_id: path.channel_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/taxonomy/channels/{channel_id}/product-types'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a channel product type
      effect: write
      questions:
      - How do I create a product type with its attributes for a channel?
      - Does updating a product type replace attributes I leave out?
      instructions:
      - text: Upsert product type {product_type_id} on channel {channel_id} with labels {labels} and attributes {embedded_attributes}.
        slots:
          product_type_id: query.product_type_id
          channel_id: path.channel_id
          labels: requestBody.labels
          embedded_attributes: requestBody.embedded_attributes
      - text: Replace product type {product_type_id} for channel {channel_id}.
        slots:
          product_type_id: query.product_type_id
          channel_id: path.channel_id
      method: generated
      generated: '2026-09-26'