uup-dump/json-api
9
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Changed UUID information, removed header underline

Browse Source
This commit is contained in:
awuctl 2020-03-11 19:33:22 +01:00 committed by GitHub
parent 72dd387e3a
commit 63b40fb19f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
readme.md
View File

@ -1,5 +1,4 @@
# UUP dump JSON API # UUP dump JSON API
-----------------
## Description ## Description
A simple endpoint allowing access to the UUP dump API using simple HTTP GET requests. A simple endpoint allowing access to the UUP dump API using simple HTTP GET requests.
@ -56,7 +55,7 @@ Parameters:
"build": "string", // Update build number, for example 19577.1000 "build": "string", // Update build number, for example 19577.1000
"arch": " string", // Update architecture, for example amd64 "arch": " string", // Update architecture, for example amd64
"created": 1234567890, // Timestamp of when the build was added to the database "created": 1234567890, // Timestamp of when the build was added to the database
"uuid": "string" // UUIDv4 Update Identifier "uuid": "string" // UUID Update Identifier
}, },
... ...
] ]
@ -95,14 +94,14 @@ Parameters:
{ {
"response": { "response": {
"apiVersion": "string", // Current UUP dump API version "apiVersion": "string", // Current UUP dump API version
"updateId": "string", // UUIDv4 Update Identifier "updateId": "string", // UUID Update Identifier
"updateTitle": "string", // Update title, such as Windows 10 Insider Preview 19577.1000 (rs_prerelease) "updateTitle": "string", // Update title, such as Windows 10 Insider Preview 19577.1000 (rs_prerelease)
"foundBuild": "string", // Update build number, such as 19577.1000 "foundBuild": "string", // Update build number, such as 19577.1000
"arch": "string", // Update architecture, such as amd64/x86/arm64 "arch": "string", // Update architecture, such as amd64/x86/arm64
"fileWrite": "string", // NO_SAVE if the build was already in the database, INFO_WRITTEN if it was just added to it. "fileWrite": "string", // NO_SAVE if the build was already in the database, INFO_WRITTEN if it was just added to it.
"updateArray": [ "updateArray": [
{ {
"updateId": "string", // UUIDv4 Update Identifier "updateId": "string", // UUID Update Identifier
"updateTitle": "string", // Update title, such as Windows 10 Insider Preview 19577.1000 (rs_prerelease) "updateTitle": "string", // Update title, such as Windows 10 Insider Preview 19577.1000 (rs_prerelease)
"foundBuild": "string", // Update build number, such as 19577.1000 "foundBuild": "string", // Update build number, such as 19577.1000
"arch": "string", // Update architecture, such as amd64/x86/arm64 "arch": "string", // Update architecture, such as amd64/x86/arm64
@ -119,8 +118,8 @@ Retrieves download links for specified Update ID and provides lists of ready to
use UUP sets. use UUP sets.
Parameters: Parameters:
- `id` - Update identifier (UUIDv4 string) - `id` - Update identifier (UUID string)
- **Supported values:** Any valid update identifier in the UUIDv4 format. - **Supported values:** Any valid update identifier in the UUID format, may include revision in the following format: "UUID_rev.2".
- `lang` - Create UUP set for selected language (optional) - `lang` - Create UUP set for selected language (optional)
- **Supported values:** Language name in xx-xx format. - **Supported values:** Language name in xx-xx format.
@ -160,8 +159,8 @@ Parameters:
Lists available languages for the specified Update ID. Lists available languages for the specified Update ID.
Parameters: Parameters:
- `id` - Optional Update identifier (UUIDv4 string) - `id` - Optional Update identifier (UUID string)
- **Supported values:** Any valid update identifier in the UUIDv4 format. - **Supported values:** Any valid update identifier in the UUID format, may include revision in the following format: "UUID_rev.2".
#### JSON response format: #### JSON response format:
```javascript ```javascript
@ -188,8 +187,8 @@ Parameters:
- `lang` - Generate edition list for the selected language - `lang` - Generate edition list for the selected language
- **Supported values:** Language name in xx-xx format - **Supported values:** Language name in xx-xx format
- `id` - Optional update identifier (UUIDv4 string) - `id` - Optional update identifier (UUID string)
- **Supported values:** Any valid update identifier in the UUIDv4 format. - **Supported values:** Any valid update identifier in the UUID format, may include revision in the following format: "UUID_rev.2".
#### JSON response format: #### JSON response format:
```javascript ```javascript