Skip to content

Commit

Permalink
Document the url parser library in the READ.me docs, as per reviewer'…
Browse files Browse the repository at this point in the history
…s request.

[PLAY-2375]
  • Loading branch information
shroudofthurin committed Apr 9, 2020
1 parent fb95211 commit 4ff125b
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 4ff125b

Please sign in to comment.