Skip to content

Commit

Permalink
chore: sync assertions.csv with the current assertions in the spec an…
Browse files Browse the repository at this point in the history
…d generate manual.csv
  • Loading branch information
FadySalama committed Aug 8, 2022
1 parent 95fcb2c commit 13ecd39
Show file tree
Hide file tree
Showing 11 changed files with 139 additions and 8,024 deletions.
20 changes: 11 additions & 9 deletions packages/assertions/assertions-csv/assertions.csv
Original file line number Diff line number Diff line change
Expand Up @@ -265,9 +265,9 @@
"td-uriVariables-names","null","In such a case, the URI Template variables MUST be collected in the JSON-object based uriVariables member either in the Thing level or in Interaction Affordance level with the associated (unique) variable names as JSON names."
"td-version","null","All name-value pairs of an instance of VersionInfo, where the name is a Vocabulary Term included in the Signature of VersionInfo, MUST be serialized as JSON members with the Vocabulary Term as name."
"td-vocab-actions--Thing","null","actionsAll Action-based Interaction Affordances of the Thing.optionalMap of ActionAffordance"
"td-vocab-additionalResponses--Form","null","additionalResponsesThis optional term can be used if additional expected responses are possible, e.g. for error reporting. Each additional response needs to be distinguished from others in some way (for example, by specifying a protocol-specific error code), and may also have its own data schema.optionalAdditionalExpectedResponse or Array of AdditionalExpectedResponse"
"td-vocab-additionalResponses--Form","null","additionalResponsesThis optional term can be used if additional expected responses are possible, e.g. for error reporting. Each additional response needs to be distinguished from others in some way (for example, by specifying a protocol-specific error code), and may also have its own data schema.optionalArray of AdditionalExpectedResponse"
"td-vocab-alg--BearerSecurityScheme","null","algEncoding, encryption, or digest algorithm.with defaultstring (e.g., ES256, or ES512-256)"
"td-vocab-allOf--ComboSecurityScheme","null","allOfArray of two or more strings identifying other named security scheme definitions, all of which must be satisfied for access.mandatorystring or Array of string"
"td-vocab-allOf--ComboSecurityScheme","null","allOfArray of two or more strings identifying other named security scheme definitions, all of which must be satisfied for access.mandatoryArray of string"
"td-vocab-anchor--Link","null","anchorOverrides the link context (by default the Thing itself identified by its id) with the given URI or IRI.optionalanyURI"
"td-vocab-at-context--Thing","null","@contextJSON-LD keyword to define short-hand names called terms that are used throughout a TD document.mandatoryanyURI or Array"
"td-vocab-at-type--DataSchema","null","@typeJSON-LD keyword to label the object with semantic tags (or types)optionalstring or Array of string"
Expand Down Expand Up @@ -339,7 +339,7 @@
"td-vocab-name--BearerSecurityScheme","null","nameName for query, header, cookie, or uri parameters.optionalstring"
"td-vocab-name--DigestSecurityScheme","null","nameName for query, header, cookie, or uri parameters.optionalstring"
"td-vocab-observable--PropertyAffordance","null","observableA hint that indicates whether Servients hosting the Thing and Intermediaries should provide a Protocol Binding that supports the observeproperty and unobserveproperty operations for this Property.with defaultboolean"
"td-vocab-oneOf--ComboSecurityScheme","null","oneOfArray of two or more strings identifying other named security scheme definitions, any one of which, when satisfied, will allow access. Only one may be chosen for use.mandatorystring or Array of string"
"td-vocab-oneOf--ComboSecurityScheme","null","oneOfArray of two or more strings identifying other named security scheme definitions, any one of which, when satisfied, will allow access. Only one may be chosen for use.mandatoryArray of string"
"td-vocab-oneOf--DataSchema","null","oneOfUsed to ensure that the data is valid against one of the specified schemas in the array.optionalArray of DataSchema"
"td-vocab-op--Form","null","opIndicates the semantic intention of performing the operation(s) described by the form. For example, the Property interaction allows get and set operations. The protocol binding may contain a form for the get operation and a different form for the set operation. The op attribute indicates which form is for which and allows the client to select the correct form for the operation required. op can be assigned one or more interaction verb(s) each representing a semantic intention of an operation.with defaultstring or Array of string (one of readproperty, writeproperty, observeproperty, unobserveproperty, invokeaction, queryaction, cancelaction, subscribeevent, unsubscribeevent, readallproperties, writeallproperties, readmultipleproperties, writemultipleproperties, observeallproperties, unobserveallproperties, subscribeallevents, unsubscribeallevents, or queryallactions)"
"td-vocab-op--Form_cancelaction","null","Type: MUST be string or Array of string (cancelaction)."
Expand Down Expand Up @@ -402,7 +402,7 @@
"td-vocab-titles--InteractionAffordance","null","titlesProvides multi-language human-readable titles (e.g., display a text for UI representation in different languages). Also see MultiLanguage.optionalMap of MultiLanguage"
"td-vocab-titles--Thing","null","titlesProvides multi-language human-readable titles (e.g., display a text for UI representation in different languages). Also see MultiLanguage.optionalMap of MultiLanguage"
"td-vocab-token--OAuth2SecurityScheme","null","tokenURI of the token server.optionalanyURI"
"td-vocab-type--DataSchema","null","typeAssignment of JSON-based data types compatible with JSON Schema (one of boolean, integer, number, string, object, array, or null).optionalany type (one of object, array, string, number, integer, boolean, or null)"
"td-vocab-type--DataSchema","null","typeAssignment of JSON-based data types compatible with JSON Schema (one of boolean, integer, number, string, object, array, or null).optionalstring (one of object, array, string, number, integer, boolean, or null)"
"td-vocab-type--DataSchema_array","null","type: Assignment of JSON-based data types MUST be compatible with JSON Schema (array)."
"td-vocab-type--DataSchema_boolean","null","type: Assignment of JSON-based data types MUST be compatible with JSON Schema (boolean)."
"td-vocab-type--DataSchema_integer","null","type: Assignment of JSON-based data types MUST be compatible with JSON Schema (integer)."
Expand All @@ -420,8 +420,9 @@
"thing-model-td-generation-processor-extends","null","If used, links element entry with ""rel"":""tm:extends"" MUST be removed from the current Partial TD"
"thing-model-td-generation-processor-forms","null","Missing communication and/or security metadata details MUST be completed in the Thing Description instance based on Section and/or ."
"thing-model-td-generation-processor-imports","null","Copy all definitions from the input Thing Model to the resulting Partial TD instance. If used, the extension and imports feature MUST be resolved and represented in the Partial TD instance according to ."
"thing-model-td-generation-processor-optional","null","All optional interactions (listed in tm:optional) MAY be taken over to the Partial TD instance."
"thing-model-td-generation-processor-placeholder","null","If used, all placeholders (see Section ) in the Thing Model MUST be replaced with a valid corresponding value in the Partial TD."
"thing-model-td-generation-processor-required","null","If the tm:required feature is used based on Section , the required interactions MUST be taken over to the Partial TD instance."
"thing-model-td-generation-processor-required","null","All required interactions (not listed in tm:optional) MUST be taken over to the Partial TD instance."
"thing-model-td-generation-processor-type","null","The tm:ThingModel value of the top-level @type MUST be removed in the Partial TD instance."
"tm-compose-instanceName","null","Optionally an instanceName MAY be provided to associate an individual name to the composed (sub-) Thing Model."
"tm-compose-name-collision","null","To avoid name collisions of the sub/child interaction names SHOULD rename the JSON name to the instanceName followed with '_' and the interaction name of the sub/child Thing Model."
Expand All @@ -440,15 +441,16 @@
"tm-ref-recursive-extensions","null","Recursive extensions leading to an infinite loop MUST NOT be defined."
"tm-rel-type-maximum","null","The links array MUST use the entry with ""rel"" : ""type"" a maximum of once."
"tm-td-generation-inconsistencies","null","A Thing Model MUST be defined in such a way that there are no inconsistencies that would result in a Thing Description not being able to meet the requirements as described in Section and ."
"tm-tmOptional","null","If interaction models are not manditory to be implemented in a Thing Description instance, Thing Model definitions MUST use the JSON member name tm:optional."
"tm-tmOptional-JSONPointer","null","The value of tm:optional MUST provide JSON Pointer [[RFC6901]] references to the required interaction model definitions."
"tm-tmOptional-array","null","tm:optional MUST be a JSON array at the top level."
"tm-tmOptional-resolver","null","The JSON Pointers of tm:optional MUST resolve to an entire interaction affordance Map definition."
"tm-tmRef-overwrite-possibility","null","If the intention is to override an existing JSON name-value pair definition from tm:ref, the same JSON name MUST be used at the same level of the tm:ref declaration that provides a new value."
"tm-tmRef-overwrite-process","null","The process to overwrite MUST follow the JSON Merge Patch algorithm as defined in [RFC7396] where the content of the referenced definition is patched with the new provided JSON name-value pairs."
"tm-tmRef-overwrite-semantic-meaning","null","Similar to tm:extends and to keep the semantic meaning, definitions SHOULD NOT be overwritten in such a way that possible instance values are no longer valid compared to the origin referenced definition."
"tm-tmRef-usecase","null","For importing pieces of definitions of one or more existing Thing Models, the tm:ref term is introduced that provides the location of an existing (sub-)definition that SHOULD be reused."
"tm-tmRef1","null","The tm:ref value MUST follow the pattern"
"tm-tmRef2","null","Every time tm:ref is used, the referenced pre-definition and its dependencies (e.g., by context extension) MUST be assumed at the new defined definition."
"tm-tmRequired","null","To guarantee the implementation of particular kinds of interaction models, Thing Model definitions MUST use the JSON member name tm:required."
"tm-tmRequired-JSONPointer","null","The value of tm:required MUST provide JSON Pointer [[RFC6901]] references to the required interaction model definitions."
"tm-tmRequired-array","null","tm:required MUST be a JSON array at the top level."
"tm-tmRequired-resolver","null","The JSON Pointers of tm:required MUST resolve to an entire interaction affordance Map definition."
"tm-versioning","null","When the Thing Model definitions change over time, this SHOULD be reflected in the version container."
"tm-versioning","null","Due to the definition of Thing Model the term instance MUST be omitted within the version container."
"well-known-operation-types-only","null","operations types SHOULD NOT be arbitrarily set by servients and be restricted to the values in the table below."
5 changes: 1 addition & 4 deletions packages/assertions/assertions-csv/implemented.csv
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,4 @@
"tm-protocol-security-restriction","null","",
"tm-td-generation-inconsistencies","null","",
"tm-tmRef-usecase","null","",
"tm-tmRef1","null","",
"tm-tmRequired","null","",
"tm-tmRequired-JSONPointer","null","",
"tm-tmRequired-array","null","",
"tm-tmRef1","null","",
10 changes: 7 additions & 3 deletions packages/assertions/assertions-csv/manual.csv
Original file line number Diff line number Diff line change
Expand Up @@ -76,15 +76,19 @@
"thing-model-td-generation-processor-extends","null","If used",""
"thing-model-td-generation-processor-forms","null","Missing communication and/or security metadata details MUST be completed in the Thing Description instance based on Section and/or .",""
"thing-model-td-generation-processor-imports","null","Copy all definitions from the input Thing Model to the resulting Partial TD instance. If used, the extension and imports feature MUST be resolved and represented in the Partial TD instance according to .",""
"thing-model-td-generation-processor-optional","null","All optional interactions (listed in tm:optional) MAY be taken over to the Partial TD instance.",""
"thing-model-td-generation-processor-placeholder","null","If used, all placeholders (see Section ) in the Thing Model MUST be replaced with a valid corresponding value in the Partial TD.",""
"thing-model-td-generation-processor-required","null","If the tm:required feature is used based on Section , the required interactions MUST be taken over to the Partial TD instance.",""
"thing-model-td-generation-processor-required","null","All required interactions (not listed in tm:optional) MUST be taken over to the Partial TD instance.",""
"thing-model-td-generation-processor-type","null","The tm:ThingModel value of the top-level @type MUST be removed in the Partial TD instance.",""
"tm-overwrite-interaction","null","A Thing Model SHOULD NOT overwrite the JSON names defined within the properties, actions, and/or events Map of the extended Thing Model.",""
"tm-overwrite-types","null","Definitions SHOULD NOT be overwritten in such a way that possible instance values are no longer valid compared to the origin extended definitions.",""
"tm-placeholder-replacement","null","The placeholder labeling MUST be substituted with a concrete value (e.g., as JSON number, JSON string, JSON object, etc) when TD instance is created from the Thing Model.",""
"tm-ref-recursive-extensions","null","Recursive extensions leading to an infinite loop MUST NOT be defined.",""
"tm-tmOptional","null","If interaction models are not manditory to be implemented in a Thing Description instance, Thing Model definitions MUST use the JSON member name tm:optional.",""
"tm-tmOptional-JSONPointer","null","The value of tm:optional MUST provide JSON Pointer [[RFC6901]] references to the required interaction model definitions.",""
"tm-tmOptional-array","null","tm:optional MUST be a JSON array at the top level.",""
"tm-tmOptional-resolver","null","The JSON Pointers of tm:optional MUST resolve to an entire interaction affordance Map definition.",""
"tm-tmRef-overwrite-possibility","null","If the intention is to override an existing JSON name-value pair definition from tm:ref, the same JSON name MUST be used at the same level of the tm:ref declaration that provides a new value.",""
"tm-tmRef-overwrite-process","null","The process to overwrite MUST follow the JSON Merge Patch algorithm as defined in [RFC7396] where the content of the referenced definition is patched with the new provided JSON name-value pairs.",""
"tm-tmRef-overwrite-semantic-meaning","null","Similar to tm:extends and to keep the semantic meaning, definitions SHOULD NOT be overwritten in such a way that possible instance values are no longer valid compared to the origin referenced definition.",""
"tm-tmRef2","null","Every time tm:ref is used, the referenced pre-definition and its dependencies (e.g., by context extension) MUST be assumed at the new defined definition.",""
"tm-tmRequired-resolver","null","The JSON Pointers of tm:required MUST resolve to an entire interaction affordance Map definition.",""
"tm-tmRef2","null","Every time tm:ref is used, the referenced pre-definition and its dependencies (e.g., by context extension) MUST be assumed at the new defined definition.",""
10 changes: 7 additions & 3 deletions packages/assertions/assertions-csv/needsReview.csv
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,19 @@
"thing-model-td-generation-processor-extends","null","If used",""
"thing-model-td-generation-processor-forms","null","Missing communication and/or security metadata details MUST be completed in the Thing Description instance based on Section and/or .",""
"thing-model-td-generation-processor-imports","null","Copy all definitions from the input Thing Model to the resulting Partial TD instance. If used, the extension and imports feature MUST be resolved and represented in the Partial TD instance according to .",""
"thing-model-td-generation-processor-optional","null","All optional interactions (listed in tm:optional) MAY be taken over to the Partial TD instance.",""
"thing-model-td-generation-processor-placeholder","null","If used, all placeholders (see Section ) in the Thing Model MUST be replaced with a valid corresponding value in the Partial TD.",""
"thing-model-td-generation-processor-required","null","If the tm:required feature is used based on Section , the required interactions MUST be taken over to the Partial TD instance.",""
"thing-model-td-generation-processor-required","null","All required interactions (not listed in tm:optional) MUST be taken over to the Partial TD instance.",""
"thing-model-td-generation-processor-type","null","The tm:ThingModel value of the top-level @type MUST be removed in the Partial TD instance.",""
"tm-overwrite-interaction","null","A Thing Model SHOULD NOT overwrite the JSON names defined within the properties, actions, and/or events Map of the extended Thing Model.",""
"tm-overwrite-types","null","Definitions SHOULD NOT be overwritten in such a way that possible instance values are no longer valid compared to the origin extended definitions.",""
"tm-placeholder-replacement","null","The placeholder labeling MUST be substituted with a concrete value (e.g., as JSON number, JSON string, JSON object, etc) when TD instance is created from the Thing Model.",""
"tm-ref-recursive-extensions","null","Recursive extensions leading to an infinite loop MUST NOT be defined.",""
"tm-tmOptional","null","If interaction models are not manditory to be implemented in a Thing Description instance, Thing Model definitions MUST use the JSON member name tm:optional.",""
"tm-tmOptional-JSONPointer","null","The value of tm:optional MUST provide JSON Pointer [[RFC6901]] references to the required interaction model definitions.",""
"tm-tmOptional-array","null","tm:optional MUST be a JSON array at the top level.",""
"tm-tmOptional-resolver","null","The JSON Pointers of tm:optional MUST resolve to an entire interaction affordance Map definition.",""
"tm-tmRef-overwrite-possibility","null","If the intention is to override an existing JSON name-value pair definition from tm:ref, the same JSON name MUST be used at the same level of the tm:ref declaration that provides a new value.",""
"tm-tmRef-overwrite-process","null","The process to overwrite MUST follow the JSON Merge Patch algorithm as defined in [RFC7396] where the content of the referenced definition is patched with the new provided JSON name-value pairs.",""
"tm-tmRef-overwrite-semantic-meaning","null","Similar to tm:extends and to keep the semantic meaning, definitions SHOULD NOT be overwritten in such a way that possible instance values are no longer valid compared to the origin referenced definition.",""
"tm-tmRef2","null","Every time tm:ref is used, the referenced pre-definition and its dependencies (e.g., by context extension) MUST be assumed at the new defined definition.",""
"tm-tmRequired-resolver","null","The JSON Pointers of tm:required MUST resolve to an entire interaction affordance Map definition.",""
"tm-tmRef2","null","Every time tm:ref is used, the referenced pre-definition and its dependencies (e.g., by context extension) MUST be assumed at the new defined definition.",""
5 changes: 4 additions & 1 deletion packages/assertions/assertions-csv/old.csv
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
"ID","Status","Assertion","Comment"
"ID","Status","Assertion","Comment"
"tm-tmRequired",,"",
"tm-tmRequired-JSONPointer",,"",
"tm-tmRequired-array",,"",
2 changes: 1 addition & 1 deletion packages/assertions/assertions-csv/report.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"generationDate":"Fri, 29 Jul 2022 13:06:16 GMT","assertionsSize":453,"implementedSize":369,"manualSize":89,"oldSize":0,"needsReviewSize":41}
{"generationDate":"Mon, 08 Aug 2022 01:19:29 GMT","assertionsSize":455,"implementedSize":366,"manualSize":93,"oldSize":3,"needsReviewSize":45}
Loading

0 comments on commit 13ecd39

Please sign in to comment.