From a492006d678f964a373b27c1f87542f7d06fbb4a Mon Sep 17 00:00:00 2001 From: onyx-and-iris Date: Sun, 5 Apr 2026 23:19:35 +0100 Subject: [PATCH] add link to API_EXAMPLES in README --- API_EXAMPLES.md | 30 ++++++++++++++++++++++++++++-- README.md | 4 +++- 2 files changed, 31 insertions(+), 3 deletions(-) diff --git a/API_EXAMPLES.md b/API_EXAMPLES.md index 2c38241..345e208 100644 --- a/API_EXAMPLES.md +++ b/API_EXAMPLES.md @@ -1,4 +1,4 @@ -# API Usage Examples +# API Usage ## Prerequisites @@ -62,6 +62,32 @@ curl -X 'PATCH' \ }' ``` +## Strip Gate Router + +### */strip/{index}/gate* + +> Get single parameter + +```console +curl -X 'GET' \ + 'http://127.0.0.1:8000/strip/0/gate/knob' \ + -H 'accept: application/json' +``` + +> Set multiple parameters + +```console +curl -X 'PATCH' \ + 'http://127.0.0.1:8000/strip/0/gate' \ + -H 'accept: application/json' \ + -H 'Content-Type: application/json' \ + -d '{ + "threshold": -28.7, + "damping": -60, + "attack": 2 +}' +``` + --- ## Bus Router @@ -72,7 +98,7 @@ curl -X 'PATCH' \ ```console curl -X 'GET' \ - 'http://127.0.0.1:8000/bus/1/mono' \ + 'http://127.0.0.1:8000/bus/0/mono' \ -H 'accept: application/json' ``` diff --git a/README.md b/README.md index 4802d33..9eea9e4 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,9 @@ uvicorn vmr_http:app ## Documentation -FastAPI generates [automatic docs][auto-docs], simply launch the server and then visit: +For a few examples see [./API_EXAMPLES.md]. + +For an exhaustive list of the endpoints FastAPI generates [automatic docs][auto-docs], simply launch the server and then visit: *Swagger UI* - http://localhost:8000/docs