Mirakl · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Mirakl Platform Services API
9 actions
9 updates
phrasing
extends
openapi/mirakl-services-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.
What the actions change
x-apievangelist-phrasing
Targets 9
$.info
$.paths['/api/mms/locations'].get
$.paths['/api/mms/locations'].post
$.paths['/api/mms/locations/{location_id}'].delete
$.paths['/api/mms/models'].get
$.paths['/api/mms/services'].get
$.paths['/api/mms/services'].post
$.paths['/api/mms/services/{service_code}'].put
$.paths['/api/mms/services/{service_code}'].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 Platform Services API
version: 1.0.0
extends: openapi/mirakl-services-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: 8
- target: $.paths['/api/mms/locations'].get
update:
x-apievangelist-phrasing:
intent: List service locations
effect: read
questions:
- Where are the locations my shop offers services from?
- Can I list only locations of a certain type?
instructions:
- text: List service locations for shop {shop_id}.
slots:
shop_id: query.shop_id
- text: Show locations of type {location_type}.
slots:
location_type: query.location_type
- text: Get location {location_id}.
slots:
location_id: query.location_id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/mms/locations'].post
update:
x-apievangelist-phrasing:
intent: Create a service location
effect: write
questions:
- How do I add a new place where customers can book my services?
- Can I set opening hours and contact info on a new location?
instructions:
- text: Create location {label} at {geography}.
slots:
label: requestBody.label
geography: requestBody.geography
- text: Add location {label} at {geography} with opening hours {opening_hours}.
slots:
label: requestBody.label
geography: requestBody.geography
opening_hours: requestBody.opening_hours
method: generated
generated: '2026-09-26'
- target: $.paths['/api/mms/locations/{location_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a service location
effect: destructive
questions:
- How do I remove a location my shop no longer uses?
- Can I delete a service location by its ID?
instructions:
- text: Delete location {location_id}.
slots:
location_id: path.location_id
- text: Remove location {location_id} from shop {shop_id}.
slots:
location_id: path.location_id
shop_id: query.shop_id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/mms/models'].get
update:
x-apievangelist-phrasing:
intent: List service models
effect: read
questions:
- What service models can I base a new service on?
- Which service models support a given booking or consumption type?
instructions:
- text: List service models in category {category_code}.
slots:
category_code: query.category_code
- text: Show service models with booking type {booking_type}.
slots:
booking_type: query.booking_type
method: generated
generated: '2026-09-26'
- target: $.paths['/api/mms/services'].get
update:
x-apievangelist-phrasing:
intent: List services
effect: read
questions:
- What services is my shop currently offering?
- Can I filter my services by state or category?
instructions:
- text: List services in state {state}.
slots:
state: query.state
- text: Show service {service_code}.
slots:
service_code: query.service_code
- text: List services built on model {model_code}.
slots:
model_code: query.model_code
method: generated
generated: '2026-09-26'
- target: $.paths['/api/mms/services'].post
update:
x-apievangelist-phrasing:
intent: Create a service
effect: write
questions:
- How do I publish a new service offering on the marketplace?
- What do I need to provide to create a service — model, category and pricing?
instructions:
- text: Create service {title} in category {category} using model {model} priced at {pricing}.
slots:
title: requestBody.title
category: requestBody.category
model: requestBody.model
pricing: requestBody.pricing
- text: Add a new service {title} with model {model}, category {category} and pricing {pricing}.
slots:
title: requestBody.title
model: requestBody.model
category: requestBody.category
pricing: requestBody.pricing
method: generated
generated: '2026-09-26'
- target: $.paths['/api/mms/services/{service_code}'].put
update:
x-apievangelist-phrasing:
intent: Update a service
effect: write
questions:
- How do I change the price or description of an existing service?
- Can I change the availability dates of a service I already created?
instructions:
- text: Update service {service_code} pricing to {pricing}.
slots:
service_code: path.service_code
pricing: requestBody.pricing
- text: Change the title of service {service_code} to {title}.
slots:
service_code: path.service_code
title: requestBody.title
method: generated
generated: '2026-09-26'
- target: $.paths['/api/mms/services/{service_code}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a service
effect: destructive
questions:
- How do I remove a service from my shop?
- Is deleting a service done by its service code?
instructions:
- text: Delete service {service_code}.
slots:
service_code: path.service_code
- text: Remove service {service_code} from shop {shop_id}.
slots:
service_code: path.service_code
shop_id: query.shop_id
method: generated
generated: '2026-09-26'