Migrate from the Swagger documentation

This documentation site replaces the Swagger UI as the canonical guide for API v2. Every public /v2 operation in the maintained schema has a generated page with authentication, permission scope, parameters, examples, success data, errors, rate-limit guidance, and related endpoints.

Replace old bookmarksCopy link to Replace old bookmarks

Legacy destination	Replacement
API host /docs or /docs/	API v2 overview
Swagger Members tag	Member endpoints
Swagger Configuration tag	Rank endpoints
Swagger Moderation tag	Blacklist endpoints
Swagger Events tag	Event endpoints
Swagger JSON document	Maintained OpenAPI JSON

Swagger deep links use a URL fragment after #. Browsers do not send that fragment to the server, so a server redirect cannot preserve the selected operation. Use full-site search here for the method, path, or operation title.

Update an integrationCopy link to Update an integration

1. Replace a bookmarked Swagger page with the matching generated endpoint page.
2. Verify the method and /v2 path against the current route.
3. Replace copied legacy headers with the Bearer key and X-Clan-Id format.
4. Verify the required scope and community feature.
5. Update success handling to read data and error handling to read error.code.
6. Regenerate client types from /openapi.json if your project uses them.

Deprecation stateCopy link to Deprecation state

The API repository still exposes Swagger at its /docs route while parity and redirect deployment are verified. It should not be removed before inbound links are updated and production redirects are confirmed. No removal date is published.

Aliases controlled by this documentation deployment—/swagger, /swagger-ui/*, /api/docs, /api, and /reference—redirect into the new reference. Redirects on the separate API hostname must be deployed with the API service.

Maintainers can find the exact source-to-destination inventory and rollout checklist in maintenance/legacy-swagger-map.json and maintenance/swagger-migration.md in this repository.