-
Notifications
You must be signed in to change notification settings - Fork 5
/
validator-registry.yaml
171 lines (171 loc) · 4.55 KB
/
validator-registry.yaml
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
openapi: 3.0.0
info:
title: Validator Registry
version: v1
servers:
- url: /tenant/
paths:
/rules:
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: "#/components/schemas/validationRuleCollection"
'422':
$ref: "#/components/responses/trait_validate_422"
'500':
description: Internal server error
content:
text/plain:
schema:
type: string
example: Internal server error
description: Get a list of existing validation rules for a tenant
operationId: getTenantRules
parameters:
- $ref: "#/components/parameters/trait_pageable_offset"
- $ref: "#/components/parameters/trait_pageable_limit"
- $ref: "#/components/parameters/trait_queryable_query"
post:
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: "#/components/schemas/validationRule"
'400':
description: Bad request
content:
text/plain:
schema:
type: string
example: Bad request
'422':
$ref: "#/components/responses/trait_validate_422"
'500':
description: Internal server error
content:
text/plain:
schema:
type: string
example: Internal server error
description: Add a rule to a tenant
operationId: postTenantRules
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/validationRule"
required: true
put:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: "#/components/schemas/validationRule"
'400':
description: Bad request
content:
text/plain:
schema:
type: string
example: Bad request
'404':
description: Rule not found
content:
text/plain:
schema:
type: string
example: Rule not found
'500':
description: Internal server error
content:
text/plain:
schema:
type: string
example: Internal server error
description: Enable/disable/change the rule
operationId: putTenantRule
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/validationRule"
required: true
/rules/{ruleId}:
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: "#/components/schemas/validationRule"
'404':
description: Rule not found
content:
text/plain:
schema:
type: string
example: Rule not found
'500':
description: Internal server error
content:
text/plain:
schema:
type: string
example: Internal server error
operationId: getTenantRuleById
parameters:
- name: ruleId
in: path
required: true
schema:
type: string
components:
responses:
trait_validate_422:
description: Validation errors
content:
application/json:
schema:
$ref: "#/components/schemas/errors"
schemas:
validationRuleCollection:
$ref: schemas/validationRules.json
validationRule:
$ref: schemas/validationRule.json
errors:
$ref: schemas/errors.json
parameters:
trait_queryable_query:
name: query
in: query
description: A query string to filter rules based on matching criteria in fields.
schema:
type: string
trait_pageable_offset:
name: offset
in: query
description: Skip over a number of elements by specifying an offset value for
the query
schema:
default: 0
minimum: 0
maximum: 2147483647
type: integer
trait_pageable_limit:
name: limit
in: query
description: Limit the number of elements returned in the response
schema:
default: 10
minimum: 0
maximum: 2147483647
type: integer