Skip to content

Commit 66fbedb

Browse files
committed
Adding language on POST payloads containing parameters.
It was not easy picking a place for this. If you add it where we already talk about POST-s, it would appear twice (in sync and async). If you add it where we talk about parameter encoding, it would awkwardly sit next to VOTable content. In the end, I think this location is the least bad one. Content-wise, I considered whether to warn people that in urlencoded parameters they have to replace + with space and in multipart parameters they don't, but I figured that for almost everyone, this is done by some library. And for that reason, I also don't think we should think about it much more -- *unless* this is becoming an issue and http server implementations don't necessarily support urlencoded any more. Do we have indications that that is the case?
1 parent d7ca8a5 commit 66fbedb

File tree

2 files changed

+30
-3
lines changed

2 files changed

+30
-3
lines changed

DALI.tex

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,12 @@ \section{Resources}
162162
having a single DALI-sync resource where the job is a query and the response is
163163
the result of the query.
164164

165+
When an endpoint supports the POST method to communicate query
166+
parameters, implementing services must accept payloads with media types
167+
application/x-www-form-urlencoded \citep{std:RFC1866} and
168+
multipart/form-data \citep{std:RFC7578}; for file uploads, clients must
169+
use the latter.
170+
165171
\subsection{Asynchronous Execution: DALI-async}
166172
\label{sec:dali-async}
167173
Asynchronous resources are resources that represent a list of asynchronous jobs
@@ -599,7 +605,7 @@ \section{Data Types and Literal Values}
599605
providers to be more explicit by using a fixed size (e.g. \verb|20|) or fixed
600606
with a limit (e.g. \verb|20*|) when applicable.
601607

602-
In the following, where we say "VOTable type metadata", we mean either VOTable
608+
In the following, where we say ``VOTable type metadata'', we mean either VOTable
603609
\xmlel{FIELD} or \xmlel{PARAM} elements.
604610

605611
Services may use non-standard \xmlel{xtype} values for non-standard datatypes, but if they
@@ -724,7 +730,7 @@ \subsection{Multiinterval}
724730
The \verb|multiinterval| xtype is a way to convey complex one dimensional extent
725731
(e.g. the temporal coverage of an observation made by combining several exposures)
726732
made up of multiple intervals. A multiinterval value is interpreted as the union
727-
of all component intervals. Multiple intervals may be serialised in a single value and
733+
of all component intervals. Multiple intervals may be serialised in a single value and
728734
described as (possibly) multiple with the following VOTable type metadata:
729735

730736
\begin{verbatim}
@@ -1767,7 +1773,7 @@ \subsection{PR-DALI-1.0-20130521}
17671773
\subsection{WD-DALI-1.0-20130212}
17681774
Simplified DALI-examples to conform to RDFa-1.1 Lite in usage of attributes.
17691775

1770-
\bibliography{ivoatex/ivoabib,ivoatex/docrepo.bib}
1776+
\bibliography{ivoatex/ivoabib,ivoatex/docrepo.bib,local.bib}
17711777

17721778

17731779
\end{document}

local.bib

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
@Misc{std:RFC1866,
2+
author = {T. Berners-Lee and D. Connolly},
3+
title = {Hypertext Markup Language - 2.0},
4+
howpublished = {RFC 1866},
5+
organization = {{IETF}},
6+
url = {https://datatracker.ietf.org/doc/html/rfc1866},
7+
month = nov,
8+
year = 1995
9+
}
10+
11+
@Misc{std:RFC7578,
12+
author = {L. Masinter},
13+
title = {Returning Values from Forms: multipart/form-data},
14+
howpublished = {RFC 7578},
15+
organization = {{IETF}},
16+
url = {https://datatracker.ietf.org/doc/html/rfc7578},
17+
month = jul,
18+
year = 2015
19+
}
20+
21+

0 commit comments

Comments
 (0)