-
Notifications
You must be signed in to change notification settings - Fork 6
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
resolve #90 (ObsCore example) and resolve #91 (relax content-type) #93
Changes from 1 commit
e91898c
76f28c0
cfb661a
2ca86e2
e415973
8772c07
951991d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -423,7 +423,7 @@ \subsection{DataLink MIME Type} | |
application/x-votable+xml;content=datalink | ||
\end{verbatim} | ||
to denote that the response from that URL is a DataLink response. | ||
This is also the MIME type for the \blinks\ response | ||
This is also the preferred MIME type for the \blinks\ response | ||
(see \ref{sec:successfulRequests}) | ||
unless the caller has explicitly requested a specific value | ||
via the RESPONSEFORMAT parameter (see \ref{sec:responseformat}). | ||
|
@@ -504,7 +504,7 @@ \subsection{List of Links} | |
\end{itemize} | ||
|
||
To facilitate consumption of large datalink results in streaming mode, all links | ||
for a single ID value MUST be served in consecutive rows in the output. | ||
for a single ID value {\bf must} be served in consecutive rows in the output. | ||
|
||
If an error occurs while processing an ID value, there should be at least | ||
one row for that ID value and an error\_message. For example, if an input | ||
|
@@ -707,9 +707,10 @@ \subsection{Successful Requests} | |
with some additional details below. | ||
|
||
Unless the incoming request included a RESPONSEFORMAT parameter requesting | ||
a different format, the content-type header of the response MUST be | ||
``application/x-votable+xml'' with the | ||
``content'' parameter set to ``datalink'', | ||
a different format, the content-type header of the response MAY be any value | ||
allowed by the VOTable specification, which at the time of this writing includes | ||
``application/x-votable+xml'' and ``text/xml''. The former value is preferred | ||
and SHOULD be augmented with the ``content'' parameter set to ``datalink'', | ||
with the canonical form given in \ref{sec:mime} | ||
strongly recommended. Contrary to | ||
all other uses of the string given in \ref{sec:mime}, | ||
|
@@ -735,19 +736,22 @@ \subsubsection{VOTable output} | |
The name and UCD attributes for FIELD elements in the VOTable | ||
(and the units in one case) are specified above (see \ref{sec:listOfLinks}). | ||
|
||
The DALI specification states that a standardID INFO element with | ||
name ``standardID'' and the actual standardID string as a value SHOULD | ||
be provided. It is recommended to include such an element to help users | ||
and applications to identify VOTables as results of DataLink services | ||
this way: | ||
The DALI specification states that VOTable output should include an | ||
INFO element with \attval{name}{standardID} and the standardID string as a value. | ||
\begin{verbatim} | ||
<RESOURCE type="results"> | ||
... | ||
<INFO name="standardID" value="ivo://ivoa.net/std/DataLink#links-1.0"/> | ||
... | ||
<TABLE> | ||
... | ||
</TABLE> | ||
... | ||
</RESOURCE> | ||
\end{verbatim} | ||
|
||
As of this version, the {links} response {\bf must} include this INFO element | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Suggest replacing "As of this version" with "From version 1.1 of this standard". Otherwise the text is likely to remain in future revisions and be confusing. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Also: DALI 1.1 4.4.3 says "The standardID of a service specification is the IVOA resource identifier for the StandardsRegExt record not including capability-specific fragments." Does that mean that the value attribute in this example should be There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. yes, that's true of the standardID of the specification as used in a StandardsRegExt document. Here is is the standardID of the links endpoint itself, which is defined within that spec. So I think it's OK. |
||
so that a table of links is easily identified by users and applications when | ||
initially received from the service and if saved for later use. | ||
|
||
\subsubsection{Other Output Formats} | ||
|
||
|
@@ -945,12 +949,12 @@ \subsection{Example: Service Descriptor for the \blinks\ Capability} | |
the FIELD element describing this column of the table | ||
{\bf must} include an XML ID attribute | ||
that uniquely identifies the FIELD (column). | ||
For example, a response following the ObsCore-1.0 data model | ||
For example, a response following the ObsCore-1.1 data model | ||
would use the following: | ||
\begin{verbatim} | ||
<FIELD name="obs_publisher_did" ID="primaryID" | ||
utype="obscore:Curation.PublisherDID" | ||
ucd="meta.ref.url;meta.curation" | ||
ucd="meta.ref.ivoid" | ||
datatype="char" arraysize="256*" /> | ||
\end{verbatim} | ||
where the ID value {\em primaryID\/} is arbitrary. | ||
|
+1 −0 | .gitignore | |
+25 −4 | CHANGES | |
+31 −14 | Makefile | |
+8 −4 | Makefile.template | |
+13 −45 | README.rst | |
+68 −67 | archdiag-full.xml | |
+73 −16 | docrepo.bib | |
+10 −10 | fromivoadoc.xslt | |
+17 −12 | ivoa.cls | |
+38 −0 | ivoabib.bib | |
+428 −0 | license-template.txt | |
+237 −237 | make-archdiag.xslt | |
+24 −0 | make-templates.sh | |
+13 −0 | readme-template.md | |
+113 −111 | schemadoc.xslt | |
+36 −36 | stdrec-template.xml | |
+229 −229 | submission.py | |
+181 −0 | suggest-bibupgrade.py | |
+ − | svg-fallback.pdf | |
+3 −0 | svn-ignore.txt | |
+18 −22 | tth-ivoa.xslt | |
+21 −0 | tth_C/CHANGES | |
+1,345 −1,339 | tth_C/tth.c | |
+0 −4 | tthdefs.tex | |
+152 −147 | update_generated.py | |
+8 −8 | vo-dml2ivoatex.xslt |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agree with Markus, MAY doesn't make sense here, should be SHOULD (or possibly MUST)