From 4ff125b10b26a9a81808ef829eb39d2cd6edb028 Mon Sep 17 00:00:00 2001 From: Molly Thurin Date: Thu, 9 Apr 2020 16:06:11 +0900 Subject: [PATCH] Document the url parser library in the READ.me docs, as per reviewer's request. [PLAY-2375] --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 7b44d91..a29d186 100644 --- a/README.md +++ b/README.md @@ -349,6 +349,24 @@ retry. Currently, no methods in the storage library mark exceptions as `do_not_retry`. +### url_parser ### + +The `url_parser` module provides a means for client code to sanitize URIs in +such a way that is most appropriate for the way it encodes secret data. + +#### API #### + +##### `sanitize_resource_uri(parsed_uri)` ##### + +Implementation is overly restrictive -- only returning the scheme, hostname, +port and path, no query parameters. + +##### `remove_user_info(parsed_uri)` ##### + +Implementation all credential information before the hostname (if present), and +returns the scheme, hostname, port, path, and query parameters. + + ### Extending ### There are two decorators that can be used when extending the storage library.