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

inputParams could refer to PARAM as alternative to FIELD #115

Open
mbtaylor opened this issue Nov 20, 2023 · 4 comments
Open

inputParams could refer to PARAM as alternative to FIELD #115

mbtaylor opened this issue Nov 20, 2023 · 4 comments

Comments

@mbtaylor
Copy link
Member

I have a suggestion/request from ESDC to allow service descriptor inputParam entries to refer by ID/ref not only to FIELDs in the results table but also to PARAMs. The existing text in sec 4.3:

For services where the parameter value(s) come from the "results" resource, the value attribute is empty (value="") and the PARAM includes a ref attribute to indicate the FIELD (column) that contains the values.

does not explicitly allow this possibility, but given the relationship between FIELDs and PARAMs in general, it seems almost implied.

Although the same effect could be achieved by rearranging information in the VOTable document (use a constant valued-service descriptor instead of a referenced PARAM), I understand that at least for the Gaia DataLink documents under consideration doing it like this would make for more straightforward implementation.

I would support this change (clarification?) for DataLink 1.1 and I am willing to write a PR, or open discussion on the mailing list, or add a note on the RFC page, on request. But the editors might consider it too late in the DL1.1 process to include this change to the text. @pdowler what do you think?

@mbtaylor
Copy link
Member Author

On second thoughts introducing this could raise backward compatibility issues: if a DataLink 1.0 client encountered a DataLink 1.1 service descriptor with a PARAM reference it would likely fail to understand it. So maybe not such a good idea at a minor revision. But still interested if other people have thoughts about it.

@msdemlei
Copy link
Collaborator

msdemlei commented Nov 21, 2023 via email

@mbtaylor
Copy link
Member Author

The reason I think this sounds sensible is that conceptually a PARAM is just a non-varying FIELD, so you'd expect PARAM references to work in the same way that a FIELD references do - so perhaps if the original text had been written more thoughtfully it would have said "FIELD or PARAM" where it now says "FIELD". From that point of view this is more like a clarification than adding a new feature.

But backward compatibility issues would apply at least to existing versions of topcat - topcat currently understands service descriptors that reference FIELDs but not PARAMs. And the same may be true of other clients, PyVO included or not.

@Bonnarel
Copy link
Contributor

Bonnarel commented Nov 24, 2023 via email

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

3 participants