Skip to content

TAXENGG-2901 (fix): Tax SPI Spec changes on address validation #52

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
cb-adityabhat wants to merge 1 commit into
base: main
Choose a base branch
from
Open

TAXENGG-2901 (fix): Tax SPI Spec changes on address validation #52

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
69 changes: 46 additions & 23 deletions spec/spi/openapi_tax.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,19 +394,17 @@ paths:
examples:
AddressValidationValidResponse:
$ref: '#/components/examples/AddressValidationValidResponse'
AddressValidationInvalidResponse:
$ref: '#/components/examples/AddressValidationInvalidResponse'
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationErrorResponse'
example:
errors:
- code: INVALID_DATA
message: Empty address provided.
entity: Address
examples:
AddressValidationBadRequestResponse:
$ref: '#/components/examples/AddressValidationBadRequestResponse'
AddressValidationInvalidResponse:
$ref: '#/components/examples/AddressValidationInvalidResponse'
'401':
$ref: './schemas/errors.yml#/components/responses/Error401'
'403':
Expand Down Expand Up @@ -452,27 +450,25 @@ paths:
examples:
CheckAddressTaxabilityValidResponse-Option1:
$ref: '#/components/examples/CheckAddressTaxabilityValidResponse-Option1'
CheckAddressTaxabilityInvalidResponse-Option1:
$ref: '#/components/examples/CheckAddressTaxabilityInvalidResponse-Option1'
CheckAddressTaxabilityValidResponse-Option2:
$ref: '#/components/examples/CheckAddressTaxabilityValidResponse-Option2'
CheckAddressTaxabilityInvalidResponse-Option2:
$ref: '#/components/examples/CheckAddressTaxabilityInvalidResponse-Option2'
CheckAddressTaxabilityValidResponse-Option3:
$ref: '#/components/examples/CheckAddressTaxabilityValidResponse-Option3'
CheckAddressTaxabilityInvalidResponse-Option3:
$ref: '#/components/examples/CheckAddressTaxabilityInvalidResponse-Option3'
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationErrorResponse'
example:
errors:
- code: INVALID_DATA
message: Empty address provided.
entity: Address
examples:
CheckAddressTaxabilityInvalidResponse-Option1:
$ref: '#/components/examples/CheckAddressTaxabilityInvalidResponse-Option1'
CheckAddressTaxabilityInvalidResponse-Option2:
$ref: '#/components/examples/CheckAddressTaxabilityInvalidResponse-Option2'
CheckAddressTaxabilityInvalidResponse-Option3:
$ref: '#/components/examples/CheckAddressTaxabilityInvalidResponse-Option3'
CheckAddressTaxabilityBadRequestResponse:
$ref: '#/components/examples/CheckAddressTaxabilityBadRequestResponse'
'401':
$ref: './schemas/errors.yml#/components/responses/Error401'
'403':
Expand Down Expand Up @@ -1220,7 +1216,6 @@ components:
description: The validation status of an address.
enum:
- VALID
- INVALID
Address:
type: object
description: Represents the address used for validation.
Expand Down Expand Up @@ -2500,7 +2495,18 @@ components:
summary: Invalid address verification response
description: The address provided for verification was Invalid
value:
status: INVALID
errors:
- code: INVALID_DATA
message: Invalid address provided.
entity: Address
AddressValidationBadRequestResponse:
summary: Bad Request address verification response
description: The request provided for verification was Invalid/contained invalid data
value:
errors:
- code: INVALID_DATA
message: Empty address provided.
entity: Address
CheckAddressTaxabilityValidRequest-Option1:
summary: Taxable address request (city + state + country + postalCode)
description: Taxable address with combination of city,state,country,postalCode sent in a post request
Expand Down Expand Up @@ -2534,7 +2540,10 @@ components:
summary: Non-taxable address Response (city + state + country + postalCode)
description: Invalid Response based on combination of city,state,country,postalCode sent in a post request
value:
isTaxable: false
errors:
- code: INVALID_DATA
message: Invalid address provided.
entity: Address
CheckAddressTaxabilityValidRequest-Option2:
summary: Taxable address request (city + country + postalCode)
description: Taxable address with combination of city,country,postalCode sent in a post request
Expand Down Expand Up @@ -2568,7 +2577,10 @@ components:
summary: Non-taxable address response (city + country + postalCode)
description: Invalid response based on combination of city,country,postalCode sent in a post request
value:
isTaxable: false
errors:
- code: INVALID_DATA
message: Invalid address provided.
entity: Address
CheckAddressTaxabilityValidRequest-Option3:
summary: Taxable address request (postalCode)
description: Taxable address with combination of city,state,postalCode sent in a post request
Expand Down Expand Up @@ -2602,7 +2614,18 @@ components:
summary: Non-taxable address response (postalCode)
description: Non-taxable address response based on combination of city,state,postalCode sent in a post request
value:
isTaxable: false
errors:
- code: INVALID_DATA
message: Invalid address provided.
entity: Address
CheckAddressTaxabilityBadRequestResponse:
summary: Bad Request address check taxability response
description: The request provided for check taxability was Invalid/contained invalid data
value:
errors:
- code: INVALID_DATA
message: Empty address provided.
Comment on lines +2617 to +2627
Copy link
Contributor

@cb-suryak cb-suryak Nov 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in the 400 response example we should add invalid address example.

Copy link
Contributor Author

@cb-adityabhat cb-adityabhat Nov 11, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

line 2618 to 2620 is invalid address example.
Do you mean an example of an invalid addreess?

Copy link
Contributor

@cb-ashokmor cb-ashokmor Nov 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't agree with 400 error code,

because -> The api is to validate address, and if api is sucessfull it should return 200

now the address invalid is part of the successful api call of this api only..

400 is when the api itself fails because of invalid input !

entity: Address
Error400ResponseMissingMerchantId:
summary: Empty merchant id.
description: Merchant id is empty.
Expand Down