Mirakl · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mirakl Stores API

8 actions 8 updates phrasing extends openapi/mirakl-stores-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 8

$.info

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

$.paths['/api/account'].put

$.paths['/api/account/statistics'].get

$.paths['/api/shops/documents'].get

$.paths['/api/shops/documents'].post

$.paths['/api/shops/documents/download'].get

$.paths['/api/shops/documents/{document_id}'].delete

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 Stores API
  version: 1.0.0
extends: openapi/mirakl-stores-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: 7
- target: $.paths['/api/account'].get
  update:
    x-apievangelist-phrasing:
      intent: Get shop account information
      effect: read
      questions:
      - How do I see my shop's account details on the marketplace?
      - What information is stored about my seller shop?
      instructions:
      - text: Get shop information for {shop_id}.
        slots:
          shop_id: query.shop_id
      - text: Show my shop's account details.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/account'].put
  update:
    x-apievangelist-phrasing:
      intent: Update shop account information
      effect: write
      questions:
      - How do I change my shop name, email or return policy?
      - Can I set closure dates for my shop, like a holiday break?
      - Why can't I edit some shop fields?
      instructions:
      - text: Rename my shop to {shop_name}.
        slots:
          shop_name: requestBody.shop_name
      - text: Close my shop from {closed_from} to {closed_to}.
        slots:
          closed_from: requestBody.closed_from
          closed_to: requestBody.closed_to
      - text: Update my shop return policy to {return_policy}.
        slots:
          return_policy: requestBody.return_policy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/account/statistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get shop statistics
      effect: read
      questions:
      - How is my shop performing over recent periods?
      - Can I see shop statistics for one sales channel?
      instructions:
      - text: Get shop statistics for periods {periods}.
        slots:
          periods: query.periods
      - text: Show shop stats for channel {channel_code}.
        slots:
          channel_code: query.channel_code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/shops/documents'].get
  update:
    x-apievangelist-phrasing:
      intent: List a shop's business documents
      effect: read
      questions:
      - Which business documents has my shop uploaded?
      - Can I list the KYC documents on file for a shop?
      instructions:
      - text: List documents for shop {shop_id}.
        slots:
          shop_id: query.shop_id
      - text: Show my shop's uploaded business documents.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/shops/documents'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload business documents for a shop
      effect: write
      questions:
      - How do I upload business documents like ID or registration papers for my shop?
      - What file types and how many documents can a shop upload?
      instructions:
      - text: Upload files {files} described by {shop_documents} for my shop.
        slots:
          files: requestBody.files
          shop_documents: requestBody.shop_documents
      - text: Upload business documents {shop_documents} for shop {shop_id}.
        slots:
          shop_documents: requestBody.shop_documents
          shop_id: query.shop_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/shops/documents/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download shop business documents
      effect: read
      questions:
      - How do I download the business documents for one or more shops?
      - Can I download only certain document types for a shop?
      instructions:
      - text: Download shop documents {document_ids}.
        slots:
          document_ids: query.document_ids
      - text: Download documents of type {type_codes} for shop {shop_id}.
        slots:
          type_codes: query.type_codes
          shop_id: query.shop_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/shops/documents/{document_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a shop business document
      effect: destructive
      questions:
      - Can I remove a business document from my shop?
      - How do I delete an outdated shop document?
      instructions:
      - text: Delete shop document {document_id}.
        slots:
          document_id: path.document_id
      - text: Remove document {document_id} from shop {shop_id}.
        slots:
          document_id: path.document_id
          shop_id: query.shop_id
      method: generated
      generated: '2026-09-26'