location-retrieval: Alignment of errors with Commonalities #221
Conversation
Alignment of errors with Commonalities
🦙 MegaLinter status: ✅ SUCCESS
See detailed report in MegaLinter reports MegaLinter is graciously provided by |
bigludo7
changed the title
bigludo7
changed the title
| value: | ||
| status: 400 | ||
| code: INVALID_ARGUMENT | ||
| message: "Invalid argument" | ||
| MaxAgeIssue: | ||
| message: Client specified an invalid argument, request body or query param. |
There was a problem hiding this comment.
In theory this also applies to request headers. Maybe we can simplify the sentence, keep it more generic ?
There was a problem hiding this comment.
Hello @alpaycetin74
I used the the template from commonalities here - line 146.... so probably we cannot change this.
There was a problem hiding this comment.
Also, the value for message in examples are not normative, only the code. Implementation may return any other, even in different language
| examples: | ||
| GENERIC_403_PERMISSION_DENIED: | ||
| summary: Generic Permission Denied | ||
| description: Permission denied. OAuth2 token access does not have the required scope or when the user fails operational security |
There was a problem hiding this comment.
Maybe reword as "OAuth2 token does not have access to the required scope, or the user fails operational security" ?
There was a problem hiding this comment.
Same previous. I took this from commonalities here - line 192
| message: 'The specified resource is not found' | ||
| deviceNotFound: | ||
| LOCATION_RETRIEVAL_404_UNABLE_TO_LOCATE_DEVICE: | ||
| summary: The location server is not able to locate the mobile |
There was a problem hiding this comment.
Maybe better "device" instead of "mobile"
Changed mobile to device for error 404
|
Fixed last @jlurien comment. |
I agree, thank you. |
|
@jlurien May I ask you to take a look on this one. I guess we need to move quick on this one for the meta-release. Thanks |
Added - If you think it's too early I can remove but Rafal is working on the PR. |
What type of PR is this?
Add one of the following kinds:
What this PR does / why we need it:
Alignement of errors according to Commonalities guideline.
Which issue(s) this PR fixes:
Fixes #219
Special notes for reviewers:
Changelog input
Additional documentation
This section can be blank.