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 21:14:37 +01:00
parent e96c02bbca
commit c285f36fcf
1 changed files with 7 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

18
Endpoints.md

@ -1,15 +1,11 @@
# HarmonyLinkServer API Documentation # Are You There
## Endpoints
### 1. Are You There
A simple endpoint that checks if the server is up and running. A simple endpoint that checks if the server is up and running.
- **URL:** `/v1/are_you_there` - **URL:** `/v1/are_you_there`
- **Method:** `GET` - **Method:** `GET`
- **Response:** A simple "yes" response. - **Response:** A simple "yes" response.
### 2. All Info # All Info
Returns a JSON object containing information about various aspects of the system, including OS, battery, dock, and version information. Returns a JSON object containing information about various aspects of the system, including OS, battery, dock, and version information.
- **URL:** `/v1/all_info` - **URL:** `/v1/all_info`
@ -58,7 +54,7 @@ Returns a JSON object containing information about various aspects of the system
} }
``` ```
### 3. OS Info # OS Info
Returns a JSON object containing information about the operating system. Returns a JSON object containing information about the operating system.
- **URL:** `/v1/os_info` - **URL:** `/v1/os_info`
@ -78,7 +74,7 @@ Returns a JSON object containing information about the operating system.
} }
``` ```
### 4. Battery Info # Battery Info
Returns a JSON object containing information about the battery status. Returns a JSON object containing information about the battery status.
- **URL:** `/v1/battery_info` - **URL:** `/v1/battery_info`
@ -96,7 +92,7 @@ Returns a JSON object containing information about the battery status.
} }
``` ```
### 5. Version Info # Version Info
Returns a JSON object containing information about the version of the server application. Returns a JSON object containing information about the version of the server application.
- **URL:** `/v1/version_info` - **URL:** `/v1/version_info`
@ -130,7 +126,7 @@ Returns a JSON object containing information about the version of the server app
} }
``` ```
### 6. Dock Info # Dock Info
Returns a JSON object containing information about the dock. Returns a JSON object containing information about the dock.
- **URL:** `/v1/dock_info` - **URL:** `/v1/dock_info`
@ -155,7 +151,7 @@ Returns a JSON object containing information about the dock.
} }
``` ```
### 7. Supported Versions # Supported Versions
Returns an array containing the versions of the API that are currently supported. Returns an array containing the versions of the API that are currently supported.
- **URL:** `/api/supported_versions` - **URL:** `/api/supported_versions`