Mirakl · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Operator Connector Settings API

3 actions 3 updates phrasing extends openapi/mirakl-settings-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['/api/settings'].get

$.paths['/api/settings'].patch

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 Shopify Operator Connector Settings API
  version: 1.0.0
extends: openapi/mirakl-settings-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['/api/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: List connector settings
      effect: read
      questions:
      - What settings is my Mirakl connector currently using?
      - When did the connector last sync orders, offers and products?
      instructions:
      - text: Show the connector settings.
      - text: List my environment's current sync configuration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/settings'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update connector settings
      effect: write
      questions:
      - How do I change a single connector setting without resetting the others?
      - Can I turn on fraud checks or change the shipping zone mapping for the connector?
      instructions:
      - text: Set fraud check to {fraudCheck}.
        slots:
          fraudCheck: requestBody.fraudCheck
      - text: Update shipping zone mapping to {shippingZoneMapping}.
        slots:
          shippingZoneMapping: requestBody.shippingZoneMapping
      - text: Add additional locales {additionalLocales}.
        slots:
          additionalLocales: requestBody.additionalLocales
      method: generated
      generated: '2026-09-26'