OpenMercantil · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Openmercantil System API

3 actions 3 updates phrasing extends openapi/openmercantil-system-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/health'].get
$.paths['/api/v1/stats'].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 System API
  version: 1.0.0
extends: openapi/openmercantil-system-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/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check service health and BORME freshness
      effect: read
      questions:
      - Is the OpenMercantil service up right now?
      - How fresh is the BORME data the service is serving?
      instructions:
      - text: Check the service health.
      - text: Tell me whether the API is healthy and when BORME was last loaded.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get counts of published companies
      effect: read
      questions:
      - How many Spanish legal entities are published in the dataset?
      - Is there an approximate count of person mentions as well as companies?
      instructions:
      - text: Get the published dataset counters.
      - text: Report how many companies are currently published.
      method: generated
      generated: '2026-09-26'