ivoa-std / DALI

DALI: Data AccessLayer Interface
Creative Commons Attribution Share Alike 4.0 International
1 stars 5 forks source link

Clarification of service parameter self-description #42

Open gpdf opened 1 month ago

gpdf commented 1 month ago

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 commented 1 month ago

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

gpdf commented 1 month ago

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

pdowler commented 1 month ago

Sounds good.