X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/50f3c10f19c04f67d08b5541b17044f8ca5fd0fd..refs/pull/5676/head:/resources/views/api-docs/parts/getting-started.blade.php diff --git a/resources/views/api-docs/parts/getting-started.blade.php b/resources/views/api-docs/parts/getting-started.blade.php index 75b71c6be..229fe7dce 100644 --- a/resources/views/api-docs/parts/getting-started.blade.php +++ b/resources/views/api-docs/parts/getting-started.blade.php @@ -66,6 +66,12 @@

+

+ + * Form requests can accept boolean (true/false) values via a 1 or 0. + +

+

Regardless of format chosen, ensure you set a Content-Type header on requests so that the system can correctly parse your request data. The API is primarily designed to be interfaced using JSON, since responses are always in JSON format, hence examples in this documentation will be shown as JSON. @@ -82,17 +88,19 @@

{
   "name": "My new item",
+  "locked": true,
   "books": [105, 263],
   "tags": [{"name": "Tag Name", "value": "Tag Value"}],
 }

x-www-form-urlencoded

-
name=My%20new%20item&books%5B0%5D=105&books%5B1%5D=263&tags%5B0%5D%5Bname%5D=Tag%20Name&tags%5B0%5D%5Bvalue%5D=Tag%20Value
+
name=My%20new%20item&locked=1&books%5B0%5D=105&books%5B1%5D=263&tags%5B0%5D%5Bname%5D=Tag%20Name&tags%5B0%5D%5Bvalue%5D=Tag%20Value

x-www-form-urlencoded (Decoded for readability)

name=My new item
+locked=1
 books[0]=105
 books[1]=263
 tags[0][name]=Tag Name