feat: add new rule to prefer single resources (#764) #785
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
Signed-off-by: tkrop <tronje.krop@zalando.de>
SmilyOrg
reviewed
Oct 26, 2023
chapters/json-guidelines.adoc
Outdated
| @@ -32,6 +31,27 @@ As a consequence, a JSON payload must | |||
| * contain only {RFC-7493}#section-2.3[unique member names] (no duplicate | |||
| names). | |||
|
|
|||
|
|
|||
| [#252] | |||
| == {SHOULD} design single resource for reading and writing | |||
There was a problem hiding this comment.
Resource might be ambiguous here, how about schema? That seems to be what OpenAPI calls it and also where you'd usually define these (under components/schemas)
Suggested change
| == {SHOULD} design single resource for reading and writing | |
| == {SHOULD} design single schema for reading and writing |
There was a problem hiding this comment.
How about resource schema?
added 2 commits
October 26, 2023 12:14
Signed-off-by: tkrop <tronje.krop@zalando.de>
|
👍 |
ktsypkina
reviewed
Nov 1, 2023
|
|
||
| **Note:** A resource with property marked `readOnly` in the API according to | ||
| the {json-schema-validation}#rfc.section.9.4[JSON schema validation] may be | ||
| ignored or rejected by a server. Both are in line with the idea behind <<#109, |
There was a problem hiding this comment.
Suggested change
| ignored or rejected by a server. Both are in line with the idea behind <<#109, | |
| ignored or rejected by a server. Both are in line with the idea behind | |
| <<#109, the compatibility guidance>>, however, we suggest to document when | |
| rejecting to prevent client side surprises. |
There was a problem hiding this comment.
What is the reason. The line length is 79?
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.
This pull request adds a new single resource preference rule according to proposal defined in #764.
fixes #764.