Skip to content

whitespace cleanup EOL/EOF & inline #165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
xerc wants to merge 4 commits into
base: main
Choose a base branch
from
Open

whitespace cleanup EOL/EOF & inline #165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9f80b94
whitespace cleanup EOL/EOF & inline
xerc Mar 12, 2025
1613123
optimize/cleanup `img`-tags syntax
xerc Mar 12, 2025
f65a7f5
harmonize `$ref` syntax & inline descr.
xerc Mar 12, 2025
e92397a
manuall FIX multbl. identations
xerc Mar 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
94 changes: 47 additions & 47 deletions AddressValidation.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ info:
termsOfService: https://www.ups.com/upsdeveloperkit/assets/html/serviceAgreement.html
version: ''
description: |

The Address Validation Street Level API can be used to.
check addresses against the United States Postal Service database of valid addresses in the U.S. and Puerto Rico.
# Reference
Expand All @@ -16,9 +16,9 @@ info:
<br/><p>Try out UPS APIs with example requests using Postman. Explore API documentation and sample applications through GitHub.</p>

<a href="https://god.gw.postman.com/run-collection/29542085-f2cd7176-bd05-48ea-bb72-b359a11cff09?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D29542085-f2cd7176-bd05-48ea-bb72-b359a11cff09%26entityType%3Dcollection%26workspaceId%3D7e7595f0-4829-4f9a-aee1-75c126b9d417" target="_blank" rel="noopener noreferrer">
<img src="https://run.pstmn.io/button.svg" alt="Run In Postman" style="width: 128px; height: 32px;"></a>
<img src="https://run.pstmn.io/button.svg" alt="Run In Postman" width="128" height="32"></a>
<a href="https://github.com/UPS-API" target="_blank" rel="noopener noreferrer">
<img src="https://www.ups.com/assets/resources/webcontent/images/gitHubButton.svg" alt="Open in GitHub " style="width: 128px; height: 32px;">
<img src="https://www.ups.com/assets/resources/webcontent/images/gitHubButton.svg" alt="Open in GitHub" width="128" height="32">
</a>
servers:
- url: https://wwwcie.ups.com/api
Expand Down Expand Up @@ -46,9 +46,9 @@ paths:
schema:
type: string
minimum: 1
description: "Valid values: True or False. If True, either the region element
description: "Valid values: True or False. If True, either the region element
or any combination of Political Division 1, Political Division 2, PostcodePrimaryLow
and the PostcodeExtendedLow fields will be recognized for validation
and the PostcodeExtendedLow fields will be recognized for validation
in addition to the urbanization element. If False or no indicator, street
level address validation is provided"
required: false
Expand Down Expand Up @@ -96,7 +96,7 @@ paths:
content:
application/json:
schema:
"$ref": "#/components/schemas/XAVRequestWrapper"
$ref: "#/components/schemas/XAVRequestWrapper"
examples:
json:
summary: A sample JSON request (Standard Example)
Expand All @@ -122,31 +122,31 @@ paths:
content:
application/json:
schema:
"$ref": "#/components/schemas/XAVResponseWrapper"
$ref: "#/components/schemas/XAVResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
$ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
$ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
$ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
$ref: "#/components/schemas/ErrorResponse"
"/addressvalidation/{deprecatedVersion}/{requestoption}":
post:
deprecated: true
Expand All @@ -165,9 +165,9 @@ paths:
schema:
type: string
minimum: 1
description: "Valid values: True or False. If True, either the region element
description: "Valid values: True or False. If True, either the region element
or any combination of Political Division 1, Political Division 2, PostcodePrimaryLow
and the PostcodeExtendedLow fields will be recognized for validation
and the PostcodeExtendedLow fields will be recognized for validation
in addition to the urbanization element. If False or no indicator, street
level address validation is provided"
required: false
Expand Down Expand Up @@ -216,7 +216,7 @@ paths:
content:
application/json:
schema:
"$ref": "#/components/schemas/XAVRequestWrapper"
$ref: "#/components/schemas/XAVRequestWrapper"
examples:
json:
summary: A sample JSON request (Standard Example)
Expand All @@ -242,31 +242,31 @@ paths:
content:
application/json:
schema:
"$ref": "#/components/schemas/XAVResponseWrapper"
$ref: "#/components/schemas/XAVResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
$ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
$ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
$ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
$ref: "#/components/schemas/ErrorResponse"
components:
securitySchemes:
OAuth2:
Expand Down Expand Up @@ -294,7 +294,7 @@ components:
- XAVRequest
properties:
XAVRequest:
"$ref": "#/components/schemas/XAVRequest"
$ref: "#/components/schemas/XAVRequest"
XAVResponseWrapper:
xml:
name: XAVResponse
Expand All @@ -305,23 +305,23 @@ components:
- XAVResponse
properties:
XAVResponse:
"$ref": "#/components/schemas/XAVResponse"
$ref: "#/components/schemas/XAVResponse"
XAVRequest:
type: object
required:
- AddressKeyFormat
- Request
properties:
Request:
"$ref": "#/components/schemas/XAVRequest_Request"
$ref: "#/components/schemas/XAVRequest_Request"
RegionalRequestIndicator:
description: >
description: >-
If this indicator is present then either the region element
or any combination of Political Division 1, Political Division 2, PostcodePrimaryLow
and the PostcodeExtendedLow fields will be recognized for validation in
addition to the urbanization element. If this tag is present, US and
addition to the urbanization element. If this tag is present, US and
PR street level address validation will not occur. The default is to
provide street level address validation. Not valid with the address
provide street level address validation. Not valid with the address
classification request option.
maximum: 1
type: string
Expand All @@ -336,7 +336,7 @@ components:
minLength: 1
maxLength: 2
AddressKeyFormat:
"$ref": "#/components/schemas/XAVRequest_AddressKeyFormat"
$ref: "#/components/schemas/XAVRequest_AddressKeyFormat"
xml:
name: XAVRequest
maximum: 1
Expand Down Expand Up @@ -367,7 +367,7 @@ components:
minLength: 1
maxLength: 1
TransactionReference:
"$ref": "#/components/schemas/Request_TransactionReference"
$ref: "#/components/schemas/Request_TransactionReference"
xml:
name: Request
required:
Expand Down Expand Up @@ -420,7 +420,7 @@ components:
- PostcodePrimaryLow
- PostcodeExtendedLow

