OpenMercantil · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OpenMercantil Public Score API

4 actions 4 updates phrasing extends openapi/openmercantil-score-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 4

$.info
$.paths['/api/v1/company/{slug}/score'].get
$.paths['/api/v1/company/{slug}/activity'].get
$.paths['/api/v1/company/{slug}/trust-score'].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 Public Score API
  version: 1.0.0
extends: openapi/openmercantil-score-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: 3
- target: $.paths['/api/v1/company/{slug}/score'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's composite score
      effect: read
      questions:
      - What is the OpenMercantil composite score for a Spanish company?
      - Can I get a single overall rating for a company from its registry data?
      instructions:
      - text: Get the composite company score for {slug}.
        slots:
          slug: path.slug
      - text: Rate company {slug} with the overall composite score.
        slots:
          slug: path.slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/company/{slug}/activity'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's registry activity over time
      effect: read
      questions:
      - How active has a company been in the mercantile registry over time?
      - Is there a time series of registry events I can chart for one company?
      instructions:
      - text: Get the registry activity time series for {slug}.
        slots:
          slug: path.slug
      - text: Chart how many registry events {slug} had over time.
        slots:
          slug: path.slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/company/{slug}/trust-score'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's trust score
      effect: read
      questions:
      - How trustworthy does a company look once registry, procurement and sanctions signals are combined?
      - Which signals feed the company trust score?
      instructions:
      - text: Get the trust score for {slug}.
        slots:
          slug: path.slug
      - text: Check {slug}'s trust score combining BORME, CNMV, patents, contracts and sanctions.
        slots:
          slug: path.slug
      method: generated
      generated: '2026-09-26'