Mirakl · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mirakl Picklists API

2 actions 2 updates phrasing extends openapi/mirakl-picklists-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 2

$.info

$.paths['/api/picklists'].get

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 Picklists API
  version: 1.0.0
extends: openapi/mirakl-picklists-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: 1
- target: $.paths['/api/picklists'].get
  update:
    x-apievangelist-phrasing:
      intent: List picklists
      effect: read
      questions:
      - Which picklists do I have for today's pickups?
      - Can I filter picklists by pick run or state?
      instructions:
      - text: List picklists for pick run {pickrun_code}.
        slots:
          pickrun_code: query.pickrun_code
      - text: List picklists with pickup between {pickup_date_min} and {pickup_date_max}.
        slots:
          pickup_date_min: query.pickup_date_min
          pickup_date_max: query.pickup_date_max
      - text: Find the picklist containing order line {order_line_id}.
        slots:
          order_line_id: query.order_line_id
      method: generated
      generated: '2026-09-26'