mirror of
https://github.com/onyx-and-iris/vmr-http.git
synced 2026-04-06 18:09:11 +00:00
update bus mode PATCH endpoint
accepting {mode: value} is a little redundant but I prefer it to modifying the bus endpoint.
added bus mode PATCH example to README
patch bump
This commit is contained in:
12
README.md
12
README.md
@@ -66,6 +66,18 @@ curl -X 'GET' \
|
|||||||
-H 'accept: application/json'
|
-H 'accept: application/json'
|
||||||
```
|
```
|
||||||
|
|
||||||
|
*Set Bus 2 Mode*
|
||||||
|
|
||||||
|
```console
|
||||||
|
curl -X 'PATCH' \
|
||||||
|
'http://127.0.0.1:8000/bus/2/mode' \
|
||||||
|
-H 'accept: application/json' \
|
||||||
|
-H 'Content-Type: application/json' \
|
||||||
|
-d '{
|
||||||
|
"mode": "Composite"
|
||||||
|
}'
|
||||||
|
```
|
||||||
|
|
||||||
*Healthcheck*
|
*Healthcheck*
|
||||||
|
|
||||||
```console
|
```console
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
[project]
|
[project]
|
||||||
name = "vmr-http"
|
name = "vmr-http"
|
||||||
version = "0.3.2"
|
version = "0.3.3"
|
||||||
description = "HTTP API for controlling Voicemeeter"
|
description = "HTTP API for controlling Voicemeeter"
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
authors = [{ name = "onyx-and-iris", email = "code@onyxandiris.online" }]
|
authors = [{ name = "onyx-and-iris", email = "code@onyxandiris.online" }]
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
"""module for bus mode related endpoints."""
|
"""module for bus mode related endpoints."""
|
||||||
|
|
||||||
from fastapi import APIRouter, Depends, HTTPException
|
from fastapi import APIRouter, Body, Depends, HTTPException
|
||||||
|
|
||||||
from vmr_http.dependencies import get_voicemeeter_client
|
from vmr_http.dependencies import get_voicemeeter_client
|
||||||
|
|
||||||
@@ -25,7 +25,7 @@ _reversed_busmodes = {v: k for k, v in _readable_busmodes.items()}
|
|||||||
|
|
||||||
@router.patch('/{index}/mode')
|
@router.patch('/{index}/mode')
|
||||||
@router.put('/{index}/mode')
|
@router.put('/{index}/mode')
|
||||||
async def update_bus_mode(index: int, mode: str, voicemeeter=Depends(get_voicemeeter_client)):
|
async def update_bus_mode(index: int, mode: str = Body(..., embed=True), voicemeeter=Depends(get_voicemeeter_client)):
|
||||||
"""Update the bus mode for the specified bus index."""
|
"""Update the bus mode for the specified bus index."""
|
||||||
if mode not in _reversed_busmodes:
|
if mode not in _reversed_busmodes:
|
||||||
raise HTTPException(
|
raise HTTPException(
|
||||||
|
|||||||
Reference in New Issue
Block a user