# API Catalog

Category: Agent readiness
Version: 1.0.0

## Goal
Publish an API catalog at /.well-known/api-catalog so agents can discover your API documentation and schemas without crawling.

## Issue
The audited site did not satisfy the API Catalog readiness check.

## Fix
Create /.well-known/api-catalog returning `application/linkset+json` with a `linkset` array. Each entry should include an `anchor` URL for the API and link relations like `service-desc` (OpenAPI spec), `service-doc` (human docs), and `status` (health endpoint). See RFC 9727 Appendix A for examples and RFC 9264 for the linkset format.

## Validation
- Confirm content types, payload shape, and discoverability from the public web surface.
- Verify against fresh public evidence, not only local source changes.
- Re-run the relevant isitready.dev scan before claiming the issue is closed.

## Copyable Fix Prompt
```text
Outcome: make this single public-readiness issue pass for the audited site.

Goal: API Catalog for https://example.com

Issue: The audited site did not satisfy the API Catalog readiness check.

Fix: Create /.well-known/api-catalog returning `application/linkset+json` with a `linkset` array. Each entry should include an `anchor` URL for the API and link relations like `service-desc` (OpenAPI spec), `service-doc` (human docs), and `status` (health endpoint). See RFC 9727 Appendix A for examples and RFC 9264 for the linkset format.

Skill: /.well-known/agent-skills/api-catalog/SKILL.md

Docs: https://www.rfc-editor.org/rfc/rfc9727

Validation: Confirm content types, payload shape, and discoverability from the public web surface.

Requirements: preserve existing product behavior, add or update relevant tests, and validate public response shape/content type where applicable.

When done, tell the user to re-run the public scan at https://isitready.dev so they can verify this issue now passes. Do not claim it is fixed until a fresh report confirms.
```