Skip to content

docs(api): document the machine-readable /apis.json index - #403

Merged
jirkasemmler merged 1 commit into
mainfrom
jirka/apis-json-docs
Jul 15, 2026
Merged

docs(api): document the machine-readable /apis.json index#403
jirkasemmler merged 1 commit into
mainfrom
jirka/apis-json-docs

Conversation

@jirkasemmler

@jirkasemmler jirkasemmler commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

What

Adds a Machine-Readable API Index section to the Our APIs page (/overview/api/), between API Documentation Portals and Service Endpoints.

Each stack's API portal publishes a machine-readable index of its APIs at https://api.<stack>/apis.json (e.g. https://api.keboola.com/apis.json), listing each service with its base apiUrl and a link to its OpenAPI spec (openApiSpecUrl). Intended for agentic usage and tooling (AI agents, MCP servers, CI). Introduced in keboola/api-service#101.

The endpoint is live in production (https://api.keboola.com/apis.json → 200).

Companion changes: connection-docs (/ai/) and api-service (portal UI banner).

🤖 Generated with Claude Code

Add a "Machine-Readable API Index" section to the Our APIs page,
between the API Documentation Portals and Service Endpoints sections.
Each stack's portal publishes a machine-readable index of its APIs at
https://api.<stack>/apis.json (services with apiUrl + openApiSpecUrl),
intended for agentic usage and tooling.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@jirkasemmler
jirkasemmler requested a review from Matovidlo July 15, 2026 09:37
@jirkasemmler
jirkasemmler merged commit b304408 into main Jul 15, 2026
1 check passed
@jirkasemmler
jirkasemmler deleted the jirka/apis-json-docs branch July 15, 2026 10:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants