Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Remove redundancy in conformance definitions in ZAP XMLs #1526

Open
ethanzhouyc opened this issue Feb 18, 2025 · 0 comments
Open

Remove redundancy in conformance definitions in ZAP XMLs #1526

ethanzhouyc opened this issue Feb 18, 2025 · 0 comments
Assignees

Comments

@ethanzhouyc
Copy link
Collaborator

In ZAP XML, both formats like optional="true" and <mandatoryConform> are used to define compliance, creating redundancy and confusion:

<attribute side="server" code="0x0004" name="CurrentY" define="COLOR_CONTROL_CURRENT_Y" type="int16u" max="0xFEFF" default="0x607D" reportable="true" optional="true">
      <mandatoryConform>
        <feature name="XY"/>
      </mandatoryConform>
</attribute>

Users don’t know which takes precedence and both must be updated manually. Changing one without updating the other can cause inconsistencies.

Proposed solution:

  1. For pure mandatory attributes, no conformance listed at all. optional="false" is disallowed.
  2. For pure optional (O) attributes, allow only optional="true" so we can use the shorthand attribute representation in the XML.
  3. For anything else, disallow having the optional attribute entirely, list longhand conformance.
@ethanzhouyc ethanzhouyc self-assigned this Feb 18, 2025
@ethanzhouyc ethanzhouyc changed the title Remove redundancy in compliance definition in ZAP XMLs Remove redundancy in conformance definitions in ZAP XMLs Feb 18, 2025
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant