Mirakl · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mirakl Marketplace Incidents API

2 actions 2 updates phrasing extends openapi/mirakl-incidents-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/orders/{order_id}/lines/{line}/resolve_incident'].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 Marketplace Incidents API
  version: 1.0.0
extends: openapi/mirakl-incidents-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/orders/{order_id}/lines/{line}/resolve_incident'].put
  update:
    x-apievangelist-phrasing:
      intent: Resolve an incident on an order line
      effect: write
      questions:
      - How do I mark an incident on an order line as resolved?
      - Do I have to give a reason code when resolving an incident?
      instructions:
      - text: Resolve the incident on line {line} of order {order_id} with reason {reason_code}.
        slots:
          line: path.line
          order_id: path.order_id
          reason_code: requestBody.reason_code
      - text: Close incident on order {order_id} line {line} for shop {shop_id} using reason {reason_code}.
        slots:
          order_id: path.order_id
          line: path.line
          shop_id: query.shop_id
          reason_code: requestBody.reason_code
      method: generated
      generated: '2026-09-26'