Mirakl · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Operator Connector Setup API

4 actions 4 updates phrasing extends openapi/mirakl-setup-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['/api/setup/check-consistency'].get

$.paths['/api/setup/check-permissions'].get

$.paths['/api/setup/update'].post

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 Setup API
  version: 1.0.0
extends: openapi/mirakl-setup-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['/api/setup/check-consistency'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether installed app data is current
      effect: read
      questions:
      - Is the data set up when I installed the app still up to date?
      - How can I tell if my Mirakl app's initialized data needs refreshing?
      instructions:
      - text: Check the consistency of the app's initialized data.
      - text: Tell me if the setup data is outdated.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/setup/check-permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the Shopify app permissions
      effect: read
      questions:
      - Does the Shopify app have all the permissions it needs?
      - Which Shopify permissions is the Mirakl app missing?
      instructions:
      - text: Check the Shopify app permissions.
      - text: Verify every required Shopify scope is granted.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/setup/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Refresh the app's initialized data
      effect: write
      questions:
      - How do I update the data created during the app installation?
      - Can I apply the latest versions of the setup data?
      instructions:
      - text: Update the initialized setup data.
      - text: Apply the latest setup data versions now.
      method: generated
      generated: '2026-09-26'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this

find_overlaysBrowse and filter every overlay in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This overlay

curl "https://apis.io/api/v1/overlays/mirakl-setup-api-phrasing-overlay"

All openapi overlays

curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.