-
Notifications
You must be signed in to change notification settings - Fork 216
/
serviceName.yml
80 lines (79 loc) · 2.57 KB
/
serviceName.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# Copyright (c) 2023 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This program and the accompanying materials are made available under the
# terms of the Eclipse Public License 2.0 which is available at
# http://www.eclipse.org/legal/epl-2.0
#
# SPDX-License-Identifier: EPL-2.0
post:
summary: Send a piggyback command to a specific service
description: Send a piggyback command to a specific service
security:
- DevOpsBasic: []
- DevOpsBearer: []
tags:
- Piggyback Commands
parameters:
- $ref: '../../parameters/serviceNameParam.yml'
- $ref: '../../parameters/timeoutParam.yml'
requestBody:
description: Fields to send a command
required: true
content:
application/json:
schema:
$ref: '../../schemas/piggyback/basePiggybackCommandRequestSchema.yml'
examples:
persistenceCleanup:
description: Query background cleanup coordinator state
value: |-
{
"targetActorSelection": "/user/<SERVICE_NAME>Root/persistenceCleanup",
"headers": {},
"piggybackCommand": {
"type": "status.commands:retrieveHealth"
}
}
responses:
'200':
description: |-
Return The current value of logging level
content:
application/json:
schema:
$ref: '../../schemas/piggyback/piggybackManagingBackgroundCleanup.yml'
example: |-
{
"things": {
"ditto-things-65f6dd5d7-htkwt": {
"type": "status.responses:retrieveHealth",
"status": 200,
"statusInfo": {
"status": "UP",
"details": [
{
"INFO": {
"state": "IN_QUIET_PERIOD",
"pid": ""
}
}
]
}
}
}
}
'400':
description: The request could not be completed. At least one of the defined query parameters was invalid.
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'401':
description: The request could not be completed due to missing authentication.
content:
text/plain:
schema:
$ref: '../../schemas/errors/textUnauthorizeError.yml'