Soda · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Soda Cloud API v4 Scans API

4 actions 4 updates phrasing extends openapi/soda-data-scans-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Soda's API. It is a proposal applied on top of the contract, not a document Soda publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/api/v1/scans/{scanId}'].get

$.paths['/api/v1/scans/{scanId}'].delete

$.paths['/api/v1/scans/{scanId}/logs'].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 Soda Cloud API v4 Scans API
  version: 1.0.0
extends: openapi/soda-data-scans-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/scans/{scanId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get scan status
      effect: read
      questions:
      - Is my data quality scan still running or has it finished?
      - What state is a scan in after I triggered it?
      instructions:
      - text: Check the status of scan {scanId}.
        slots:
          scanId: path.scanId
      - text: Poll scan {scanId} until it completes.
        slots:
          scanId: path.scanId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/scans/{scanId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a scan
      effect: destructive
      questions:
      - Can I cancel a scan that is pending or already submitted?
      - How do I stop a running scan?
      instructions:
      - text: Cancel scan {scanId}.
        slots:
          scanId: path.scanId
      - text: Stop scan {scanId} before it runs.
        slots:
          scanId: path.scanId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/scans/{scanId}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get scan logs
      effect: read
      questions:
      - Where can I read the logs of a finished scan to debug a failure?
      - What went wrong during a scan's execution?
      instructions:
      - text: Show the logs of scan {scanId}.
        slots:
          scanId: path.scanId
      - text: Get page {page} of log lines for scan {scanId}.
        slots:
          page: query.page
          scanId: path.scanId
      method: generated
      generated: '2026-09-26'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this

find_overlaysBrowse and filter every overlay in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This overlay

curl "https://apis.io/api/v1/overlays/soda-data-scans-api-phrasing-overlay"

All openapi overlays

curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.