From f79b7bc7994cbaeca6764ef2602b569cc9b07a52 Mon Sep 17 00:00:00 2001 From: Dan Brown Date: Wed, 28 Sep 2022 20:15:48 +0100 Subject: [PATCH] Added api format advisory regarding PUT/DELETE form data --- .../views/api-docs/parts/getting-started.blade.php | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/resources/views/api-docs/parts/getting-started.blade.php b/resources/views/api-docs/parts/getting-started.blade.php index 76da73e45..7358b5cd7 100644 --- a/resources/views/api-docs/parts/getting-started.blade.php +++ b/resources/views/api-docs/parts/getting-started.blade.php @@ -53,10 +53,19 @@ +

+ + * 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 + PUT or DELETE. + +

+

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.