-
Notifications
You must be signed in to change notification settings - Fork 3
/
.spectral.yaml
253 lines (237 loc) · 9.33 KB
/
.spectral.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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
# https://meta.stoplight.io/docs/spectral/cb95cf0d26b83-core-functions
extends:
- spectral:oas
aliases:
PathItem:
- "$.paths[*]"
OperationObject:
- "#PathItem[get,put,post,delete,options,head,patch,trace]"
DescribableObjects:
- "$.info"
- "$.tags[*]"
- "#OperationObject"
- "#PathItem.parameters[?(@ && @.in)]"
- "#OperationObject.parameters[?(@ && @.in)]"
- "$.components.schemas[*].properties[?(@ && @.type)]"
rules:
xgen-schema-properties-camel-case:
description:
All properties in the schema must be camelCase. http://go/ipa/112
severity: error
recommended: true
message: "`{{property}}` MUST follow camelCase"
given: "$.components.schemas..properties[*]~"
then:
function: pattern # casing?
functionOptions:
match: "/^[a-z$_]{1}[A-Z09$_]*/" # type: camel ?
xgen-schema-name-pascal-case:
description: OpenAPI Schema names should use PascalCase. PascalCase ensures consistency with OpenAPI generated code.
message: "`{{property}}` name must follow PascalCase. Please verify if you have provided valid @Schema(name='') annotation"
severity: error
given: "$.components.schemas[*]~"
then:
function: pattern # casing?
functionOptions:
match: "^[A-Z].*" # type: pascal ?
xgen-description:
description: "Use this field to describe the action performed by each specific API endpoint or property, to provide context for how to use it to the users of the API."
message: "{{error}}."
severity: error
given: "#DescribableObjects"
then:
- field: "description"
function: truthy
- field: "description"
function: pattern
functionOptions:
match: "/^[A-Z]/"
- field: "description"
function: pattern
functionOptions:
match: "\\.|\|$"
xgen-request-GET-no-body:
description: "A 'GET' request MUST NOT accept a 'body` parameter. http://go/ipa/104"
severity: error
given: $.paths..get.parameters..in
then:
function: pattern
functionOptions:
notMatch: "/^body$/"
xgen-request-DELETE-no-body:
description: "A 'DELETE' request MUST NOT accept a 'body` parameter. http://go/ipa/108"
severity: error
given: $.paths..delete.parameters..in
then:
function: pattern
functionOptions:
notMatch: "/^body$/"
xgen-no-security:
description: "Operation MUST have security definition"
severity: error
given: "#OperationObject"
then:
field: "security"
function: truthy
xgen-docs-tags-alphabetical:
message: "Tags should be defined in alphabetical order."
description: "Many documentation tools show tags in the order they are defined, so defining them not in alphabetical order can look funny to API consumers."
severity: error
given: "$"
then:
field: "tags"
function: alphabetical
functionOptions:
keyedBy: "name"
xgen-docs-tags:
message: "{{error}}."
description: "Tags help group logic into conceptual groups instead of making end-users dig through URLs or lists of operation names."
severity: error
given: "$"
then:
field: "tags"
function: schema
functionOptions:
schema:
type: "array"
minItems: 1
xgen-docs-operation-tags:
message: "Operation should have non-empty `tags` array."
description:
"Once tags are defined they should be references in the operation, otherwise they will not be doing anything."
severity: error
given: "#OperationObject"
then:
field: "tags"
function: schema
functionOptions:
schema:
type: "array"
minItems: 1
xgen-docs-operationId-valid-in-url:
message: "operationId must only contain URL friendly characters."
description: "Most documentation tools use the operationId to produce URLs, so the characters used must be safe and legal when used in the URL."
severity: error
given: "#OperationObject"
then:
field: "operationId"
function: pattern
functionOptions:
match: "^[A-Za-z0-9-._~:/?#\\[\\]@!\\$&'()*+,;=]*$"
xgen-docs-parameter-examples-or-schema:
message: "No example or schema provided for {{property}}."
description: "Without providing a well defined schema or example(s) an API consumer will have a hard time knowing how to interact with this API."
severity: error
given: "$.paths[*]..parameters[*]"
then:
function: schema
functionOptions:
schema:
anyOf:
- required: ["example"]
- required: ["examples"]
- required: ["schema"]
x-xgen-hidden-env-format:
description: "Ensure x-xgen-hidden-env extension has the correct format. https://go/openapi-hidden-extension"
severity: error
given: "$..x-xgen-hidden-env" # Match anywhere in the document
then:
- field: envs
function: truthy
- field: envs
function: pattern
functionOptions:
match: "^(dev|qa|stage|prod)(,(dev|qa|stage|prod))*$"
soa-migration-extension:
description: "Ensure the x-xgen-soa-migration extension is valid."
message: "The x-xgen-soa-migration extension must include 'service_name', 'allow_diff', and 'source_service' should only be present when 'allow_diff' is true."
formats: ["oas3"]
given: "$.paths[*][*].x-xgen-soa-migration"
severity: error
then:
- field: service_name
function: truthy
message: "'service_name' must be provided."
- field: allow_diff
function: pattern
functionOptions:
match: "^(true|false)$"
message: "'allow_diff' must be true or false."
- function: falsy
field: source_service
message: "'source_service' should not exist when 'allow_diff' is false."
when:
field: allow_diff
pattern: "^false$"
- function: truthy
field: source_service
message: "'source_service' must be provided when 'allow_diff' is true."
when:
field: allow_diff
pattern: "^true$"
no-slash-before-custom-method:
description: "Custom methods (e.g., ':applyItem') should not be preceded by a '/'."
message: "The path '{{path}}' contains a '/' before a custom method. Custom methods should not start with a '/'."
severity: error
given: "$.paths"
then:
field: "@key"
function: pattern
functionOptions:
notMatch: "/[^/]+/:[a-zA-Z]+$"
overrides:
- files: # load sample data has an issue with different path param names for different VERBS
- "*.yaml#/paths/~1api~1atlas~1v1.0~1groups~1%7BgroupId%7D~1sampleDatasetLoad~1%7BsampleDatasetId%7D"
- "*.yaml#/paths/~1api~1atlas~1v1.0~1groups~1%7BgroupId%7D~1sampleDatasetLoad~1%7Bname%7D"
- "*.yaml#/paths/~1api~1atlas~1v2~1groups~1%7BgroupId%7D~1sampleDatasetLoad~1%7Bname%7D"
- "*.yaml#/paths/~1api~1atlas~1v2~1groups~1%7BgroupId%7D~1sampleDatasetLoad~1%7BsampleDatasetId%7D"
rules:
path-params: "off"
- files:
- "*.yaml#/components/schemas/raw"
- "*.yaml#/components/schemas/charFilterhtmlStrip"
- "*.yaml#/components/schemas/charFiltericuNormalize"
- "*.yaml#/components/schemas/charFiltermapping"
- "*.yaml#/components/schemas/charFilterpersian"
- "*.yaml#/components/schemas/tokenizernGram"
- "*.yaml#/components/schemas/tokenizeredgeGram"
- "*.yaml#/components/schemas/tokenizerkeyword"
- "*.yaml#/components/schemas/tokenizerregexCaptureGroup"
- "*.yaml#/components/schemas/tokenizerregexSplit"
- "*.yaml#/components/schemas/tokenizerstandard"
- "*.yaml#/components/schemas/tokenizeruaxUrlEmail"
- "*.yaml#/components/schemas/tokenizerwhitespace"
- "*.yaml#/components/schemas/tokenFilterasciiFolding"
- "*.yaml#/components/schemas/tokenFilterdaitchMokotoffSoundex"
- "*.yaml#/components/schemas/tokenFilteredgeGram"
- "*.yaml#/components/schemas/tokenFiltericuFolding"
- "*.yaml#/components/schemas/tokenFiltericuNormalizer"
- "*.yaml#/components/schemas/tokenFilterlength"
- "*.yaml#/components/schemas/tokenFilterlowercase"
- "*.yaml#/components/schemas/tokenFilternGram"
- "*.yaml#/components/schemas/tokenFilterregex"
- "*.yaml#/components/schemas/tokenFilterreverse"
- "*.yaml#/components/schemas/tokenFiltershingle"
- "*.yaml#/components/schemas/tokenFiltersnowballStemming"
- "*.yaml#/components/schemas/tokenFilterstopword"
- "*.yaml#/components/schemas/tokenFiltertrim"
rules:
xgen-schema-name-pascal-case: "off"
- files:
- "*.yaml#/components/schemas/IndexOptions"
- "*.yaml#/components/schemas/NetworkPermissionEntryStatus"
rules:
xgen-schema-properties-camel-case: "off"
- files:
- "*.yaml#/components/schemas/DataLakeStoreSettings/properties/provider" # dynamic field which can't be documented
- "*.yaml#/components/schemas/ClusterProviderSettings/properties/providerName" # dynamic field which can't be documented
rules:
xgen-description: "off"
- files:
- "*.yaml#/paths/~1api~1atlas~1v2~1unauth~1controlPlaneIPAddresses/get"
rules:
xgen-no-security: "off"
- files:
- "**#/components/schemas/ApiError/properties/parameters" # see https://github.com/stoplightio/spectral/issues/2592
rules:
xgen-docs-parameter-examples-or-schema: "off"