vh/homepage
1
0
Fork 0
mirror of https://github.com/gethomepage/homepage.git synced 2025-12-07 01:26:01 -08:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

Remove inaccurate POST examples from authoring docs
Some checks failed
Docker CI / Linting Checks (push) Has been cancelled
Details
Docs / Linting Checks (push) Has been cancelled
Details
Docker CI / Docker Build & Push (push) Has been cancelled
Details
Docs / Test Build Docs (push) Has been cancelled
Details
Docs / Build & Deploy Docs (push) Has been cancelled
Details
Repository Maintenance / Stale (push) Has been cancelled
Details
Repository Maintenance / Lock Old Threads (push) Has been cancelled
Details
Repository Maintenance / Close Answered Discussions (push) Has been cancelled
Details
Repository Maintenance / Close Outdated Discussions (push) Has been cancelled
Details
Repository Maintenance / Close Unsupported Feature Requests (push) Has been cancelled
Details
Crowdin Action / Crowdin Sync (push) Has been cancelled
Details

Browse Source
This commit is contained in:
shamoon
2025-06-10 13:52:08 -07:00
committed by GitHub
parent 1147fc858f
commit 352c54ecc4
1 changed files with 2 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/widgets/authoring/metadata.md
View File

@@ -225,20 +225,8 @@ const widgetExample = {
#### `method` #### `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`. 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.
```js
const widgetExample = {
api: "{url}/api/{endpoint}",
mappings: {
// `/api/stats`
stats: {
endpoint: "stats",
method: "POST",
},
},
};
```
#### `headers` #### `headers`
@@ -251,7 +239,6 @@ const widgetExample = {
// `/api/stats` // `/api/stats`
stats: { stats: {
endpoint: "stats", endpoint: "stats",
method: "POST",
headers: { headers: {
"Content-Type": "application/json", "Content-Type": "application/json",
}, },
@@ -271,7 +258,6 @@ const widgetExample = {
// `/api/graphql` // `/api/graphql`
stats: { stats: {
endpoint: "graphql", endpoint: "graphql",
method: "POST",
body: { body: {
query: ` query: `
query { query {