health-api Specification

Mon, 01 Jan 0001 00:00:00 +0000

Purpose

Provide a runnable HTTP foundation for the MLOps course with a health check, an inspectable API description, and independent application instances.

Requirements

Requirement: Provide an operational health endpoint

The service SHALL respond to GET /health with HTTP 200 and the JSON object {“status”: “ok”}. The response SHALL indicate that the HTTP application is running without invoking recommendation computation or external services.

Scenario: Check a running application

WHEN a client sends GET /health to a running service
THEN it receives HTTP 200 with application/json content and {“status”: “ok”}

Requirement: Publish the generated API description and documentation

The service SHALL provide a valid OpenAPI document at GET /openapi.json, including the health endpoint and its successful response contract. It SHALL provide the default documentation pages at /docs and /redoc, configured to use that schema URL.

Health api on Alwaldend

health-api Specification

Purpose

Requirements

Requirement: Provide an operational health endpoint

Scenario: Check a running application

Requirement: Publish the generated API description and documentation