oasis-tcs / openc2-oc2ls

OASIS OpenC2 TC: GitHub repository used to propose and track changes to the OpenC2 Language Specification as new working draft level revisions are created and the associated CSDs mature
https://github.com/oasis-tcs/openc2-oc2ls
Other
15 stars 19 forks source link

Clarify Targets "Features" vs. "Properties" #392

Closed dlemire60 closed 1 year ago

dlemire60 commented 2 years ago

LS v1.0 has the targets features and properties, with descriptions in the target list (Section 3.3.1.2) that are insufficient to clearly distinguish the intent of each:

ID | Name | Type | # | Description -- | -- | -- | -- | -- 9 | features | Features | 1 | A set of items used with the query Action to determine an Actuator's capabilities. 25 | properties | Properties | 1 | Data attribute associated with an Actuator.

The examples in Section 4.2 helps somewhat to clarify features; the example in A.3 illustrates a use of properties but provide no additional explanation (e.g., where did the "battery" property in the example originate?). The LS should provide more informative language that enables the reader to clearly understand how these targets differ and when / how each is appropriate.

EDIT: related issue is #389

davaya commented 2 years ago

Features is an enumerated list of the four items in 3.4.2.4: (versions, pairs, profiles, rate_limit), to which schema will be added. That is the single command that is mandatory for all consumers to support.

Properties is a black hole into which actuator profile editors can dump stuff that they want but don't want to document. (It was created when Efrain was writing a Tesla Powerwall profile, but didn't document what data he could get from the Powerwall.)

My preference is for Properties to disappear, to be replaced by a requirement for profile editors to create property tables for all Results to be supported by the Consumer.

dlemire60 commented 2 years ago

Discussed at 8/10 working meeting, and consensus reached on removing properties. @dlemire60 will be preparing a corresponding PR. The PR will address both this issue and #389

Vasileios-Mavroeidis commented 2 years ago

Agree with your suggestion to remove the properties target.