docs(quotesdb): add /api/status to OpenAPI spec

Add GET /api/status path and StatusResponse schema. The endpoint
returns { "submissions_locked": bool } with 200 or 500, requires
no auth, and is tagged under the existing `meta` group.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
main
Elijah Voigt 3 months ago
parent feac146403
commit f0b10d506c

@ -179,6 +179,17 @@ components:
type: integer type: integer
description: Total number of quotes matching the current filters. description: Total number of quotes matching the current filters.
# Response body for GET /api/status.
StatusResponse:
type: object
required:
- submissions_locked
properties:
submissions_locked:
type: boolean
description: Whether new quote submissions are currently disabled.
example: false
# Standard error envelope used by all error responses. # Standard error envelope used by all error responses.
Error: Error:
type: object type: object
@ -213,6 +224,29 @@ paths:
type: object type: object
description: Raw OpenAPI 3.1 document. description: Raw OpenAPI 3.1 document.
/api/status:
get:
operationId: getStatus
summary: API status
description: >
Returns the current operational status of the API. Callers can check
submissions_locked to determine whether the PUT /api/quotes endpoint
is accepting new submissions.
tags: [meta]
responses:
"200":
description: Current API status.
content:
application/json:
schema:
$ref: "#/components/schemas/StatusResponse"
"500":
description: Internal server error.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/api/quotes: /api/quotes:
get: get:
operationId: listQuotes operationId: listQuotes

Loading…
Cancel
Save