OpenMercantil · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Openmercantil Sources API

6 actions 6 updates phrasing extends openapi/openmercantil-sources-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/sources/freshness'].get
$.paths['/api/v1/sources/status'].get
$.paths['/api/v1/company/{slug}/grants'].get
$.paths['/api/v1/company/{slug}/sanctions'].get
$.paths['/api/v1/company/{slug}/cnmv'].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 Sources API
  version: 1.0.0
extends: openapi/openmercantil-sources-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/sources/freshness'].get
  update:
    x-apievangelist-phrasing:
      intent: See how fresh each public data source is
      effect: read
      questions:
      - How recent is the data from each public source OpenMercantil publishes?
      - When was each authorized source last updated?
      instructions:
      - text: Show the per-source freshness map.
      - text: List the last update date for every authorized public source.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/sources/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Get public metadata about the data sources
      effect: read
      questions:
      - Which public sources are in the catalog and what data date do they carry?
      - Where can I read the catalog metadata for the sources behind the data?
      instructions:
      - text: Get the public source catalog metadata with its coarse data date.
      - text: Describe the public sources in the catalog.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/company/{slug}/grants'].get
  update:
    x-apievangelist-phrasing:
      intent: List public grants a company received
      effect: read
      questions:
      - Has this Spanish company received any public subsidies or grants?
      - Can I see a company's grants from the BDNS national subsidies database?
      instructions:
      - text: List the BDNS public grants awarded to {slug}.
        slots:
          slug: path.slug
      - text: Show me every subsidy recorded for company {slug}.
        slots:
          slug: path.slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/company/{slug}/sanctions'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a company for sanctions hits
      effect: read
      questions:
      - Is this company on any sanctions list or fined by a competition authority?
      - Does a Spanish company show up in OpenSanctions screening?
      instructions:
      - text: Screen {slug} for sanctions hits.
        slots:
          slug: path.slug
      - text: List the sanctions and competition-authority records tied to {slug}.
        slots:
          slug: path.slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/company/{slug}/cnmv'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's CNMV securities records
      effect: read
      questions:
      - What does the Spanish securities regulator CNMV have on file for a company?
      - Can I check whether a company appears in CNMV records?
      instructions:
      - text: Get the CNMV records for {slug}.
        slots:
          slug: path.slug
      - text: Pull the securities-regulator filings for company {slug}.
        slots:
          slug: path.slug
      method: generated
      generated: '2026-09-26'