OpenMercantil · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OpenMercantil Public Contracts API

6 actions 6 updates phrasing extends openapi/openmercantil-contracts-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/persona/{slug}/contracts'].get

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

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

$.paths['/api/v1/contracts/top-persons'].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 Contracts API
  version: 1.0.0
extends: openapi/openmercantil-contracts-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/persona/{slug}/contracts'].get
  update:
    x-apievangelist-phrasing:
      intent: List public contracts linked to a person
      effect: read
      questions:
      - Which public procurement contracts is a person associated with?
      - Can I see PLACSP contracts tied to an individual?
      instructions:
      - text: List public contracts for person {person}.
        slots:
          person: path.slug
      - text: Show PLACSP procurement associated with {person}.
        slots:
          person: path.slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/contracts/top-companies'].get
  update:
    x-apievangelist-phrasing:
      intent: Rank companies by public contract volume
      effect: read
      questions:
      - Which companies win the most public contracts?
      - Can I rank contract winners within one province or CNAE sector?
      instructions:
      - text: Rank the top {limit} companies by public contracts.
        slots:
          limit: query.limit
      - text: Show top contract-winning companies in {province} for CNAE {cnae}.
        slots:
          province: query.province
          cnae: query.cnae
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/contracts/top-companies.csv'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the company contracts ranking as CSV
      effect: read
      questions:
      - Can I download the top companies by contracts as a CSV?
      - Is there a spreadsheet version of the company contract ranking?
      instructions:
      - text: Download the top {limit} companies by contracts as CSV.
        slots:
          limit: query.limit
      - text: Export the company contract ranking to a CSV file.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/contracts/top-persons'].get
  update:
    x-apievangelist-phrasing:
      intent: Rank persons by public contract volume
      effect: read
      questions:
      - Which people are linked to the most public procurement contracts?
      - How many persons can the contract ranking return?
      instructions:
      - text: Rank the top {limit} persons by public contracts.
        slots:
          limit: query.limit
      - text: Show the people ranking by procurement contract volume.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/contracts/top-persons.csv'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the persons contracts ranking as CSV
      effect: read
      questions:
      - Can I export the persons-by-contracts ranking to a spreadsheet?
      - Is there a CSV download of the top persons by procurement?
      instructions:
      - text: Download the top {limit} persons by contracts as CSV.
        slots:
          limit: query.limit
      - text: Export the person contract ranking to a CSV file.
      method: generated
      generated: '2026-09-26'