OpenMercantil · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Openmercantil Search API

3 actions 3 updates phrasing extends openapi/openmercantil-search-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/search'].get

$.paths['/api/v1/person/search'].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 Search API
  version: 1.0.0
extends: openapi/openmercantil-search-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/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search Spanish companies by name or CIF
      effect: read
      questions:
      - How do I find a Spanish company by its name or CIF tax ID?
      - Can I page through company search results, and how deep does the offset go?
      instructions:
      - text: Search companies for {q}.
        slots:
          q: query.q
      - text: Find the company with CIF {q}.
        slots:
          q: query.q
      - text: Search companies whose name starts with {q}, {limit} results from offset {offset}.
        slots:
          q: query.q
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/person/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search registry mentions of a person's name
      effect: read
      questions:
      - Where is a person's name mentioned in Spanish registry publications?
      - What's the maximum number of results a person-name search returns?
      instructions:
      - text: Search person mentions for the name {q}.
        slots:
          q: query.q
      - text: Find up to {limit} documentary mentions of {q}.
        slots:
          limit: query.limit
          q: query.q
      method: generated
      generated: '2026-09-26'