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

[#228] Add scenario reference for messages, groups, components, and code sets #241

Merged
merged 3 commits into from
Nov 4, 2024

Conversation

kleihan
Copy link
Member

@kleihan kleihan commented Oct 12, 2024

Fixes #228

@kleihan kleihan linked an issue Oct 12, 2024 that may be closed by this pull request
Scenario references are optional.
@kleihan kleihan merged commit 099224e into v1-1-RC2 Nov 4, 2024
2 checks passed
@kleihan kleihan deleted the Issue228 branch November 4, 2024 19:11
@erakadjiev
Copy link

Hello @kleihan

I saw that in a follow-up PR you've removed the documentation about the default value of scenarioRefId.

Additionally, the use="required" attribute of scenarioRefId should be removed too, in my opinion. I guess it's just an oversight, because the documentation above already says that "There are no defaults as scenario references are optional."

Otherwise, if we would leave scenarioRefId to be required, then every message, component, group, and code set would need to specify a scenario reference, which would break backwards compatibility and would lead to undefined behavior for base scenarios (they'd probably need to reference themselves as their parent). So I would be against introducing this new attribute if it's required.

@kleihan
Copy link
Member Author

kleihan commented Nov 16, 2024

Hi @erakadjiev,

thank you for pointing this out, it is an error in the design. You are right and the intention is not to make the reference required. Scenarios without references should still be perfectly valid in v1.1. The intention was to require the ID if and only if a reference is being used. I guess this cannot easily be enforced by the schema and should therefore be clearly defined in the spec. I will enter new pull requests for the schema and the spec to correct this.

@erakadjiev
Copy link

Thank you, @kleihan! Yes, since scenarioRefId is the the reference itself, this cannot be expressed in the schema. In XSD 1.1 it could be expressed that scenarioRef can be present only if scenarioRefId is present. However, I think it cannot be done in XSD 1.0 (which Orchestra is using).

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

Successfully merging this pull request may close these issues.

[repository schema] Scenario Relationships
2 participants