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

[BUG] - isComponent description is not very clear #718

Open
rhiaro opened this issue Jul 22, 2024 · 1 comment
Open

[BUG] - isComponent description is not very clear #718

rhiaro opened this issue Jul 22, 2024 · 1 comment
Labels

Comments

@rhiaro
Copy link
Collaborator

rhiaro commented Jul 22, 2024

Summary of the bug or issue

The description of isComponent is hard to follow, and I think it still contains some text/concepts from earlier version of BODS.

Whether this entity is a component in an indirect relationship. Where isComponent is 'true': (1) the recordId of this entity MUST be an element in the componentRecords array of that primary Relationship Statement, (2) this Entity Statement MUST come before that primary Relationship Statement in a BODS package or stream, (3) the replacement of this Entity Statement SHOULD be considered when replacing the primary Relationship Statement. The primary Relationship statement MUST have a isComponent value of 'false'.

In (1) the componentRecords property is on the Relationship Record object, so referring to "Relationship Statement" here threw me off.

(3) makes more sense with replacesStatement, which has been deprecated. I think it should be removed, or replaced with clearer non-normative guidance about updating records / making new statements, because "be considered" is a vague normative requirement in any case.

@rhiaro rhiaro added the bug label Jul 22, 2024
@kd-ods
Copy link
Collaborator

kd-ods commented Jul 23, 2024

Thanks, @rhiaro! Yes, you're right that 0.4 only saw a minimal update to the the isComponent and componentRecords fields - and they need a good reworking/rethinking.

Given the other changes in BODS 0.4 (particularly, addition of the declaration field and better specification for handling information updates), I wonder whether we need the 'component' feature at all.

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

No branches or pull requests

2 participants