Skip to content

Improvements to registration and authorization #7

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

Merged
colinmollenhour merged 13 commits into from
Oct 17, 2025
Merged

Improvements to registration and authorization #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
db66b43
Set type of InvoiceDetails.amount to a string as it requires trailing…
bob2021 Oct 2, 2025
8051cc0
Check auth token before each request. Refs DEV-1447
bob2021 Oct 6, 2025
375e26e
Add missing 429 responses.
bob2021 Oct 6, 2025
c01e45a
Add support for locking during authentication.
bob2021 Oct 6, 2025
21ea8d7
Add rate limiting for authorization API to avoid 10min lockout.
bob2021 Oct 6, 2025
ed70faa
Add sandbox flag to auth token cache key.
bob2021 Oct 7, 2025
7fdf2c3
Fix false positive php-compatibility check by switching to develop br…
bob2021 Oct 7, 2025
97234bf
Remove auth token code from connector constructor.
bob2021 Oct 7, 2025
595907c
Fix authentication.
bob2021 Oct 7, 2025
94727ff
Fix authentication.
bob2021 Oct 13, 2025
1bb8cf3
Fix authentication for connectors using a different base url.
bob2021 Oct 13, 2025
0758643
Fix authentication for connectors using a different base url.
bob2021 Oct 13, 2025
64b5d4c
Add missing header parameters from registration API.
bob2021 Oct 15, 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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ A wide variety of refactoring processes are run on the raw schemas to get them r

* **Combine raw schemas:** If a given API segment has multiple OpenAPI model files, they are combined into a single file. Routes, methods, and component schemas are aggregated across original OpenAPI files, and combined into a single model object. So far, we have not found any OpenAPI model files from the same API segment with overlapping routes, nor conflicting component schemas, so we're not handling those cases.
* **Clean combined schema:** There are often inconsistencies, missing elements, and duplicated or unnecessary component schemas in the OpenAPI models, so this step takes care of those issues. Some specific current steps that are taken:
* Filling in missing `404` response schemas
* Filling in missing `404` and `429` response schemas
* Removing unnecessary `allOf` and `oneOf` definitions in requests, responses, and component schemas
* Setting the types of schemas and properties that are missing explicit types
* Flattening multi-level `$ref`s, where a component or property is a `$ref` to another `$ref`.
Expand Down
5 changes: 3 additions & 2 deletions composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,14 @@
],
"license": "Apache-2.0",
"require": {
"saloonphp/saloon": "^3.8"
"saloonphp/saloon": "^3.8",
"saloonphp/rate-limit-plugin": "^2.1"
},
"require-dev": {
"highsidelabs/saloon-sdk-generator": "^2.1",
"psy/psysh": "^0.12.3",
"symfony/console": "^7.0",
"phpcompatibility/php-compatibility": "^9.3",
"phpcompatibility/php-compatibility": "dev-develop",
"laravel/pint": "^1.15",
"composer/semver": "^3.4",
"ramsey/uuid": "^4.7",
Expand Down
8 changes: 8 additions & 0 deletions resources/metadata/modifications.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,14 @@
"value": {
"type": "string"
}
},
{
"comment": "Set type of InvoiceDetails.amount to a string as it requires trailing zeros",
"action": "merge",
"path": "components.schemas.InvoiceDetails.properties.amount",
"value": {
"type": "string"
}
}
]
},
Expand Down
42 changes: 41 additions & 1 deletion resources/models/account-registration/v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,16 @@
}
}
}
},
"429": {
"description": "Too many requests.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseVO"
}
}
}
}
},
"parameters": [
Expand Down Expand Up @@ -365,6 +375,16 @@
}
}
}
},
"429": {
"description": "Too many requests.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseVO_2"
}
}
}
}
},
"x-code-samples": [
Expand Down Expand Up @@ -546,6 +566,16 @@
}
}
}
},
"429": {
"description": "Too many requests.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseVO_3"
}
}
}
}
},
"x-code-samples": [
Expand Down Expand Up @@ -767,6 +797,16 @@
}
}
}
},
"429": {
"description": "Too many requests.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseVO_3"
}
}
}
}
},
"x-code-samples": [
Expand Down Expand Up @@ -1107,7 +1147,7 @@
"example": "2022-10-09"
},
"amount": {
"type": "number",
"type": "string",
"description": "Used to validate Invoice details whether invoice is related to user or not. It accepts upto 2 digit of decimal.",
"example": 2323.22
}
Expand Down
10 changes: 10 additions & 0 deletions resources/models/address-validation/v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,16 @@
}
}
}
},
"429": {
"description": "Too many requests.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseVO"
}
}
}
}
},
"parameters": [
Expand Down
10 changes: 10 additions & 0 deletions resources/models/authorization/v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,16 @@
}
}
}
},
"429": {
"description": "Too many requests.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseVO"
}
}
}
}
},
"x-code-samples": [
Expand Down
90 changes: 90 additions & 0 deletions resources/models/consolidation/v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,16 @@
}
}
}
},
"429": {
"description": "Too many requests.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseVO"
}
}
}
}
},
"x-code-samples": [
Expand Down Expand Up @@ -397,6 +407,16 @@
}
}
}
},
"429": {
"description": "Too many requests.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseVO"
}
}
}
}
},
"tags": [
Expand Down Expand Up @@ -585,6 +605,16 @@
}
}
}
},
"429": {
"description": "Too many requests.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseVO"
}
}
}
}
},
"x-code-samples": [
Expand Down Expand Up @@ -803,6 +833,16 @@
}
}
}
},
"429": {
"description": "Too many requests.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseVO"
}
}
}
}
},
"x-code-samples": [
Expand Down Expand Up @@ -1021,6 +1061,16 @@
}
}
}
},
"429": {
"description": "Too many requests.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseVO"
}
}
}
}
},
"x-code-samples": [
Expand Down Expand Up @@ -1239,6 +1289,16 @@
}
}
}
},
"429": {
"description": "Too many requests.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseVO"
}
}
}
}
},
"x-code-samples": [
Expand Down Expand Up @@ -1457,6 +1517,16 @@
}
}
}
},
"429": {
"description": "Too many requests.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseVO"
}
}
}
}
},
"x-code-samples": [
Expand Down Expand Up @@ -1648,6 +1718,16 @@
}
}
}
},
"429": {
"description": "Too many requests.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseVO_6"
}
}
}
}
},
"x-code-samples": [
Expand Down Expand Up @@ -1866,6 +1946,16 @@
}
}
}
},
"429": {
"description": "Too many requests.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseVO"
}
}
}
}
},
"x-code-samples": [
Expand Down
50 changes: 50 additions & 0 deletions resources/models/freight-ltl/v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,16 @@
}
}
}
},
"429": {
"description": "Too many requests.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseVO"
}
}
}
}
},
"parameters": [
Expand Down Expand Up @@ -337,6 +347,16 @@
}
}
}
},
"429": {
"description": "Too many requests.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseVO"
}
}
}
}
},
"parameters": [
Expand Down Expand Up @@ -549,6 +569,16 @@
}
}
}
},
"429": {
"description": "Too many requests.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseVO"
}
}
}
}
},
"parameters": [
Expand Down Expand Up @@ -752,6 +782,16 @@
}
}
}
},
"429": {
"description": "Too many requests.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseVO"
}
}
}
}
},
"parameters": [
Expand Down Expand Up @@ -955,6 +995,16 @@
}
}
}
},
"429": {
"description": "Too many requests.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseVO"
}
}
}
}
},
"parameters": [
Expand Down
Loading