E1.37-5 tweaks #11
Open
E1.37-5 tweaks #11
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
- Modified spacing for ease in readability - Added schema "title" (which may need to have the word "informative" removed) - Added description values - Changed single-value enums to "const" - Separated "bits" from "bitField" - Created a simpleType enum for all basic types - Alphabetized definitions - Changed "label" to "labeledInteger" * changed the "label" property to "name", for consistency - Changed "max_size" and "min_size" to "maxLength" and "minLength", for consistency with JSON schema naming conventions. * Added '"uniqueItems": true' to the "bits" field of the "bitField" field type, the integer field type, the command type, and the range type * Created the subdeviceType with an enumeration of the possible values. * Added a "pdEnvelope" type to help deal with the proposed PACKED_PIDS parameter message * Added a new "list" type that represents a list of any valid non-list field type. * Removed the requirement of having "name" for some of the types so they can also be used in lists. * Suffixed all the types with "Type" so that naming is consistent. These aren't the words that will be used when writing a schema and they don't have to be the same as the constant names, eg. "uint8" or "string" or "list". * Added a "compoundType" type so that we don't have to make a special type for all possibilities. For example, the list of 3-field items returned in SLOT_INFO. These compound types are only supported in the list type, "listType", because a field is only used in "commandType". * Factored all the types into a "oneOf" so that it can be referenced from "compoundType", "listType", and "fieldType". * Changed "boundedIntegerType" to "integerType" and "boundedStringType" to "stringType". * Removed "name" from the "required" list of "labeledIntegerType" and "listType". * Changed "upper" and "lower" in "rangeType" to "maximum" and "minimum", respectively, for consistency with JSON schema naming conventions. * Added an optional "length" property to "pdEnvelope". * Removed "fieldType" and instead made "commandType" be a collection of "oneOfType".
…iled pull request. Added the MAC type, which had been forgotten until going over the public review comments.
Merge in Maya's proposals
It's only used to define which subdevices a command should be targeted at
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.
Fix-up of #8