Skip to content

Commit

Permalink
Update field and descriptions for reserved bits
Browse files Browse the repository at this point in the history
1. Added a note to the "bit/properties/reserved" description
   clarifying that absent bits are assumed to be reserved.
2. Changed "reservedValue" to "valueIfReserved" for consistency
   with "bitFieldType/properties/valueForUnspecified".
  • Loading branch information
ssilverman committed Sep 24, 2021
1 parent 2b44f9f commit ec82f0a
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions rdm-schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -96,11 +96,11 @@
},
"reserved": {
"title": "Reserved",
"description": "Indicates that this bit is unused or reserved.",
"description": "Indicates that this bit is unused or reserved. Note that this value does not need to be specified for absent bits; they are already assumed to be reserved.",
"type": "boolean"
},
"reservedValue": {
"title": "Reserved Value",
"valueIfReserved": {
"title": "Value If Reserved",
"description": "The assumed value when the bit is marked as reserved. Absence implies a default value of false.",
"type": "boolean",
"default": false
Expand All @@ -111,7 +111,7 @@
},
"bitFieldType": {
"title": "Bit Field Type",
"description": "A bit field, a collection of 'bit' items. The \"size\" field is used to specify the number of bits in this bit field, a multiple of 8. It is an error if the size is less than the number of defined bits. Bits that are not specified are assumed to be reserved, with a value equal to the \"valueForUnspecified\" value.",
"description": "A bit field, a collection of 'bit' items. The \"size\" field is used to specify the number of bits in this bit field, a multiple of 8. It is an error if the size is less than the number of defined bits. Bits that are not specified are assumed to be reserved, having a value equal to the \"valueForUnspecified\" value.",
"type": "object",
"$ref": "#/$defs/commonPropertiesForNamed",
"properties": {
Expand Down

0 comments on commit ec82f0a

Please sign in to comment.