Skip to content

Commit

Permalink
Updated documentation for PUT/PATCH/DELETE methods
Browse files Browse the repository at this point in the history
  • Loading branch information
jjdmol committed Apr 20, 2022
1 parent 5952f96 commit 1b57bcf
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
<!-- ALL-CONTRIBUTORS-BADGE:END -->

It provides a simple Grafana 7.x panel that shows only one button - to integrate with any kind of HTTP/REST API:
* Support `GET` and `POST` HTTP verb
* Support `GET`, `POST`, `PUT`, `PATCH` and `DELETE` HTTP verb
* Adds no new javascript dependencies
* Uses standard browser APIs and respects CORS
* Optional text payload for `POST` requests via syntax-highlighiting editor
* Support for custom header parameter or query parameter
* Variable support via `$variableName` in
* URL
* Header/Query parameter name & value
* POST body payload
* POST/PUT/PATCH body payload
* Button label
* Support for HTTP Basic Auth
* Custom label text & Grafana template design
Expand All @@ -38,7 +38,7 @@ Due to the Grafana API & security restrictions in modern browsers the following
* Neither username nor password are stored encryted in Grafana.
The password is there to everyone with access to the dashboard in Grafana!
* The *server* at the URL _must_ provide proper resposne to the [CORS pre-flight request](https://developer.mozilla.org/en-US/docs/Glossary/Preflight_request). That is:
* Provide a proper response to the `OPTIONS` request performed by the browser before the actual `GET`/`POST` requiest is issued
* Provide a proper response to the `OPTIONS` request performed by the browser before the actual `GET`/`POST`/`PUT`/`PATCH`/`DELETE` request is issued
* Provide a [`Access-Control-Allow-Credentials: true`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials) header
* Provide a proper [`Access-Control-Allow-Origin`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin) header.
_No wildcards_ are allowed if credentials are used!
Expand Down

0 comments on commit 1b57bcf

Please sign in to comment.