49 lines
1.1 KiB
Cheetah
49 lines
1.1 KiB
Cheetah
|
---
|
||
|
|
tags:
|
||
|
|
- name: Monitoring
|
||
|
|
description: Monitoring routes
|
||
|
|
definitions:
|
||
|
|
MonPing:
|
||
|
|
type: object
|
||
|
|
properties:
|
||
|
|
status:
|
||
|
|
type: object
|
||
|
|
x-nullable: true
|
||
|
|
properties:
|
||
|
|
database:
|
||
|
|
type: boolean
|
||
|
|
description: State of the database
|
||
|
|
application:
|
||
|
|
type: boolean
|
||
|
|
description: State of the application
|
||
|
|
details:
|
||
|
|
type: object
|
||
|
|
x-nullable: true
|
||
|
|
properties:
|
||
|
|
app_version:
|
||
|
|
type: string
|
||
|
|
description: Application version
|
||
|
|
git_hash:
|
||
|
|
type: string
|
||
|
|
description: Git hash of the last commit
|
||
|
|
paths:
|
||
|
|
#
|
||
|
|
# SECTION : MONITORING
|
||
|
|
#
|
||
|
|
/mon/ping:
|
||
|
|
get:
|
||
|
|
tags:
|
||
|
|
- Monitoring
|
||
|
|
summary: Health check
|
||
|
|
description: Return Health status of the app with additionnal info such as the version
|
||
|
|
operationId: getMonPing
|
||
|
|
responses:
|
||
|
|
200:
|
||
|
|
description: Health OK
|
||
|
|
schema:
|
||
|
|
$ref: "#/definitions/MonPing"
|
||
|
|
default:
|
||
|
|
description: Default error message
|
||
|
|
schema:
|
||
|
|
$ref: "#/definitions/Error"
|