OpenMercantil · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OpenMercantil Integrations API

4 actions 4 updates phrasing extends openapi/openmercantil-integrations-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/stripe-webhook'].post
$.paths['/api/v1/integrations'].get
$.paths['/api/v1/integrations/{slug}'].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 Integrations API
  version: 1.0.0
extends: openapi/openmercantil-integrations-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/stripe-webhook'].post
  update:
    x-apievangelist-phrasing:
      intent: Receive a signed Stripe event
      effect: write
      questions:
      - Where does Stripe deliver its signed events for OpenMercantil billing?
      - What happens when the same Stripe event is delivered twice?
      instructions:
      - text: Deliver Stripe event {id} of type {type}.
        slots:
          id: requestBody.id
          type: requestBody.type
      - text: Post signed Stripe event {id} to the billing webhook.
        slots:
          id: requestBody.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/integrations'].get
  update:
    x-apievangelist-phrasing:
      intent: List public data-source integrations
      effect: read
      questions:
      - Which public data sources are integrated and legally allowed for reuse?
      - Can I filter integrations by capability?
      instructions:
      - text: List the public integrations.
      - text: Show integrations with capability {capability}.
        slots:
          capability: query.capability
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/integrations/{slug}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one integration's legal and transport status
      effect: read
      questions:
      - Is a specific data source integration legally cleared and technically available?
      - What legal-egress decision applies to one integration?
      instructions:
      - text: Get integration {integration}.
        slots:
          integration: path.slug
      - text: Show the legal and transport status of the {integration} integration.
        slots:
          integration: path.slug
      method: generated
      generated: '2026-09-26'