Skip to main content

models

Typed request and response contracts exposed by exp.arolariu.ro.

The service intentionally models API and website payloads separately so each consumer receives a documented contract that matches its own build-time and run-time needs. The /api/v1/config endpoint uses a dedicated single-config response model because it serves one indexed value at a time instead of an entire target document.

ExpModel Objects​

class ExpModel(BaseModel)

Base model configuration shared across immutable exp payload contracts.

ErrorResponse Objects​

class ErrorResponse(ExpModel)

Represents a standardized error payload returned by exp endpoints.

HealthResponse Objects​

class HealthResponse(ExpModel)

Represents a liveness response payload enriched with process diagnostics.

ReadyResponse Objects​

class ReadyResponse(HealthResponse)

Represents a readiness response payload.

ApiBuildTimeConfig Objects​

class ApiBuildTimeConfig(ExpModel)

Configuration values required to boot the API service and schedule refreshes.

Every field in this model is server-only. The API uses these values to wire authentication, dependency endpoints, and data-store connectivity.

ApiRunTimeConfig Objects​

class ApiRunTimeConfig(ApiBuildTimeConfig)

Configuration values used by the API during background refresh and request handling.

The API currently requires the same key set at build-time and at run-time, but the separate model keeps the contract explicit and leaves room for future divergence without changing consumer semantics.

WebsiteBuildTimeConfig Objects​

class WebsiteBuildTimeConfig(ExpModel)

Configuration values needed to build and boot the website server runtime.

Includes both server-side infrastructure config AND build-time env vars (Site:, Auth:Clerk:) that the CI/CD pipeline injects into the container via the generated .env file.

WebsiteRunTimeConfig Objects​

class WebsiteRunTimeConfig(WebsiteBuildTimeConfig)

Configuration values used by the website during server-side request execution.

Run-time website config extends the build-time document with server-only secrets such as the JWT signing secret and optional communication-provider credentials.

BaseConfigDocumentResponse Objects​

class BaseConfigDocumentResponse(ExpModel)

Shared envelope for target-scoped build-time and run-time config documents.

ApiBuildTimeConfigDocumentResponse Objects​

class ApiBuildTimeConfigDocumentResponse(BaseConfigDocumentResponse)

Build-time payload returned by GET /api/v1/build-time?for=api.

WebsiteBuildTimeConfigDocumentResponse Objects​

class WebsiteBuildTimeConfigDocumentResponse(BaseConfigDocumentResponse)

Build-time payload returned by GET /api/v1/build-time?for=website.

ApiRunTimeConfigDocumentResponse Objects​

class ApiRunTimeConfigDocumentResponse(BaseConfigDocumentResponse)

Run-time payload returned by GET /api/v1/run-time?for=api.

WebsiteRunTimeConfigDocumentResponse Objects​

class WebsiteRunTimeConfigDocumentResponse(BaseConfigDocumentResponse)

Run-time payload returned by GET /api/v1/run-time?for=website.

ConfigValueResponse Objects​

class ConfigValueResponse(ExpModel)

Single indexed configuration value returned by GET /api/v1/config?name=....

This response surfaces one configuration entry at a time together with the server-authored documentation that explains where the value is used and which callers are allowed to request it.

// was this page useful?