OpenMercantil · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OpenMercantil Graph API

4 actions 4 updates phrasing extends openapi/openmercantil-graph-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 4

$.info
$.paths['/api/v1/grafo/{slug}'].get
$.paths['/api/v1/grafo/persona/{slug}'].get
$.paths['/api/v1/company/{slug}/network'].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 OpenMercantil Graph API
  version: 1.0.0
extends: openapi/openmercantil-graph-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: 3
- target: $.paths['/api/v1/grafo/{slug}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's corporate parent/child graph
      effect: read
      questions:
      - Who are a company's parent and subsidiary entities?
      - Can I cap how many child entities the corporate graph returns?
      instructions:
      - text: Show the corporate group graph for {slug}.
        slots:
          slug: path.slug
      - text: Map parents and up to {max_children} subsidiaries of {slug}.
        slots:
          max_children: query.max_children
          slug: path.slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/grafo/persona/{slug}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the companies linked to a person
      effect: read
      questions:
      - Which companies is a person connected to in BORME?
      - How do I see a person-to-company graph from registry publications?
      instructions:
      - text: Show the company graph for person {slug}.
        slots:
          slug: path.slug
      - text: List up to {limit} companies linked to person {slug}.
        slots:
          limit: query.limit
          slug: path.slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/company/{slug}/network'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's documentary network
      effect: read
      questions:
      - Is the company documentary network projection available yet?
      - Why does the company network route return a 503?
      instructions:
      - text: Try to fetch the documentary network for {slug}.
        slots:
          slug: path.slug
      - text: Check whether the network projection for company {slug} is back online.
        slots:
          slug: path.slug
      method: generated
      generated: '2026-09-26'