chore: update v3 OpenAPI specs to v3.772.0 - #29
Merged
Conversation
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
![prfectionist[bot]](https://avatars.githubusercontent.com/in/1052367?s=60&v=4){kind=small}
Comment on lines
+3026
to
+3033
| ReportUserFraudRequest: | ||
| type: object | ||
| required: | ||
| - is_fraud | ||
| - reported_by | ||
| properties: | ||
| is_fraud: | ||
| type: boolean |
There was a problem hiding this comment.
Suggestion: The ReportUserFraudRequest schema has additionalProperties: true, which allows arbitrary unknown fields to be submitted. For a security-sensitive endpoint that flags users as fraudulent, this could lead to injection of unexpected data into downstream processing. Consider setting additionalProperties: false to enforce a strict schema. [security, importance: 6]
Suggested change
| ReportUserFraudRequest: | |
| type: object | |
| required: | |
| - is_fraud | |
| - reported_by | |
| properties: | |
| is_fraud: | |
| type: boolean | |
| ReportUserFraudRequest: | |
| type: object | |
| required: | |
| - is_fraud | |
| - reported_by | |
| additionalProperties: false | |
| properties: | |
| is_fraud: | |
| type: boolean |
Comment on lines
+1907
to
+1913
| - name: smileid-api-key | ||
| in: header | ||
| required: true | ||
| description: Your partner API key for authentication. | ||
| schema: | ||
| type: string | ||
| example: abcd1234key |
There was a problem hiding this comment.
Suggestion: The smileid-api-key header parameter for the /v3/token endpoint should include x-sensitive: true or use OpenAPI's security scheme mechanism rather than a plain header parameter. As defined, code generators and documentation tools will display this as a regular parameter, potentially encouraging logging or caching of the secret API key. [security, importance: 5]
Suggested change
| - name: smileid-api-key | |
| in: header | |
| required: true | |
| description: Your partner API key for authentication. | |
| schema: | |
| type: string | |
| example: abcd1234key | |
| - name: smileid-api-key | |
| in: header | |
| required: true | |
| description: Your partner API key for authentication. Treat as a secret — do not log or cache. | |
| schema: | |
| type: string | |
| format: password | |
| example: abcd1234key |
Comment on lines
+1196
to
+1203
| - name: job_id | ||
| in: path | ||
| required: true | ||
| description: TypeID format verification identifier with 'job_' prefix. | ||
| schema: | ||
| type: string | ||
| pattern: ^job_[0-9a-z]{26}$ | ||
| example: job_01h2xcejqtf2nbrexx3vqjhp41 |
There was a problem hiding this comment.
Suggestion: The jobId path parameter pattern uses ^job_[0-9a-hjkmnp-tv-z]{26}$ (TypeID base32 alphabet), but the /v3/replay/{job_id} endpoint uses ^job_[0-9a-z]{26}$ (full lowercase alphanumeric). These inconsistent patterns will cause validation failures if a valid TypeID job_id is passed to the other endpoint. Both should use the same pattern — the TypeID spec uses Crockford base32 ([0-9a-hjkmnp-tv-z]). [possible issue, importance: 8]
Suggested change
| - name: job_id | |
| in: path | |
| required: true | |
| description: TypeID format verification identifier with 'job_' prefix. | |
| schema: | |
| type: string | |
| pattern: ^job_[0-9a-z]{26}$ | |
| example: job_01h2xcejqtf2nbrexx3vqjhp41 | |
| - name: job_id | |
| in: path | |
| required: true | |
| description: TypeID format verification identifier with 'job_' prefix. | |
| schema: | |
| type: string | |
| pattern: ^job_[0-9a-hjkmnp-tv-z]{26}$ | |
| example: job_01h2xcejqtf2nbrexx3vqjhp41 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
User description
Automated v3 OpenAPI spec update for v3.772.0.
Triggered by Ed Fricker (@beastawakens) - assigned to you in case it needs a manual merge.
PR Type
Enhancement
Description
Add full bundled
openapi.yamlspec covering all v3 API endpointsAdd "Full V3 API" entry to docs spec selector
Standardize
Consentschema descriptions and addhttps://pattern across all entry specsUpdate CHANGELOG for v3.772.0 release
Diagram Walkthrough
File Walkthrough
8 files
Add v3.772.0 changelog entry listing updated specsAdd descriptions, examples, and https pattern to ConsentStandardize Consent schema formatting and descriptionsStandardize Consent schema formatting and descriptionsStandardize Consent schema formatting and descriptionsStandardize Consent schema formatting and descriptionsStandardize Consent schema formatting and descriptionsAdd descriptions, examples, and https pattern to Consent2 files
Add "Full V3 API" spec to documentation selectorAdd complete bundled OpenAPI spec for all v3 endpoints