From 66dbe5eb59b98c88c8d9cd6f88bc96b47a847c15 Mon Sep 17 00:00:00 2001 From: Tobias Bieniek Date: Tue, 18 Feb 2025 09:51:09 +0100 Subject: [PATCH] OpenAPI: Add link to our "Data Access Policy" in the description --- src/openapi.rs | 4 ++++ .../crates_io__openapi__tests__openapi_snapshot.snap | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/src/openapi.rs b/src/openapi.rs index 069d9e9a49f..105c2280084 100644 --- a/src/openapi.rs +++ b/src/openapi.rs @@ -12,6 +12,10 @@ This document describes the API used by the crates.io website, cargo client, and other third-party tools to interact with the crates.io registry. +Before using this API, please read the +[crates.io data access policy](https://crates.io/data-access) and ensure +that your use of the API complies with the policy. + __The API is under active development and may change at any time__, though we will try to avoid breaking changes where possible. diff --git a/src/snapshots/crates_io__openapi__tests__openapi_snapshot.snap b/src/snapshots/crates_io__openapi__tests__openapi_snapshot.snap index 33af3856b16..c32ab7d2c54 100644 --- a/src/snapshots/crates_io__openapi__tests__openapi_snapshot.snap +++ b/src/snapshots/crates_io__openapi__tests__openapi_snapshot.snap @@ -24,7 +24,7 @@ expression: response.json() "email": "help@crates.io", "name": "the crates.io team" }, - "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 \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", + "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 \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", "license": { "name": "MIT OR Apache-2.0", "url": "https://github.com/rust-lang/crates.io/blob/main/README.md#%EF%B8%8F-license"