SREDSimplify Docs

Appearance

SREDSimplify APIReference Hub

Authentication, response contracts, compatibility rules, and pointers to generated OpenAPI docs.

Core resources
Sessions and runs

Generated backend docs

Springdoc exposes the live Java endpoint catalog at local Swagger UI when the backend is running.

Internal worker docs

FastAPI exposes the Python worker contract for internal service-to-service integrations.

Stable hand-written guidance

This section documents auth, error envelopes, and compatibility expectations even when services are offline.

API reference ​

Use this section when you need the contract, not just the architecture.

Generated API docs ​

These runtime surfaces are the most accurate endpoint catalogs when the stack is running locally:

SurfaceLocal URLNotes
Spring Boot APIhttp://localhost:7000/swagger-ui/index.htmlReplace 7000 with 8080 if you started the backend via start.sh
FastAPI workerhttp://localhost:7002/docsReplace 7002 with 8000 if you started the Python service with API_PORT=8000

The Java backend already publishes OpenAPI for /api/v1/** and /internal/api/v1/**. The Python worker docs are useful for internal integration work, but that service is not a browser-facing public API.

What is documented here ​

What is not documented here ​

  • Product walkthroughs and architecture rationale: use the architecture hub
  • Local startup and debugging: use Quickstart
  • Production operations: use Ops