Skip to content

Commit d32363e

Browse files
committed
2 parents 7179bd3 + 97ee5a0 commit d32363e

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

HWA-Client-Whitepaper.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,10 @@ The goal is to provide all nessesary informations on how to obtain test data, pr
55

66
## Version
77
- 0.00 Draft, 06.02.2024, JPVenson
8-
- 0.01 Draft, 08.02.2024, JPVenson
8+
- 0.01 Draft, 08.02.2024, JPVenson
99
Added Platform api, fixed several typos, refactored response type.
10+
- 0.02 Draft, 02.10.2024, JPVenson
11+
Added new server URL, added architecture selector
1012

1113
# Abstract
1214

@@ -15,7 +17,7 @@ https://www.rfc-editor.org/rfc/rfc2119
1517

1618

1719

18-
All references to the HWA-Server are assumed to target the current running http server running at `https://jellyfin.jpb.software`.
20+
All references to the HWA-Server are assumed to target the current running http server running at `https://hwa.jellyfin.org`.
1921
All http calls are assumed to be requested from the same IP.
2022
All http results can be requested as `application/json` as well as `application/xml`, for the sake of this document; all return values are shown as JSON.
2123

@@ -52,7 +54,8 @@ content-type: application/json; charset=utf-8
5254
"version_id": "string",
5355
"display_name": "string",
5456
"replacement_id": "string",
55-
"supported": "boolean"
57+
"supported": "boolean",
58+
"architecture": "amd64" | "x32" | "arm64"
5659
}
5760
]
5861
}
@@ -75,7 +78,9 @@ DISTRIB_ID=Ubuntu
7578
DISTRIB_RELEASE=22.04
7679
```
7780

78-
So you can match them directly. You **must** always try to select the exact match for your operating system. In case the version is not supported but present in the list of platforms, you **must** use the corresponding platform via the `replacement_id`. In case no exact match is found you _may_ implement a alternative matching method or you _may_ use the corresponding custom type that will show the `version` and `version_id` set to `UnkownOperatingSystem`. When using the `UnknownOperatingSystem` key, you **must** provide the corresponding values that shall be used for matching in the result json under the `os` property.
81+
So you can match them directly. You **must** always try to select the exact match for your operating system. In case the version is not supported but present in the list of platforms, you **must** use the corresponding platform via the `replacement_id`. In case no exact match is found you _may_ implement a alternative matching method or you _may_ use the corresponding custom type that will show the `version` and `version_id` set to `UnkownOperatingSystem`. You will also have to take the underlying system architecture into account, match it with all 3 available architectures.
82+
83+
When using the `UnknownOperatingSystem` key, you **must** provide the corresponding values that shall be used for matching in the result json under the `os` property.
7984

8085
The media api can be expected to look like this:
8186

0 commit comments

Comments
 (0)