Skip to content

Commit 0be7a79

Browse files
authored
OpenAPI: Add link to our "Data Access Policy" in the description (#10613)
1 parent 11b1c18 commit 0be7a79

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

src/openapi.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ This document describes the API used by the crates.io website, cargo
1212
client, and other third-party tools to interact with the crates.io
1313
registry.
1414
15+
Before using this API, please read the
16+
[crates.io data access policy](https://crates.io/data-access) and ensure
17+
that your use of the API complies with the policy.
18+
1519
__The API is under active development and may change at any time__,
1620
though we will try to avoid breaking changes where possible.
1721

src/snapshots/crates_io__openapi__tests__openapi_snapshot.snap

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ expression: response.json()
2424
"email": "[email protected]",
2525
"name": "the crates.io team"
2626
},
27-
"description": "\n__Experimental API documentation for the [crates.io](https://crates.io/)\npackage registry.__\n\nThis document describes the API used by the crates.io website, cargo\nclient, and other third-party tools to interact with the crates.io\nregistry.\n\n__The API is under active development and may change at any time__,\nthough we will try to avoid breaking changes where possible.\n\nSome parts of the API follow the \"Registry Web API\" spec documented\nat <https://doc.rust-lang.org/cargo/reference/registry-web-api.html>\nand can be considered stable.\n\nMost parts of the API do not require authentication. The endpoints\nthat do require authentication are marked as such in the documentation,\nwith some requiring cookie authentication (usable only by the web UI)\nand others requiring API token authentication (usable by cargo and\nother clients).\n",
27+
"description": "\n__Experimental API documentation for the [crates.io](https://crates.io/)\npackage registry.__\n\nThis document describes the API used by the crates.io website, cargo\nclient, and other third-party tools to interact with the crates.io\nregistry.\n\nBefore using this API, please read the\n[crates.io data access policy](https://crates.io/data-access) and ensure\nthat your use of the API complies with the policy.\n\n__The API is under active development and may change at any time__,\nthough we will try to avoid breaking changes where possible.\n\nSome parts of the API follow the \"Registry Web API\" spec documented\nat <https://doc.rust-lang.org/cargo/reference/registry-web-api.html>\nand can be considered stable.\n\nMost parts of the API do not require authentication. The endpoints\nthat do require authentication are marked as such in the documentation,\nwith some requiring cookie authentication (usable only by the web UI)\nand others requiring API token authentication (usable by cargo and\nother clients).\n",
2828
"license": {
2929
"name": "MIT OR Apache-2.0",
3030
"url": "https://github.com/rust-lang/crates.io/blob/main/README.md#%EF%B8%8F-license"

0 commit comments

Comments
 (0)