Skip to content
FedShield

API reference

The interactive API reference is rendered from the canonical OpenAPI 3.1 specification shipped in the federation-core repository. Use the embedded Scalar viewer below, or grab the raw spec and run it through your own toolchain.

Grab the spec

Section titled “Grab the spec”

The OpenAPI 3.1 document is hosted on this site so any OpenAPI-compatible tool can consume it:

Terminal window
curl https://fedshield-docs.pages.dev/openapi.yaml > fedshield.openapi.yaml

It mirrors the source of truth in the federation-core repo. Updates land in the repo first; this site rebuilds from it on every deploy.

Useful tooling

Section titled “Useful tooling”
  • openapi-generator — generate idiomatic clients for ~50 languages.
  • oapi-codegen — Go-native code generation.
  • Bruno or Insomnia — open the spec, get a ready-made request collection.
  • Spectral — lint the spec yourself. The repo’s CI runs Spectral on every push, so you can run the same ruleset locally.