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

Clarification of service parameter self-description #42

Open
gpdf opened this issue Sep 30, 2024 · 3 comments
Open

Clarification of service parameter self-description #42

gpdf opened this issue Sep 30, 2024 · 3 comments

Comments

@gpdf
Copy link

gpdf commented Sep 30, 2024

Currently the document has many (useful!) paragraphs of the form:

Floating point interval values serialised in VOTable or service parameters must have the following metadata in the FIELD element: datatype="double" or datatype="float", arraysize="2", xtype="interval".

I believe the intent of the mention of "service parameters" here is intended to provide guidance for how to describe a service parameter in a service descriptor, either for an onward link to a related service, or in a service self-description.

But in a service descriptor, the enclosing element is a PARAM, not a FIELD. For clarity for implementers, I recommend that we find a way to state this more correctly. One option might be:

Floating point interval values serialised in VOTable (or defined as parameter values in service descriptors) must have the following metadata in the corresponding FIELD (or PARAM) element: datatype="double" or datatype="float", arraysize="2", xtype="interval".

@pdowler
Copy link
Collaborator

pdowler commented Oct 1, 2024

Agreed. Do you want to create a PR for all the places this improvement could be done?

@gpdf
Copy link
Author

gpdf commented Oct 1, 2024

Yes, I'm up for that. I think I'd like to combine it with a resolution for #41 as well, then.

@pdowler
Copy link
Collaborator

pdowler commented Oct 1, 2024

Sounds good.

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

2 participants