Skip to content

Commit 4cd3f07

Browse files
committed
harmonize `` syntax & description
1 parent 1613123 commit 4cd3f07

19 files changed

Lines changed: 1109 additions & 1150 deletions

AddressValidation.yaml

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ paths:
9696
content:
9797
application/json:
9898
schema:
99-
"$ref": "#/components/schemas/XAVRequestWrapper"
99+
$ref: "#/components/schemas/XAVRequestWrapper"
100100
examples:
101101
json:
102102
summary: A sample JSON request (Standard Example)
@@ -122,31 +122,31 @@ paths:
122122
content:
123123
application/json:
124124
schema:
125-
"$ref": "#/components/schemas/XAVResponseWrapper"
125+
$ref: "#/components/schemas/XAVResponseWrapper"
126126
'400':
127127
description: Invalid Request
128128
content:
129129
application/json:
130130
schema:
131-
"$ref": "#/components/schemas/ErrorResponse"
131+
$ref: "#/components/schemas/ErrorResponse"
132132
'401':
133133
description: Unauthorized Request
134134
content:
135135
application/json:
136136
schema:
137-
"$ref": "#/components/schemas/ErrorResponse"
137+
$ref: "#/components/schemas/ErrorResponse"
138138
'403':
139139
description: Blocked Merchant
140140
content:
141141
application/json:
142142
schema:
143-
"$ref": "#/components/schemas/ErrorResponse"
143+
$ref: "#/components/schemas/ErrorResponse"
144144
'429':
145145
description: Rate Limit Exceeded
146146
content:
147147
application/json:
148148
schema:
149-
"$ref": "#/components/schemas/ErrorResponse"
149+
$ref: "#/components/schemas/ErrorResponse"
150150
"/addressvalidation/{deprecatedVersion}/{requestoption}":
151151
post:
152152
deprecated: true
@@ -216,7 +216,7 @@ paths:
216216
content:
217217
application/json:
218218
schema:
219-
"$ref": "#/components/schemas/XAVRequestWrapper"
219+
$ref: "#/components/schemas/XAVRequestWrapper"
220220
examples:
221221
json:
222222
summary: A sample JSON request (Standard Example)
@@ -242,31 +242,31 @@ paths:
242242
content:
243243
application/json:
244244
schema:
245-
"$ref": "#/components/schemas/XAVResponseWrapper"
245+
$ref: "#/components/schemas/XAVResponseWrapper"
246246
'400':
247247
description: Invalid Request
248248
content:
249249
application/json:
250250
schema:
251-
"$ref": "#/components/schemas/ErrorResponse"
251+
$ref: "#/components/schemas/ErrorResponse"
252252
'401':
253253
description: Unauthorized Request
254254
content:
255255
application/json:
256256
schema:
257-
"$ref": "#/components/schemas/ErrorResponse"
257+
$ref: "#/components/schemas/ErrorResponse"
258258
'403':
259259
description: Blocked Merchant
260260
content:
261261
application/json:
262262
schema:
263-
"$ref": "#/components/schemas/ErrorResponse"
263+
$ref: "#/components/schemas/ErrorResponse"
264264
'429':
265265
description: Rate Limit Exceeded
266266
content:
267267
application/json:
268268
schema:
269-
"$ref": "#/components/schemas/ErrorResponse"
269+
$ref: "#/components/schemas/ErrorResponse"
270270
components:
271271
securitySchemes:
272272
OAuth2:
@@ -294,7 +294,7 @@ components:
294294
- XAVRequest
295295
properties:
296296
XAVRequest:
297-
"$ref": "#/components/schemas/XAVRequest"
297+
$ref: "#/components/schemas/XAVRequest"
298298
XAVResponseWrapper:
299299
xml:
300300
name: XAVResponse
@@ -305,17 +305,17 @@ components:
305305
- XAVResponse
306306
properties:
307307
XAVResponse:
308-
"$ref": "#/components/schemas/XAVResponse"
308+
$ref: "#/components/schemas/XAVResponse"
309309
XAVRequest:
310310
type: object
311311
required:
312312
- AddressKeyFormat
313313
- Request
314314
properties:
315315
Request:
316-
"$ref": "#/components/schemas/XAVRequest_Request"
316+
$ref: "#/components/schemas/XAVRequest_Request"
317317
RegionalRequestIndicator:
318-
description: >
318+
description: >-
319319
If this indicator is present then either the region element
320320
or any combination of Political Division 1, Political Division 2, PostcodePrimaryLow
321321
and the PostcodeExtendedLow fields will be recognized for validation in
@@ -336,7 +336,7 @@ components:
336336
minLength: 1
337337
maxLength: 2
338338
AddressKeyFormat:
339-
"$ref": "#/components/schemas/XAVRequest_AddressKeyFormat"
339+
$ref: "#/components/schemas/XAVRequest_AddressKeyFormat"
340340
xml:
341341
name: XAVRequest
342342
maximum: 1
@@ -367,7 +367,7 @@ components:
367367
minLength: 1
368368
maxLength: 1
369369
TransactionReference:
370-
"$ref": "#/components/schemas/Request_TransactionReference"
370+
$ref: "#/components/schemas/Request_TransactionReference"
371371
xml:
372372
name: Request
373373
required:
@@ -474,7 +474,7 @@ components:
474474
- Response
475475
properties:
476476
Response:
477-
"$ref": "#/components/schemas/XAVResponse_Response"
477+
$ref: "#/components/schemas/XAVResponse_Response"
478478
ValidAddressIndicator:
479479
description: Indicates query found a valid match.
480480
maximum: 1
@@ -489,15 +489,15 @@ components:
489489
maximum: 1
490490
type: string
491491
AddressClassification:
492-
"$ref": "#/components/schemas/XAVResponse_AddressClassification"
492+
$ref: "#/components/schemas/XAVResponse_AddressClassification"
493493
Candidate:
494494
description: |
495495
Candidate Container.
496496
497497
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, this element will be returned as an array if there is more than one object and a single object if there is only 1.
498498
type: array
499499
items:
500-
"$ref": "#/components/schemas/XAVResponse_Candidate"
500+
$ref: "#/components/schemas/XAVResponse_Candidate"
501501
xml:
502502
name: XAVResponse
503503
maximum: 1
@@ -508,17 +508,17 @@ components:
508508
- ResponseStatus
509509
properties:
510510
ResponseStatus:
511-
"$ref": "#/components/schemas/Response_ResponseStatus"
511+
$ref: "#/components/schemas/Response_ResponseStatus"
512512
Alert:
513513
description: |
514514
Alert Container. There can be zero to many alert containers with code and description.
515515
516516
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, this element will be returned as an array if there is more than one object and a single object if there is only 1.
517517
type: array
518518
items:
519-
"$ref": "#/components/schemas/Response_Alert"
519+
$ref: "#/components/schemas/Response_Alert"
520520
TransactionReference:
521-
"$ref": "#/components/schemas/Response_TransactionReference"
521+
$ref: "#/components/schemas/Response_TransactionReference"
522522
xml:
523523
name: Response
524524
description: Response Container.
@@ -617,9 +617,9 @@ components:
617617
type: object
618618
properties:
619619
AddressClassification:
620-
"$ref": "#/components/schemas/Candidate_AddressClassification"
620+
$ref: "#/components/schemas/Candidate_AddressClassification"
621621
AddressKeyFormat:
622-
"$ref": "#/components/schemas/Candidate_AddressKeyFormat"
622+
$ref: "#/components/schemas/Candidate_AddressKeyFormat"
623623
xml:
624624
name: Candidate
625625
required:
@@ -739,7 +739,7 @@ components:
739739
type: object
740740
properties:
741741
response:
742-
"$ref": "#/components/schemas/CommonErrorResponse"
742+
$ref: "#/components/schemas/CommonErrorResponse"
743743
CommonErrorResponse:
744744
type: object
745745
description: The error response containing any errors that occurred.
@@ -748,7 +748,7 @@ components:
748748
type: array
749749
description: The error array containing any errors that occurred.
750750
items:
751-
"$ref": "#/components/schemas/ErrorMessage"
751+
$ref: "#/components/schemas/ErrorMessage"
752752
ErrorMessage:
753753
type: object
754754
properties:

0 commit comments

Comments
 (0)