Mirakl · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Operator Connector Synchronization Errors API

15 actions 15 updates phrasing extends openapi/mirakl-synchronization-errors-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 15

$.info
$.paths['/api/sync/mirakl-offers-sync-error'].get
$.paths['/api/sync/shopify-orders-sync-error'].get
$.paths['/api/sync/shopify-products-sync-error'].get
$.paths['/api/sync/mirakl-promotions-sync-error'].get
$.paths['/api/sync/mirakl-returns-sync-error'].get
$.paths['/api/sync/mirakl-shipments-sync-error'].get
$.paths['/api/sync/mirakl-shops-sync-error'].get
$.paths['/api/sync/mirakl-offers-sync-errors'].get
$.paths['/api/sync/shopify-orders-sync-errors'].get
$.paths['/api/sync/shopify-products-sync-errors'].get
$.paths['/api/sync/mirakl-promotions-sync-errors'].get
$.paths['/api/sync/mirakl-returns-sync-errors'].get
$.paths['/api/sync/mirakl-shipments-sync-errors'].get
$.paths['/api/sync/mirakl-shops-sync-errors'].get

OpenAPI Overlay

Raw ↑
# 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 Synchronization Errors API
  version: 1.0.0
extends: openapi/mirakl-synchronization-errors-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: 14
- target: $.paths['/api/sync/mirakl-offers-sync-error'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one offer sync error
      effect: read
      questions:
      - What went wrong with a specific offer that failed to sync into Shopify?
      - Can I look up a single recoverable offer sync error by its discriminant?
      instructions:
      - text: Get offer sync error {discriminant}.
        slots:
          discriminant: query.discriminant
      - text: Show details of the recoverable offer error {discriminant}.
        slots:
          discriminant: query.discriminant
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/sync/shopify-orders-sync-error'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one order sync error
      effect: read
      questions:
      - Why did a particular order fail to sync between Mirakl and Shopify?
      - Can I inspect one recoverable order sync error in detail?
      instructions:
      - text: Get order sync error {discriminant}.
        slots:
          discriminant: query.discriminant
      - text: Show details of the recoverable order error {discriminant}.
        slots:
          discriminant: query.discriminant
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/sync/shopify-products-sync-error'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one product sync error
      effect: read
      questions:
      - What caused a specific product to fail during catalog synchronization?
      - Can I fetch a single recoverable product sync error by discriminant?
      instructions:
      - text: Get product sync error {discriminant}.
        slots:
          discriminant: query.discriminant
      - text: Show details of the recoverable product error {discriminant}.
        slots:
          discriminant: query.discriminant
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/sync/mirakl-promotions-sync-error'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one promotion sync error
      effect: read
      questions:
      - Why did one Mirakl promotion fail to become a Shopify discount?
      - Can I look at a single recoverable promotion sync error?
      instructions:
      - text: Get promotion sync error {discriminant}.
        slots:
          discriminant: query.discriminant
      - text: Show details of the recoverable promotion error {discriminant}.
        slots:
          discriminant: query.discriminant
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/sync/mirakl-returns-sync-error'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one return sync error
      effect: read
      questions:
      - What went wrong when a specific return synced from Mirakl to Shopify?
      - Can I read the details of one recoverable return sync error?
      instructions:
      - text: Get return sync error {discriminant}.
        slots:
          discriminant: query.discriminant
      - text: Show details of the recoverable return error {discriminant}.
        slots:
          discriminant: query.discriminant
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/sync/mirakl-shipments-sync-error'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one shipment sync error
      effect: read
      questions:
      - Why did a particular shipment fail to sync into Shopify?
      - Can I retrieve one recoverable shipment sync error by its discriminant?
      instructions:
      - text: Get shipment sync error {discriminant}.
        slots:
          discriminant: query.discriminant
      - text: Show details of the recoverable shipment error {discriminant}.
        slots:
          discriminant: query.discriminant
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/sync/mirakl-shops-sync-error'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one shop sync error
      effect: read
      questions:
      - What stopped a specific Mirakl shop from syncing into Shopify?
      - Can I check a single recoverable shop sync error?
      instructions:
      - text: Get shop sync error {discriminant}.
        slots:
          discriminant: query.discriminant
      - text: Show details of the recoverable shop error {discriminant}.
        slots:
          discriminant: query.discriminant
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/sync/mirakl-offers-sync-errors'].get
  update:
    x-apievangelist-phrasing:
      intent: List offer sync errors
      effect: read
      questions:
      - Which offers failed to sync from Mirakl into Shopify?
      - Can I page through all recoverable offer sync errors?
      instructions:
      - text: List all recoverable offer sync errors.
      - text: Show me the offers that failed to sync.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/sync/shopify-orders-sync-errors'].get
  update:
    x-apievangelist-phrasing:
      intent: List order sync errors
      effect: read
      questions:
      - Which orders failed to sync between Mirakl and Shopify?
      - Is there a list of every recoverable order sync error?
      instructions:
      - text: List all recoverable order sync errors.
      - text: Show me the orders that failed to sync.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/sync/shopify-products-sync-errors'].get
  update:
    x-apievangelist-phrasing:
      intent: List product sync errors
      effect: read
      questions:
      - Which products failed during catalog synchronization?
      - Can I see all recoverable product sync errors at once?
      instructions:
      - text: List all recoverable product sync errors.
      - text: Show me the products that failed to sync.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/sync/mirakl-promotions-sync-errors'].get
  update:
    x-apievangelist-phrasing:
      intent: List promotion sync errors
      effect: read
      questions:
      - Which Mirakl promotions failed to sync into Shopify?
      - Is there a list of recoverable promotion sync errors?
      instructions:
      - text: List all recoverable promotion sync errors.
      - text: Show me the promotions that failed to sync.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/sync/mirakl-returns-sync-errors'].get
  update:
    x-apievangelist-phrasing:
      intent: List return sync errors
      effect: read
      questions:
      - Which returns failed to sync from Mirakl to Shopify?
      - Can I page through recoverable return sync errors?
      instructions:
      - text: List all recoverable return sync errors.
      - text: Show me the returns that failed to sync.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/sync/mirakl-shipments-sync-errors'].get
  update:
    x-apievangelist-phrasing:
      intent: List shipment sync errors
      effect: read
      questions:
      - Which shipments failed to sync into Shopify?
      - Is there a list of every recoverable shipment sync error?
      instructions:
      - text: List all recoverable shipment sync errors.
      - text: Show me the shipments that failed to sync.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/sync/mirakl-shops-sync-errors'].get
  update:
    x-apievangelist-phrasing:
      intent: List shop sync errors
      effect: read
      questions:
      - Which Mirakl shops failed to sync into Shopify?
      - Can I see all recoverable shop sync errors?
      instructions:
      - text: List all recoverable shop sync errors.
      - text: Show me the shops that failed to sync.
      method: generated
      generated: '2026-09-26'