summaryrefslogtreecommitdiffstats
path: root/SPECIFICATION.md
diff options
context:
space:
mode:
authorMateu Aguiló Bosch2017-04-05 06:27:43 +0200
committerMateu Aguiló Bosch2017-04-05 06:27:43 +0200
commit9eab0c32595291090328a167c076eead5271f8b0 (patch)
tree8f3224796cba476779a543cce4a90d9921b26109 /SPECIFICATION.md
parenta8d858b6fd9f9f1513773c069d265a28217fd716 (diff)
docs(Specification): Document GET usage
Diffstat (limited to 'SPECIFICATION.md')
-rw-r--r--SPECIFICATION.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/SPECIFICATION.md b/SPECIFICATION.md
index 7253c61..a330b5a 100644
--- a/SPECIFICATION.md
+++ b/SPECIFICATION.md
@@ -76,6 +76,11 @@ controller that processes the request blueprint. The content type header will
determine what format is used in the blueprint. All the examples in this
document assume `application/json` as the content type.
+You **MAY** send the blueprint document as the payload in a `POST` request.
+Alternatively, you **MAY** also send it in a `GET` request as a [percent
+encoded](https://tools.ietf.org/html/rfc3986#section-2.1) string in a query
+string parameter with the name of `query`.
+
The blueprint document **MUST** be an array of subrequests. Each one of these
subrequests **SHOULD** contain at least the following properties: