Conversation
This branch has not been deployed
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
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.
IS-13 lets controllers update the label, description and tags of IS-04 resources. IS-08 Inputs and Outputs have a human-readable
nameanddescription, but these are read-only in v1.0. There is also no standard place for additional information about an Input or Output, so implementations resort to vendor-specific members in/io.This PR adds a discussion plan, Annotation Plan. It proposes adding
PATCHto IS-08 v1.1, with semantics aligned with IS-13, rather than a separate annotation API. It also explains the tradeoffs against the IS-13 approach. The proposal has three parts:nameanddescriptionfor Inputs and Outputs, including a bulkPATCH /io.tagsfor Inputs and Outputs, with the same semantics as IS-13.Feedback is welcome, in particular on the scope of the first two parts.