PartialUpdates reporting + additional improvements in error responses #4447
Conversation
This file contains 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
fgalan
commented
Nov 24, 2023
fgalan
commented
Dec 13, 2023
| @@ -77,7 +79,7 @@ echo '03. PATCH /v2/entities/Room1/attrs, to update existing attribute (temperat | |||
| echo '====================================================================================================================================================================' | |||
| payload='{ | |||
| "temperature": { | |||
| "value": 24, | |||
| "value": 25, | |||
There was a problem hiding this comment.
Actually not needed, but better to use a different value than the one in step 02.
NTC (informative)
This was referenced Dec 13, 2023
fgalan
changed the title
mapedraza
reviewed
Jan 2, 2024
doc/manuals/orion-api.md
Outdated
| @@ -2816,15 +2816,25 @@ _**Request headers**_ | |||
| _**Response code**_ | |||
|
|
|||
| * Successful operation uses 200 OK | |||
| * Errors use a non-2xx and (optionally) an error payload. See subsection on [Error Responses](#error-responses) for more details. | |||
| * Errors use a non-2xx code and error payload (see next subsection): | |||
There was a problem hiding this comment.
Should the link to the error responses section be included? (applies for each API operation)
There was a problem hiding this comment.
The subsection is
_**Response payload**_
That as far as a I understand, is not link-able.
fgalan
commented
Jan 8, 2024
mapedraza
reviewed
Jan 8, 2024
doc/manuals/orion-api.md
Outdated
| * Errors use a non-2xx and (optionally) an error payload. See subsection on [Error Responses](#error-responses) for more details. | ||
| * Errors use a non-2xx code and error payload: | ||
| * 404 Not Found for not found entity (see next subsection) | ||
| * Check addicional cases in [Error Responses](#error-responses) general documentation |
There was a problem hiding this comment.
Typo:
Suggested change
| * Check addicional cases in [Error Responses](#error-responses) general documentation | |
| * Check additional cases in [Error Responses](#error-responses) general documentation |
There was a problem hiding this comment.
Fixed (in all places) in b46c269
|
LGTM |
mapedraza
approved these changes
Jan 8, 2024
|
@fisuda this PR does some modifications to English documentation. It would be great if you could sync the Japanese translation, please. Thanks in advance! |
fisuda
added a commit
to fisuda/fiware-orion
that referenced
this pull request
Jan 10, 2024
|
I sent the PR #4466. Thanks. |
fgalan
added a commit
that referenced
this pull request
Jan 11, 2024
(JP) ADD doc about PartialUpdates reporting in error responses (#4447)
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Issue #3499