Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

safety-guardian OpenAPI Specification

Complete OpenAPI 3.0 specification for the Safety Guardian service.

Interactive Documentation

When running locally, access interactive API documentation at:

  • Swagger UI: http://localhost:XXXX/docs
  • ReDoc: http://localhost:XXXX/redoc

OpenAPI YAML Specification

The complete OpenAPI 3.0 specification is available as a YAML file:

File: docs/src/api/openapi-yaml/safety-guardian.yaml

Download: safety-guardian.yaml

Generating Clients

Use OpenAPI Generator to create client SDKs in any language:

openapi-generator-cli generate \
  -i docs/api/openapi/safety-guardian.yaml \
  -g <language> \
  -o clients/<language>

Supported languages: python, typescript, java, go, rust, and 50+ others.

See Also