Skip to main content

generate_openapi_effective

lemma_openapi

Function generate_openapi_effective 

Source 
pub fn generate_openapi_effective(
    engine: &Engine,
    explanations_enabled: bool,
    effective: &DateTimeValue,
) -> Value
Expand description

Generate a complete OpenAPI 3.1 specification for a specific point in time.

The specification includes:

  • Spec endpoints (/{spec_name}) with ?rules= query parameter; path is spec id (name or name~hash)
  • GET operations (schema) and POST operations (evaluate) with Accept-Datetime header
  • Response schemas with evaluation envelope (spec, effective, hash, result)
  • Meta routes (/, /health, /openapi.json, /docs)

When explanations_enabled is true, the spec adds the x-explanations header parameter to evaluation endpoints and describes the optional explanation object in responses.