Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Duplicate assertion for data schemas #851

Open
egekorkan opened this issue Oct 7, 2022 · 1 comment
Open

Duplicate assertion for data schemas #851

egekorkan opened this issue Oct 7, 2022 · 1 comment

Comments

@egekorkan
Copy link
Contributor

egekorkan commented Oct 7, 2022

There are the following 4 assertions in the spec:

  1. arch-schema: Thus, the Interaction Affordance for structured data types SHOULD be associated with a data schema to provide more detailed syntactic metadata for the data exchanged.
  2. arch-property-dataschema: If the data format is not fully specified by the Protocol Binding used (e.g., through a media type), Properties MAY contain one data schema for the exposed state.
  3. arch-action-dataschema: If the data format is not fully specified by the Protocol Binding used (e.g., through a media type), Actions MAY contain data schemas for input parameters and output results.
  4. arch-event-dataschema: If the data is not fully specified by the Protocol Binding used (e.g., through a media type), Events MAY contain data schemas for the event data and subscription control messages (e.g., a callback URI to subscribe with a Webhook).

I think that either 1 should stay and 2,3,4 should be removed or 1 should be removed and 2,3,4 should stay since they are overlapping

@mlagally
Copy link
Contributor

mlagally commented Nov 30, 2022

Arch call on Nov 30th:
They are not exactly redundant.
To make the text more consistent, the MAY in 4,3,4 should be converted to SHOULD.
At this point we should not modify assertions, defer to next version of the architecture spec. If we need to do it earlier, we had to reopen the CR.
Agree to defer to next spec version.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants