Initial commit
This commit is contained in:
36
lib/api-spec/openapi.yaml
Normal file
36
lib/api-spec/openapi.yaml
Normal file
@@ -0,0 +1,36 @@
|
||||
openapi: 3.1.0
|
||||
info:
|
||||
# Do not change the title, if the title changes, the import paths will be broken
|
||||
title: Api
|
||||
version: 0.1.0
|
||||
description: API specification
|
||||
servers:
|
||||
- url: /api
|
||||
description: Base API path
|
||||
tags:
|
||||
- name: health
|
||||
description: Health operations
|
||||
paths:
|
||||
/healthz:
|
||||
get:
|
||||
operationId: healthCheck
|
||||
tags: [health]
|
||||
summary: Health check
|
||||
description: Returns server health status
|
||||
responses:
|
||||
"200":
|
||||
description: Healthy
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/HealthStatus"
|
||||
components:
|
||||
schemas:
|
||||
HealthStatus:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
required:
|
||||
- status
|
||||
|
||||
Reference in New Issue
Block a user