Skip to content

Commit 0f38bcf

Browse files
authored
Updated README.md (#776)
1 parent 614cf7c commit 0f38bcf

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,6 @@ This repo contains:
1414
- [vsts-api-patcher](vsts-api-patcher/): A tool to patch the OpenAPI spec. This modifies the original OpenAPI spec to fix known issues and/or improve the generated code.
1515
- [azure_devops_rust_api](azure_devops_rust_api/): The autogenerated crate, plus the hand-written `artifacts_download` module (see below).
1616

17-
## Artifact downloads
18-
19-
Most of `azure_devops_rust_api` is auto-generated from the OpenAPI spec and provides thin wrappers
20-
around the Azure DevOps REST API endpoints. The `artifacts_download` module is different: it is a
21-
hand-written, higher-level module that implements the full protocol for downloading
22-
[Universal Packages](https://docs.microsoft.com/en-us/azure/devops/artifacts/universal-packages/universal-packages-overview)
23-
from Azure Artifacts.
24-
25-
It handles the entire download flow — service URL discovery, package metadata retrieval, blob URL
26-
resolution, chunk download, decompression, and file reassembly — behind a single
27-
`download_universal_package` call.
28-
29-
See [azure_devops_rust_api/README.md](azure_devops_rust_api/README.md) for usage details.
30-
3117
## Usage of generated `azure_devops_rust_api` crate
3218

3319
For documentation on usage of the generated crate, see the `azure_devops_rust_api`:
@@ -46,6 +32,20 @@ For documentation on usage of the generated crate, see the `azure_devops_rust_ap
4632

4733
The generated crate is manually published to the public Rust crate registry ([crates.io](https://crates.io/)) as [`azure_devops_rust_api`](https://crates.io/crates/azure_devops_rust_api).
4834

35+
## Artifact downloads
36+
37+
Most of `azure_devops_rust_api` is auto-generated from the OpenAPI spec and provides thin wrappers
38+
around the Azure DevOps REST API endpoints. The `artifacts_download` module is different: it is a
39+
hand-written, higher-level module that implements the full protocol for downloading
40+
[Universal Packages](https://docs.microsoft.com/en-us/azure/devops/artifacts/universal-packages/universal-packages-overview)
41+
from Azure Artifacts.
42+
43+
It handles the entire download flow — service URL discovery, package metadata retrieval, blob URL
44+
resolution, chunk download, decompression, and file reassembly — behind a single
45+
`download_universal_package` call.
46+
47+
See [azure_devops_rust_api/README.md](azure_devops_rust_api/README.md) for usage details.
48+
4949
## Managing the version of the OpenAPI spec
5050

5151
The Azure DevOps OpenAPI spec is included as a git submodule linked to a specific version

0 commit comments

Comments
 (0)