OpenMercantil · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OpenMercantil Public Export API

6 actions 6 updates phrasing extends openapi/openmercantil-export-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 6

$.info

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

$.paths['/api/v1/export/events'].get

$.paths['/api/v1/sectores/stats.csv'].get

$.paths['/api/v1/contracts/top-companies.csv'].get

$.paths['/api/v1/contracts/top-persons.csv'].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 Export API
  version: 1.0.0
extends: openapi/openmercantil-export-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: 5
- target: $.paths['/api/v1/company/{slug}/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a company report
      effect: read
      questions:
      - Can I download a full report on one company as JSON or CSV?
      - How do I export a single company's report for my spreadsheet?
      instructions:
      - text: Export the company report for {slug}.
        slots:
          slug: path.slug
      - text: Download {slug}'s company report in {format} format.
        slots:
          slug: path.slug
          format: query.format
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/export/events'].get
  update:
    x-apievangelist-phrasing:
      intent: Bulk export BORME events for a year
      effect: read
      questions:
      - How do I bulk download all BORME events for a year?
      - Which formats does the events bulk export support?
      instructions:
      - text: Export all BORME events from {year}.
        slots:
          year: query.year
      - text: Bulk export the {year} BORME events as {format}.
        slots:
          year: query.year
          format: query.format
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/sectores/stats.csv'].get
  update:
    x-apievangelist-phrasing:
      intent: Download sector statistics as CSV
      effect: read
      questions:
      - Can I get the aggregate CNAE sector statistics as a CSV file?
      - Is there a spreadsheet download of company counts and growth per sector?
      instructions:
      - text: Download the sector statistics CSV.
      - text: Export company counts and growth by sector to CSV.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/contracts/top-companies.csv'].get
  update:
    x-apievangelist-phrasing:
      intent: Download top companies by public contracts as CSV
      effect: read
      questions:
      - Which companies win the most public contracts, as a CSV?
      - How many companies can the public-contracts ranking CSV include?
      instructions:
      - text: Download the top companies by public contracts CSV.
      - text: Export the top {limit} contract-winning companies to CSV.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/contracts/top-persons.csv'].get
  update:
    x-apievangelist-phrasing:
      intent: Download top persons by public contracts as CSV
      effect: read
      questions:
      - Which people are linked to the most public contracts, as a downloadable CSV?
      - Is there a CSV ranking of persons by public procurement contracts?
      instructions:
      - text: Download the top persons by public contracts CSV.
      - text: Export the top {limit} people ranked by public contracts.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'