Valid only for US or PR origins only. Using this tag for non US/PR origins may cause address format errors.
Valid only for US or PR origins only. Using this tag for non US/PR origins may cause address format errors.
maximum: 1
type: string
minLength: 1
Expand Down Expand Up @@ -467,14 +467,14 @@ components:
- CountryCode
description: |-
AddressKeyFormat container.
The Key format is based on addressing standards jointly developed by the Postal Service and mailing industry. The information provided in the Address Key container will be returned in the same format.
The Key format is based on addressing standards jointly developed by the Postal Service and mailing industry. The information provided in the Address Key container will be returned in the same format.
XAVResponse:
type: object
required:
- Response
properties:
Response:
"$ref": "#/components/schemas/XAVResponse_Response"
$ref: "#/components/schemas/XAVResponse_Response"
ValidAddressIndicator:
description: Indicates query found a valid match.
maximum: 1
Expand All @@ -489,15 +489,15 @@ components:
maximum: 1
type: string
AddressClassification:
"$ref": "#/components/schemas/XAVResponse_AddressClassification"
$ref: "#/components/schemas/XAVResponse_AddressClassification"
Candidate:
description: |
Candidate Container.

**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.
type: array
items:
"$ref": "#/components/schemas/XAVResponse_Candidate"
$ref: "#/components/schemas/XAVResponse_Candidate"
xml:
name: XAVResponse
maximum: 1
Expand All @@ -508,17 +508,17 @@ components:
- ResponseStatus
properties:
ResponseStatus:
"$ref": "#/components/schemas/Response_ResponseStatus"
$ref: "#/components/schemas/Response_ResponseStatus"
Alert:
description: |
Alert Container. There can be zero to many alert containers with code and description.
Alert Container. There can be zero to many alert containers with code and description.

**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.
type: array
items:
"$ref": "#/components/schemas/Response_Alert"
$ref: "#/components/schemas/Response_Alert"
TransactionReference:
"$ref": "#/components/schemas/Response_TransactionReference"
$ref: "#/components/schemas/Response_TransactionReference"
xml:
name: Response
description: Response Container.
Expand All @@ -540,7 +540,7 @@ components:
minLength: 1
maxLength: 1
Description:
description: Describes Response Status Code. Returns text of 'Success'
description: Describes Response Status Code. Returns text of 'Success'
or 'Failure'.
maximum: 1
type: string
Expand Down Expand Up @@ -617,9 +617,9 @@ components:
type: object
properties:
AddressClassification:
"$ref": "#/components/schemas/Candidate_AddressClassification"
$ref: "#/components/schemas/Candidate_AddressClassification"
AddressKeyFormat:
"$ref": "#/components/schemas/Candidate_AddressKeyFormat"
$ref: "#/components/schemas/Candidate_AddressKeyFormat"
xml:
name: Candidate
required:
Expand Down Expand Up @@ -673,7 +673,7 @@ components:
description: "Address line (street number, street name and street type,
and political division 1, political division 2 and postal code) used for
street level information. Additional secondary information (apartment,
suite, floor, etc.) Applicable to US and PR only. Not returned if user
suite, floor, etc.) Applicable to US and PR only. Not returned if user
selects the RegionalRequestIndicator."
type: array
maximum: 3
Expand All @@ -695,10 +695,10 @@ components:
minLength: 1
maxLength: 30
PoliticalDivision1:
description: "State/Province. Returned if the location is within a State/Province/Territory.
For International: returned if user enters valid Country or Territory
Code, and City/postal code and it has a match. For Domestic addresses,
the value must be a valid 2-character value (per US Mail standards). For
description: "State/Province. Returned if the location is within a State/Province/Territory.
For International: returned if user enters valid Country or Territory
Code, and City/postal code and it has a match. For Domestic addresses,
the value must be a valid 2-character value (per US Mail standards). For
International the full State or Province name will be returned."
maximum: 1
type: string
Expand All @@ -713,7 +713,7 @@ components:
maxLength: 10
PostcodeExtendedLow:
description: "Low-end extended postal code in a range. Example in quotes:
Postal Code 30076-'1234'. Only returned in candidate list. May be alphanumeric"
Postal Code 30076-'1234'. Only returned in candidate list. May be alphanumeric"
maximum: 1
type: string
minLength: 1
Expand All @@ -739,7 +739,7 @@ components:
type: object
properties:
response:
"$ref": "#/components/schemas/CommonErrorResponse"
$ref: "#/components/schemas/CommonErrorResponse"
CommonErrorResponse:
type: object
description: The error response containing any errors that occurred.
Expand All @@ -748,7 +748,7 @@ components:
type: array
description: The error array containing any errors that occurred.
items:
"$ref": "#/components/schemas/ErrorMessage"
$ref: "#/components/schemas/ErrorMessage"
ErrorMessage:
type: object
properties:
Expand Down
Loading