Mintsoft · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reports API

4 actions 4 updates phrasing extends openapi/mintsoft-reports-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Mintsoft's API. It is a proposal applied on top of the contract, not a document Mintsoft publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/api/Reports/CourierDespatchReport'].get
$.paths['/api/Reports/ProductsInLocationReport'].get
$.paths['/api/Reports/ProductUsageReport'].get

OpenAPI Overlay

mintsoft-reports-api-phrasing-overlay.yaml Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Reports API
  version: 1.0.0
extends: openapi/mintsoft-reports-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-11-20'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/api/Reports/CourierDespatchReport'].get
  update:
    x-apievangelist-phrasing:
      intent: Report parcels despatched by courier
      effect: read
      questions:
      - How many parcels did a courier despatch between two dates?
      - Can the courier despatch report be broken down by country?
      instructions:
      - text: Get the courier despatch report from {start} to {end}.
        slots:
          start: query.DespatchDateStart
          end: query.DespatchDateEnd
      - text: Show courier {courier} despatches between {start} and {end} at warehouse {warehouse}.
        slots:
          courier: query.CourierId
          start: query.DespatchDateStart
          end: query.DespatchDateEnd
          warehouse: query.WarehouseId
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Reports/ProductsInLocationReport'].get
  update:
    x-apievangelist-phrasing:
      intent: Report products in a warehouse location
      effect: read
      questions:
      - Which products are in a given location of a warehouse?
      - Can the product location report include order allocations?
      instructions:
      - text: List products in location {location} of warehouse {warehouse}.
        slots:
          location: query.locationTypeId
          warehouse: query.warehouseId
      - text: Show products in warehouse {warehouse} for client {client}.
        slots:
          warehouse: query.warehouseId
          client: query.clientId
      method: generated
      generated: '2026-11-20'
- target: $.paths['/api/Reports/ProductUsageReport'].get
  update:
    x-apievangelist-phrasing:
      intent: Report stock movements for a product
      effect: read
      questions:
      - How much stock of a product moved into or out of a warehouse?
      - Can the product usage report include batch and serial numbers?
      instructions:
      - text: Report stock movements for product {product} in warehouse {warehouse}.
        slots:
          product: query.productId
          warehouse: query.warehouseId
      - text: Show {flow} movements for product {product} between {from} and {to}.
        slots:
          flow: query.flow
          product: query.productId
          from: query.fromDate
          to: query.toDate
      method: generated
      generated: '2026-11-20'

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/mintsoft-reports-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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

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