From 6988f0df923407f62ffbe173a18bb7de3d3f81e3 Mon Sep 17 00:00:00 2001
From: Carl Kittelberger <icedream@icedream.pw>
Date: Fri, 15 Mar 2024 16:13:50 +0100
Subject: [PATCH] Start document on EAAS.

---
 docs/EAAS.md | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 docs/EAAS.md

diff --git a/docs/EAAS.md b/docs/EAAS.md
new file mode 100644
index 0000000..ffaa6df
--- /dev/null
+++ b/docs/EAAS.md
@@ -0,0 +1,56 @@
+# EAAS
+
+## GRPC
+
+The GRPC server listens on port 50010.
+
+### `networktrust.v1.NetworkTrustService/CreateTrust`
+
+#### Request parameters
+
+- `string` - UUID of the device requesting trust
+- `string` - Name of the device requesting trust
+
+#### Response
+
+GRPC status is always 0. Status can be one of the values for Granted, Denied or Busy.
+
+### `enginelibrary.v1.EngineLibraryService/GetLibrary`
+### `enginelibrary.v1.EngineLibraryService/EventStream`
+### `enginelibrary.v1.EngineLibraryService/GetTracks`
+### `enginelibrary.v1.EngineLibraryService/GetTrack`
+### `enginelibrary.v1.EngineLibraryService/PutEvents`
+### `enginelibrary.v1.EngineLibraryService/SearchTracks`
+### `enginelibrary.v1.EngineLibraryService/GetSearchFilters`
+### `enginelibrary.v1.EngineLibraryService/GetLibraries`
+### `enginelibrary.v1.EngineLibraryService/GetHistorySessions`
+### `enginelibrary.v1.EngineLibraryService/GetHistoryPlayedTracks`
+### `enginelibrary.v1.EngineLibraryService/GetCredentials`
+
+
+
+## HTTP
+
+The HTTP server listens on port 50020.
+
+### `GET /ping`
+
+Returns an empty `200 OK` response to ensure the client the server is still
+reachable.
+
+### `GET /download/:path`
+
+Provide a given audio file.
+
+#### Request parameters
+
+- `:path` - Full path to audio file to deliver. Normally URL-encoded.
+
+#### Response
+
+The response is the audio file itself.
+
+#### Remarks
+
+Server should return proper `Content-length`, however `Content-type` does not
+seem to matter as it can be set to `application/octet-stream`.