Document tag customData - #205
Open
iwatkot wants to merge 1 commit into
Open
Conversation
A tag assignment can carry arbitrary user JSON in customData, independent of the tag definition and of the tag value. Documents the field, the rule that the key is present only when non-empty, and the SDK custom_data property.
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.
Documents the
customDatafield on tag assignments, added to the platform API.New Custom data section in the annotation format tags page: the JSON shape, the field definition, the rule that the key is present only when non-empty so existing annotations are unchanged, and the SDK
custom_dataproperty.Placed as its own section rather than under Optional fields, since that section describes fields the system assigns automatically and this one is user-supplied.
Pairs with the SDK change in supervisely/supervisely#1799 and the developer-portal change in supervisely/developer-portal#208.