jordon/HarmonyLink
1
0
Fork 0
Code Issues Pull requests Projects Releases 5 Packages Wiki Activity Actions

Updated Endpoints (markdown)

Jordon Brooks 2023-06-26 20:40:43 +01:00
parent 0a00b2e8e8
commit 5cee6e31dd
1 changed files with 35 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

38
Endpoints.md

@ -14,6 +14,11 @@ Returns a JSON object containing information about various aspects of the system
- **URL:** `/v1/all_info`
- **Method:** `GET`
- **Response Description:**
- `os`: A JSON object containing the operating system information
- `battery`: A JSON object containing the battery status information
- `dock`: A JSON object containing the dock information
- `version`: A JSON object containing the version information of the server application
- **Sample Response:**
```json
{
@ -58,6 +63,11 @@ Returns a JSON object containing information about the operating system.
- **URL:** `/v1/os_info`
- **Method:** `GET`
- **Response Description:**
- `platform`: The type of operating system, e.g., "WINDOWS"
- `name`: The name of the operating system, e.g., "Windows 11 Core"
- `version`: The version of the operating system
- `bits`: The bit architecture of the operating system, e.g., "X86_64"
- **Sample Response:**
```json
{
@ -73,11 +83,15 @@ Returns a JSON object containing information about the battery status.
- **URL:** `/v1/battery_info`
- **Method:** `GET`
- **Possible Charging Status:** "UNKNOWN", "BATTERY", "CHARGING"
- **Response Description:**
- `has_battery`: A boolean indicating whether the device has a battery
- `battery_percent`: The percentage of battery remaining
- `charging_status`: The charging status of the battery, can be "UNKNOWN", "BATTERY", "CHARGING"
- **Sample Response:**
```json
{
"has_battery": false,
"has_battery":```markdown
false,
"battery_percent": 0,
"charging_status": "UNKNOWN"
}
@ -88,6 +102,18 @@ Returns a JSON object containing information about the version of the server app
- **URL:** `/v1/version_info`
- **Method:** `GET`
- **Response Description:**
- `build_timestamp`: The timestamp when the current server build was created
- `git_branch`: The git branch name associated with the current build
- `git_describe`: Description provided through git for the current build
- `git_commit_timestamp`: The timestamp when the current git commit was made
- `debug`: A boolean indicating whether the current build is a debug version
- `version`: The version number of the server application
- `version_major`: The major version number
- `version_minor`: The minor version number
- `version_patch`: The patch version number
- `version_pre`: Any pre-release version information
- `supported_api_versions`: An array containing the versions of the API that are currently supported
- **Sample Response:**
```json
{
@ -98,7 +124,6 @@ Returns a JSON object containing information about the version of the server app
"debug": true,
"version": "0.1.0",
"version_major": 0,
```markdown
"version_minor": 1,
"version_patch": 0,
"version_pre": "",
@ -111,6 +136,13 @@ Returns a JSON object containing information about the dock.
- **URL:** `/v1/dock_info`
- **Method:** `GET`
- **Response Description:**
- `dock_info`: A JSON object containing information about the dock
- `brand`: The brand of the dock
- `model`: The model of the dock
- `usb_ids`: An array containing the USB IDs associated with the dock
- `is_docked`: A boolean indicating whether the device is currently docked
- `fallback_detection`: A boolean indicating whether fallback detection is being used for the dock
- **Sample Response:**
```json
{