From 167772bfcd027b8c5896c2c4abff8f2e52158592 Mon Sep 17 00:00:00 2001 From: JustTemmie <47639983+JustTemmie@users.noreply.github.com> Date: Mon, 28 Apr 2025 21:49:59 +0200 Subject: [PATCH] feat: start writing barebones documentation --- API/client-client/v1/versions.md | 34 ++++++++++++++++++++++++++++++++ API/client-server/v1/versions.md | 34 ++++++++++++++++++++++++++++++++ 2 files changed, 68 insertions(+) create mode 100644 API/client-client/v1/versions.md create mode 100644 API/client-server/v1/versions.md diff --git a/API/client-client/v1/versions.md b/API/client-client/v1/versions.md new file mode 100644 index 0000000..41b4596 --- /dev/null +++ b/API/client-client/v1/versions.md @@ -0,0 +1,34 @@ +GET /v1/versions + +--- + +## Request + +No request parameters or request body. + +--- + +## Responses + +|Status|Description| +|-|-| +|200|The versions supported by the client| + +### 200 response + +|Name|Type|Description| +|-|-|-| +|unstable_features|string:bool|**Required**: Unstable features that are supported by the client. Features not listed here indicate that a feature isn't supported.| +|versions|[string]|**Required**: The supported protocol versions + +```json +{ + "unstable_features": { + "example.feature": true + }, + "versions": [ + "0.0.2", + "1", + ] +} +``` \ No newline at end of file diff --git a/API/client-server/v1/versions.md b/API/client-server/v1/versions.md new file mode 100644 index 0000000..84b8854 --- /dev/null +++ b/API/client-server/v1/versions.md @@ -0,0 +1,34 @@ +GET /v1/versions + +--- + +## Request + +No request parameters or request body. + +--- + +## Responses + +|Status|Description| +|-|-| +|200|The versions supported by the server| + +### 200 response + +|Name|Type|Description| +|-|-|-| +|unstable_features|string:bool|**Required**: Unstable features that are supported by the server. Features not listed here indicate that a feature isn't supported.| +|versions|[string]|**Required**: The supported protocol versions + +```json +{ + "unstable_features": { + "example.feature": true + }, + "versions": [ + "0.0.2", + "1", + ] +} +``` \ No newline at end of file