OpenMercantil · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OpenMercantil Legal API

8 actions 8 updates phrasing extends openapi/openmercantil-legal-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 8

$.info

$.paths['/api/v1/empresa/{slug}/informe-legal'].post

$.paths['/api/v1/legal/norms'].get

$.paths['/api/v1/legal/norm'].get

$.paths['/api/v1/legal/norm/{slug}'].get

$.paths['/api/v1/legal/article/{norm}/{n}'].get

$.paths['/api/v1/legal/act-map'].get

$.paths['/api/v1/legal/act-map/{acto}'].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 Legal API
  version: 1.0.0
extends: openapi/openmercantil-legal-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: 7
- target: $.paths['/api/v1/empresa/{slug}/informe-legal'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a redacted legal report on a company
      effect: write
      questions:
      - How do I order a legal report on a Spanish company with my credits?
      - Is personal data removed from the corporate legal report?
      - Will I be charged twice if I request the same company's legal report again the same day?
      instructions:
      - text: Generate the informe legal for {company} using CSRF token {csrf_token}.
        slots:
          company: path.slug
          csrf_token: header.X-CSRF-Token
      - text: Create a redacted corporate legal report on {company}.
        slots:
          company: path.slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/legal/norms'].get
  update:
    x-apievangelist-phrasing:
      intent: List core Spanish mercantile-law norms
      effect: read
      questions:
      - Which Spanish commercial laws and codes are covered?
      - Where can I browse the index of mercantile-law norms?
      instructions:
      - text: List the mercantile-law norms.
      - text: Show the catalog of Spanish company laws and regulations.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/legal/norm'].get
  update:
    x-apievangelist-phrasing:
      intent: List law norms via the singular legacy alias
      effect: read
      questions:
      - Does the deprecated singular /legal/norm route still list all norms?
      - Which route replaced the legacy norm index?
      instructions:
      - text: List norms through the legacy singular legal norm alias.
      - text: Call the deprecated /legal/norm index route.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/legal/norm/{slug}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one mercantile-law norm and its key articles
      effect: read
      questions:
      - What are the key articles of a Spanish commercial law?
      - Which BORME act types does a given law govern?
      instructions:
      - text: Get the norm {norm}.
        slots:
          norm: path.slug
      - text: Show the key articles and governed BORME acts of law {norm}.
        slots:
          norm: path.slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/legal/article/{norm}/{n}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the consolidated text of a law article
      effect: read
      questions:
      - Can I read the consolidated text of one article of a Spanish law?
      - Which version date does an article's text come from?
      instructions:
      - text: Get article {n} of {norm}.
        slots:
          n: path.n
          norm: path.norm
      - text: Show the consolidated text of article {n} in norm {norm}.
        slots:
          n: path.n
          norm: path.norm
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/legal/act-map'].get
  update:
    x-apievangelist-phrasing:
      intent: Map every BORME act type to its governing law
      effect: read
      questions:
      - Which law governs each type of BORME registry act?
      - Can I get the full map from registry acts to legal articles?
      instructions:
      - text: Get the full BORME act-to-norm map.
      - text: Show which laws govern all registry act types.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/legal/act-map/{acto}'].get
  update:
    x-apievangelist-phrasing:
      intent: Find the law governing one BORME act type
      effect: read
      questions:
      - Which law and articles govern a capital increase or an appointment in BORME?
      - What norm governs one specific registry act type?
      instructions:
      - text: Get the governing norm for the BORME act {acto}.
        slots:
          acto: path.acto
      - text: Look up which articles regulate the registry act {acto}.
        slots:
          acto: path.acto
      method: generated
      generated: '2026-09-26'