Vision Developers
GET/health/ready

Readiness — unauthenticated, and it touches the database

Returns 200 when Calendar can serve and 503 when it cannot. Unlike /health/live, which is a static literal that answers 200 from a process whose database is gone, this queries the schema ledger. Unlike /calendar/v1/ready it requires no credential, because a container healthcheck or load balancer cannot hold a Vision-issued token and Calendar can only verify those, never mint one. Leaks nothing: no counts, versions, tenant or schema detail — the status code carries the meaning.

App
Calendar
Contract
Calendar API 1.20.0
Lifecycle
preview
Runtime
restricted
Operation ID
getHealthReadiness
Canonical origin
https://calendar.runonvision.com

Availability: This is a preview contract with runtime status restricted. Publication documents an approved interface; it does not imply public production access.

Purpose and use cases

Readiness — unauthenticated, and it touches the database

The owning App is Vision Calendar. Calendar owns scheduling resources, workspace and actor bindings, visibility, recurrence, conflict, and concurrency rules.

Request

GET https://calendar.runonvision.com/health/ready

Authentication and authorization

No authentication requirement is declared for this operation.

Headers

  • Accept: application/json — recommended where a JSON response is declared.

Undeclared tracing, idempotency, conditional-request, and version headers are not assumed on this page.

Path and query parameters

This operation declares no path or query parameters.

Request body

This operation declares no request body.

Runnable examples

Placeholder values are generated from the approved schema and are not live credentials or customer data. Replace every angle-bracket or shell variable value. Examples cannot be run until the App has a routed base URL and your client has the required grant.

cURL
curl 'https://calendar.runonvision.com/health/ready' \
  --request GET \
  --header 'accept: application/json'
JavaScript (server-side)
const response = await fetch('https://calendar.runonvision.com/health/ready', {
  method: 'GET',
  headers: {
    accept: 'application/json',
  },
}

if (!response.ok) throw new Error(`Vision API ${response.status}`)
const result = await response.json()
Python 3 standard library
import json
import urllib.parse
import urllib.request

request = urllib.request.Request(
    'https://calendar.runonvision.com/health/ready',
    data=None,
    headers={
    "Accept": "application/json"
},
    method='GET',
)
with urllib.request.urlopen(request, timeout=30) as response:
    result = json.load(response)

The current TypeScript reference client covers Platform token exchange and core reads. No native SDK helper is declared for this operation; use the HTTP contract directly and follow the SDK guidance.

Responses

StatusMeaningSchema
200Ready to serveobject
503Not readyobject

Success response schema

FieldTypeRulesDescription
schemaVersion"vision-calendar-health.v1"requiredNot described in the contract.
service"vision-calendar"requiredNot described in the contract.
statusalive | ready | unavailablerequiredNot described in the contract.
200 illustrative response
{
  "schemaVersion": "vision-calendar-health.v1",
  "service": "vision-calendar",
  "status": "alive"
}

Errors and troubleshooting

Error bodies and codes are shown only where the approved contract declares them. Use status, the declared error schema, and any correlation identifier returned by the App; do not infer that two Apps share one envelope.

  • 503 — Not ready

Collection behavior

Pagination: not declared. Filtering/search: not declared. Sorting: not declared.

Cursor lifetime, cursor binding, stable ordering, maximum traversal, and unknown-filter behavior are not assumed unless stated by a parameter description or schema constraint above.

Operational behavior

  • Rate limit: No operation-specific limit or 429 response is declared.
  • Retry: Retry only when the documented error model or response headers authorize it. Timeout and backoff values are not declared by this operation.
  • Idempotency: No idempotency header or replay window is declared.
  • Concurrency: No ETag, If-Match, or optimistic-version header is declared.

Security and privacy

  • Keep client credentials and bearer tokens on trusted servers.
  • Send only to the exact approved HTTPS origin and audience.
  • Treat response data according to the owning App's classification and retention policy; the OpenAPI contract does not itself grant data access.
  • Do not log credentials, tokens, complete private payloads, or secrets.

Edge cases and known documentation gaps

  • Business roles, timeout, retry budget, rate value, idempotency window, and concurrency behavior are absent unless explicitly stated above.

Contract history and evidence