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

CDS Specification Version is ambiguous in the 2.0 specification #633

Open
HammondCB opened this issue Jan 24, 2023 · 0 comments
Open

CDS Specification Version is ambiguous in the 2.0 specification #633

HammondCB opened this issue Jan 24, 2023 · 0 comments

Comments

@HammondCB
Copy link

HammondCB commented Jan 24, 2023

During the January 2023 Connectathon a discussion around CDS Hooks 1.0 vs 2.0 determined that we had no discernible way to really know which 'specification version' we were using, but the IG (CRD) indicated we needed to use Hooks 2.0. In the 2.0 specification, the 'specification version' for all the Hooks is listed as 1.0, but the specification also indicates that (Hook Changes) "Because hooks are such an integral part of the CDS Hooks specification, hook definitions are associated with specific versions of the specification. The hook definition MUST include the version (or versions) of the CDS Hooks specification that it is defined to work with."
When reviewing each Hook, the metadata specificationVersion is always set to 1.0, so how can any Hook defined in the 2.0 specification be associated to the 2.0 specification version?
Proposal:


Depending on the intention of the specification version, update the specification to indicate which hook version aligns to which specification version (which may mean all current hooks are aligned to both 1.0 and 2.0) or update the section related to specification version in the changes-to-a-hook section to be clear about how a hook version and specification version are aligned and the expectation of compatibility (meaning, if the latest hook version of a hook aligns to only an older cds hooks specification version, that would still be considered the most up to date for use in the current specification version).

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

No branches or pull requests

1 participant