Skip to content

Commit 8b36a5c

Browse files
benev0lpil
authored andcommitted
update of regestry v2 request builder function docs
1 parent 7ae67ad commit 8b36a5c

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

src/lib.rs

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -244,6 +244,14 @@ pub fn unretire_release_response(response: http::Response<Vec<u8>>) -> Result<()
244244

245245
/// Create a request that get the names and versions of all of the packages on
246246
/// the package registry.
247+
///
248+
/// Uses the registry v2 API.
249+
/// Responses use gz encoding and are wrapped in a signing message.
250+
/// For direct usage of response see below:
251+
///
252+
/// https://github.com/hexpm/specifications/blob/main/registry-v2.md
253+
/// Recommended sections: (#registry-files, #signing, #decoding-registry-files)
254+
///
247255
/// TODO: Where are the API docs for this?
248256
pub fn get_repository_versions_request(
249257
api_key: Option<&str>,
@@ -308,6 +316,13 @@ pub fn parse_repository_v2_versions(
308316

309317
/// Create a request to get the information for a package in the repository.
310318
///
319+
/// Uses the registry v2 API.
320+
/// Responses use gz encoding and are wrapped in a signing message.
321+
/// For direct usage of response see below:
322+
///
323+
/// https://github.com/hexpm/specifications/blob/main/registry-v2.md
324+
/// Recommended sections: (#registry-files, #signing, #decoding-registry-files)
325+
///
311326
/// API Docs:
312327
///
313328
/// https://github.com/hexpm/hex/blob/main/lib/mix/tasks/hex.package.ex#L348

0 commit comments

Comments
 (0)