Mirakl · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mirakl Users API

2 actions 2 updates phrasing extends openapi/mirakl-users-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/users/shops/roles'].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 Mirakl Users API
  version: 1.0.0
extends: openapi/mirakl-users-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/users/shops/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List shop roles
      effect: read
      questions:
      - What user roles are available for a shop?
      - Which roles can I assign to my shop's users?
      instructions:
      - text: List the roles for shop {shop_id}.
        slots:
          shop_id: query.shop_id
      - text: Show the available shop user roles.
      method: generated
      generated: '2026-09-26'