From 92bc6717683dc6c63b9e61fcae515e3b2a5e3fcc Mon Sep 17 00:00:00 2001 From: awuctl Date: Wed, 11 Mar 2020 10:27:18 +0100 Subject: [PATCH] Improved readme --- readme.md | 52 ++++++++++++++++++++++++++++------------------------ 1 file changed, 28 insertions(+), 24 deletions(-) diff --git a/readme.md b/readme.md index d5dadd0..61455b0 100644 --- a/readme.md +++ b/readme.md @@ -2,11 +2,11 @@ UUP dump JSON API ----------------- ### Description -A simple endpoint allowing access of the UUP dump API using HTTP requests. +A simple endpoint allowing access to the UUP dump API using simple HTTP GET requests. ### Usage All requests are done using GET requests with parameters specified in the URL. -Response is provided as an JSON. +Responses are provided in JSON format. Example response: ```json @@ -36,68 +36,72 @@ Parameters: - None #### `/listid.php` -Returns a list of builds in the local database. +Returns a list of builds in the local database. (like "Browse the list of known builds" on the website) Parameters: - - `search` - Search query (optional) + - `search` - Optional search query - **Supported values:** any text - - `sortByDate` - Sort results by creation date (optional) + - `sortByDate` - Optional sorting results by creation date - **Supported values:** 0 = Disable, 1 = Enable #### `/fetchupd.php` Fetches the latest builds from Windows Update servers using specified -parameters. +parameters. (like "Fetch the latest build" on the website) Parameters: - - `arch` - Architecture of build to find + - `arch` - Specifies which architecture the API will return. - **Supported values:** `amd64`, `arm64`, `x86` - - `ring` - Ring to use when fetching information + - `ring` - Specifies the ring the API uses when querying Windows Update servers. - **Supported values:** `WIF`, `WIS`, `RP`, `RETAIL` + - `WIF` - Windows Insider Fast + - `WIS` - Windows Insider Slow + - `RP` - Release Preview + - `RETAIL` - Retail - `flight` - Flight to use when fetching information - **Supported values:** `Active`, `Skip`, `Current` - **NOTE:** `Skip` is for `WIF` ring only. `Current` is for `RP` ring only. - - `build` - Build number to use when fetching information + - `build` - Build number to use by the API when fetching information - **Supported values:** >= 9841 and <= PHP_INT_MAX-1 - `sku` - SKU number to use when fetching information - - **Supported values:** Any integer + - **Supported values:** Any SKU integer #### `/get.php` Retrieves download links for specified Update ID and provides lists of ready to use UUP sets. Parameters: - - `id` - Update identifier - - **Supported values:** any update identifier + - `id` - Update identifier (UUIDv4 string) + - **Supported values:** Any valid update identifier in the UUIDv4 format. - `lang` - Create UUP set for selected language (optional) - **Supported values:** language name in xx-xx format - - `edition` - Create UUP set for selected edition (optional) - - **Supported values:** any edition name - - **NOTE:** You need to specify `lang` to get successful request + - `edition` - Create UUP set for the selected edition (optional) + - **Supported values:** Any edition name + - **NOTE:** Must be used with `lang` - - `noLinks` - Do not retrieve download links for created UUP set (optional) + - `noLinks` - Do not retrieve download links for the created UUP set (optional) - **Supported values:** 0 = Disable, 1 = Enable #### `/listlangs.php` -Lists available languages for specified Update ID +Lists available languages for the specified Update ID. Parameters: - - `id` - Update identifier (optional) - - **Supported values:** any update identifier + - `id` - Optional Update identifier (UUIDv4 string) + - **Supported values:** Any valid update identifier in the UUIDv4 format. #### `/listlangs.php` -Lists available editions for specified Update ID +Lists available editions for the specified Update ID. Parameters: - - `lang` - Generate list for selected language - - **Supported values:** language name in xx-xx format +- `lang` - Generate edition list for the selected language + - **Supported values:** Language name in xx-xx format - - `id` - Update identifier (optional) - - **Supported values:** any update identifier + - `id` - Optional update identifier (UUIDv4 string) + - **Supported values:** Any valid update identifier in the UUIDv4 format.