RecordsWrite Tags #310
Open
RecordsWrite Tags #310
Conversation
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
…cription on its usage and constraints
…protocol definition
LiranCohen
force-pushed
the
lirancohen/tags-definition
branch
from
e2aef01 to
d7a0b7c
Compare
Collaborator
|
awesome. Thank you @LiranCohen |
andorsk
reviewed
Sep 4, 2024
| "image": { | ||
| "dataFormat": ["image/jpeg", "image/png", "image/gif"], | ||
| } | ||
| } } |
acoburn
reviewed
Sep 4, 2024
| "category": { | ||
| "type": "array", | ||
| "minItems": 1, | ||
| "maxItems": 5 |
There was a problem hiding this comment.
Suggested change
| "maxItems": 5 | |
| "maxItems": 5, |
andorsk
reviewed
Sep 4, 2024
| - The object ****MAY**** contain a `$tags` property; if present, its value ****MUST**** be an object with defined constraints: | ||
| - `$requiredTags` (optional) is an array that lists required tag names. | ||
| - `$allowUndefinedTags` (optional) is a boolean that defaults to false, and if set to false, undefined tags are not allowed. | ||
| - The constraints are a subset of JSON Schema that may include properties such as `type`, `enum`, `minimum`, `maximum`, `minLength`, `maxLength`, and others. |
Collaborator
There was a problem hiding this comment.
type required. make clear explicit.
Suggested change
| - The constraints are a subset of JSON Schema that may include properties such as `type`, `enum`, `minimum`, `maximum`, `minLength`, `maxLength`, and others. | |
| - The constraints are a subset of JSON Schema that may include properties such as `type` (required), `enum`, `minimum`, `maximum`, `minLength`, `maxLength`, and others. |
andorsk
reviewed
Sep 4, 2024
| - The _Protocols Definition_ object ****MUST**** contain a `structure` property, and its value ****MUST**** be a _Record Rules_ object whose keys match the labels defined in the _Protocols Definition_ object. This object is recursive, allowing subsequent record relationships to be defined within. Labeled members of the object are composed as follows: | ||
| - The keys of the object ****MUST**** be a string that matches one of the `types` | ||
| - The values representing those keys within the object ****MUST**** be an object composed as follows: | ||
| - The object ****MAY**** contain a `$tags` property; if present, its value ****MUST**** be an object with defined constraints: |
Collaborator
There was a problem hiding this comment.
Note: Tags are not encrypted, please be careful about what you put in a tag.
andorsk
requested changes
Sep 4, 2024
Collaborator
andorsk
left a comment
andorsk
left a comment
There was a problem hiding this comment.
Small tweaks, but goal to have it merged by next session
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.
First pass at specifying tags in Protocol Definitions and RecordsWrite descriptor.
Satisifies: #279