Adapt reference for /health to the latest refactoring
...
This commit is contained in:
parent
d576ea54ca
commit
2d211cd4c2
|
@ -1,17 +1,16 @@
|
||||||
get:
|
get:
|
||||||
summary: Get node health status
|
summary: Get node health status
|
||||||
description: Retrieve readiness of a Waku v2 node.
|
description: Retrieve status of a Waku v2 node.
|
||||||
operationId: healthcheck
|
operationId: healthcheck
|
||||||
tags:
|
tags:
|
||||||
- health
|
- health
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
description: Waku v2 node is up and running.
|
description: Health report of a Waku v2 node and its protocols.
|
||||||
content:
|
content:
|
||||||
text/plain:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: string
|
$ref: "./schemas/apitypes.yaml#/HealthReport"
|
||||||
example: Node is healty
|
|
||||||
'500':
|
'500':
|
||||||
description: Internal server error
|
description: Internal server error
|
||||||
content:
|
content:
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
openapi: 3.0.3
|
openapi: 3.1.0
|
||||||
info:
|
info:
|
||||||
title: Waku V2 node REST API
|
title: Waku V2 node REST API
|
||||||
version: 1.0.0
|
version: 1.0.0
|
||||||
|
|
|
@ -252,3 +252,26 @@ FilterSubscription:
|
||||||
type: string
|
type: string
|
||||||
contentTopic:
|
contentTopic:
|
||||||
type: string
|
type: string
|
||||||
|
|
||||||
|
HealthStatus:
|
||||||
|
type: string
|
||||||
|
enum:
|
||||||
|
- "Initializing"
|
||||||
|
- "Synchronizing"
|
||||||
|
- "Ready"
|
||||||
|
- "Not Ready"
|
||||||
|
- "Not Mounted"
|
||||||
|
- "Shutting Down"
|
||||||
|
|
||||||
|
HealthReport:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
nodeHealth:
|
||||||
|
$ref: '#/HealthStatus'
|
||||||
|
description: Overall health status of the node
|
||||||
|
protocolsHealth:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
additionalProperties:
|
||||||
|
$ref: '#/HealthStatus'
|
||||||
|
|
Loading…
Reference in New Issue