From 352c54ecc4e6b851d8fc49982f90034c100fc7c3 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Tue, 10 Jun 2025 13:52:08 -0700 Subject: [PATCH] Remove inaccurate POST examples from authoring docs --- docs/widgets/authoring/metadata.md | 18 ++---------------- 1 file changed, 2 insertions(+), 16 deletions(-) diff --git a/docs/widgets/authoring/metadata.md b/docs/widgets/authoring/metadata.md index 63e464e11..0ea2eec7c 100644 --- a/docs/widgets/authoring/metadata.md +++ b/docs/widgets/authoring/metadata.md @@ -225,20 +225,8 @@ const widgetExample = { #### `method` -The `method` property is a string that represents the HTTP method that should be used to make the API request. The default value is `GET`. - -```js -const widgetExample = { - api: "{url}/api/{endpoint}", - mappings: { - // `/api/stats` - stats: { - endpoint: "stats", - method: "POST", - }, - }, -}; -``` +The `method` represents the HTTP method that should be used to make the API request. The default value is `GET`. Note that `POST` requests are not allowed via the +widget API and require the use of a custom proxy. #### `headers` @@ -251,7 +239,6 @@ const widgetExample = { // `/api/stats` stats: { endpoint: "stats", - method: "POST", headers: { "Content-Type": "application/json", }, @@ -271,7 +258,6 @@ const widgetExample = { // `/api/graphql` stats: { endpoint: "graphql", - method: "POST", body: { query: ` query {