Infra-Mirrors/BookStack
1
0
Fork 0
mirror of https://github.com/BookStackApp/BookStack.git synced 2024-10-01 05:36:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added api format advisory regarding PUT/DELETE form data

Browse Source
This commit is contained in:
Dan Brown 2022-09-28 20:15:48 +01:00
parent 60171b3522
commit f79b7bc799
No known key found for this signature in database
GPG Key ID: 46D9F943C24A2EF9
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
resources/views/api-docs/parts/getting-started.blade.php
View File

@ -53,10 +53,19 @@
<ul>
<li>application/json</li>
<li>application/x-www-form-urlencoded</li>
<li>multipart/form-data</li>
<li>application/x-www-form-urlencoded*</li>
<li>multipart/form-data*</li>
</ul>
<p>
<em>
* Form requests currently only work for POST requests due to how PHP handles request data.
If you need to use these formats for PUT or DELETE requests you can work around this limitation by
using a POST request and providing a "_method" parameter with the value equal to
<code>PUT</code> or <code>DELETE</code>.
</em>
</p>
<p>
Regardless of format chosen, ensure you set a <code>Content-Type</code> 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.