-
Notifications
You must be signed in to change notification settings - Fork 214
/
piggyback.yml
110 lines (110 loc) · 3.7 KB
/
piggyback.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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# 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
description: Send a piggyback command to Pekko’s pub-sub-mediator
security:
- DevOpsBasic: []
- DevOpsBearer: []
tags:
- Devops
parameters:
- $ref: '../../parameters/timeoutParam.yml'
requestBody:
description: Fields to send a command
required: true
content:
application/json:
schema:
$ref: '../../schemas/piggyback/basePiggybackCommandRequestSchema.yml'
examples:
blockNamespace:
description: Block all messages to a namespace
value: |-
{
"targetActorSelection": "/system/distributedPubSubMediator",
"headers": {
"aggregate": false
},
"piggybackCommand": {
"type": "namespaces.commands:blockNamespace",
"namespace": "namespaceToBlock"
}
}
shutdown:
description: Shutdown all actors in a namespace
value: |-
{
"targetActorSelection": "/system/distributedPubSubMediator",
"piggybackCommand": {
"type": "common.commands:shutdown",
"reason": {
"type": "purge-namespace",
"details": "namespaceToShutdown"
}
}
}
purgeNamespace:
description: Erase all data in a namespace from the persistence
value: |-
{
"targetActorSelection": "/system/distributedPubSubMediator",
"headers": {
"aggregate": true,
"is-group-topic": true
},
"piggybackCommand": {
"type": "namespaces.commands:purgeNamespace",
"namespace": "namespaceToPurge"
}
}
unblockNamespace:
description: Unblock messages to a namespace
value: |-
{
"targetActorSelection": "/system/distributedPubSubMediator",
"headers": {
"aggregate": false
},
"piggybackCommand": {
"type": "namespaces.commands:unblockNamespace",
"namespace": "namespaceToUnblock"
}
}
responses:
'200':
description: |-
Response of command
content:
application/json:
schema:
$ref: '../../schemas/piggyback/piggybackManagingBackgroundCleanup.yml'
examples:
blockNamespace:
value: |-
{
"type": "namespaces.responses:blockNamespace",
"status": 200,
"namespace": "namespaceToBlock",
"resourceType": "namespaces"
}
'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'