Skip to content

Commit 410894c

Browse files
authored
Merge pull request #57 from molinaro-m/sr-maxrec-metadata
SR & MAXREC for metadata
2 parents 563ab63 + 388e329 commit 410894c

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

ConeSearch.tex

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ \section{Service Interface Requirements}
144144
not significant.
145145
\item The baseURL and constraint list are concatenated
146146
to form the query.
147-
\item The set of query constraints must include the
147+
\item The set of query constraints MUST include the
148148
following parameters, which are interpreted by the service with the
149149
stated meaning:
150150
\begin{description}
@@ -154,13 +154,25 @@ \section{Service Interface Requirements}
154154
\item[\textbf{DEC}] a declination
155155
in the ICRS coordinate system for the positon of the center of the cone
156156
to search, given in decimal degrees.
157-
\item[\textbf{SR}] the radius of
158-
the cone to search, given in decimal degrees.
157+
\item[\textbf{SR}] the radius of the cone to search, given in decimal degrees.
158+
If set to zero (SR=0) it should not return an error condition because the
159+
request might describe an interest in retrieving only the metadata structure
160+
of the service's response (i.e. discovery of the FIELDS delivered by the service).
161+
This is similar to setting MAXREC=0, i.e. a service metadata request as prescribed
162+
by DALI\footnote{SR=0 is kept in this version of this specification for back
163+
compatibility. It is suggested to prefer the usage of MAXREC to enable metadata
164+
discovery}\citep{2017ivoa.spec.0517D}.
159165
\end{description}
160166
\begin{bigdescription}
161167
\item[Example]
162168
\url{http://mycone.org/cgi-bin/search?RA=180.567&DEC=-30.45&SR=0.0125}
163169
\end{bigdescription}
170+
\item As defined by DALI a service SHOULD also understand the following parameter:
171+
\begin{description}
172+
\item[\textbf{MAXREC}] to let the client limit the number of records returned
173+
or require a service metadata response. Its usage is encouraged and preferred
174+
to the SR=0 solution for metadata discovery.
175+
\end{description}
164176
\item The query MAY contain the optional parameter,
165177
\textbf{VERB}, whose value is an integer--either 1, 2, or 3--indicating
166178
verbosity which determines how many columns are to be returned in the
@@ -324,11 +336,7 @@ \section{Service Interface Requirements}
324336
Southern hemisphere and the catalog coverage is in the Northern
325337
hemisphere. This type of query is different from an error return; it
326338
should return a VOTable as described above, with metadata, but no data
327-
records. In particular, a zero value of Search Radius should not return
328-
an error condition. This is because an application may be more
329-
interested in the metadata than the data, and send a fixed query (for
330-
example RA=0\&DEC=90\&SR=0) simply to discover the fields delivered by
331-
the service.
339+
records.
332340
\end{enumerate}
333341

334342
\section{The Resource Profile}

0 commit comments

Comments
 (0)