OpenMercantil · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OpenMercantil Public Network API

3 actions 3 updates phrasing extends openapi/openmercantil-network-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for OpenMercantil's API. It is a proposal applied on top of the contract, not a document OpenMercantil publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/api/v1/company/{slug}/network'].get

$.paths['/api/v1/company/{slug}/embargoes'].get

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 OpenMercantil Public Network API
  version: 1.0.0
extends: openapi/openmercantil-network-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: 2
- target: $.paths['/api/v1/company/{slug}/network'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's officer and shareholder network
      effect: read
      questions:
      - Who are the officers and shareholders connected to a company?
      - Can I get a relationship graph for a company?
      instructions:
      - text: Get the relationship network of {company}.
        slots:
          company: path.slug
      - text: Map the officers and shareholders around {company}.
        slots:
          company: path.slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/company/{slug}/embargoes'].get
  update:
    x-apievangelist-phrasing:
      intent: List embargoes recorded against a company
      effect: read
      questions:
      - Have any seizures been recorded against a company?
      - Where do I find public embargoes on a company?
      instructions:
      - text: List embargoes recorded against {company}.
        slots:
          company: path.slug
      - text: Show the seizures registered on {company}.
        slots:
          company: path.slug
      method: generated
      generated: '2026-09-26'