Redocly · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Redocly Scout Status API

2 actions 2 updates phrasing extends openapi/redocly-status-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/orgs/{orgId}/projects/{projectId}/scout/status'].post

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 Redocly Scout Status API
  version: 1.0.0
extends: openapi/redocly-status-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: 1
- target: $.paths['/orgs/{orgId}/projects/{projectId}/scout/status'].post
  update:
    x-apievangelist-phrasing:
      intent: Report a Scout instance's status and disk usage
      effect: write
      questions:
      - What does a Scout instance send when it reports its status back to Redocly?
      - Can Scout report its hostname, version, disk usage and running jobs?
      instructions:
      - text: Report status for Scout host {hostname} version {version} in project {projectId}, org {orgId}.
        slots:
          hostname: requestBody.hostname
          version: requestBody.version
          projectId: path.projectId
          orgId: path.orgId
      - text: Send a Scout heartbeat for process {pid} on {hostname} with disk {disk} and jobs {jobs} to project {projectId} in org {orgId}, version {version}.
        slots:
          pid: requestBody.pid
          hostname: requestBody.hostname
          disk: requestBody.disk
          jobs: requestBody.jobs
          projectId: path.projectId
          orgId: path.orgId
          version: requestBody.version
      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/redocly-status-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.