Skip to content

Breakout Requests Functionality to New Adapter Module #223

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Jul 19, 2018
Merged

Breakout Requests Functionality to New Adapter Module #223

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
81c6fe1
Include class constructors with autodoc modules
Jul 16, 2018
2e36e8a
add breaking changes section
Jul 16, 2018
8bc0c97
Add adapters and utils modules
Jul 16, 2018
203fc10
Move client class to use adapters.Request
Jul 16, 2018
3fffbe1
Merge remote-tracking branch 'upstream/master' into adapter_pattern
Jul 16, 2018
3df8412
Expand raise_for_error docstring
Jul 16, 2018
1e57318
Clarify purpose of newly added sphinx conf skip() method
Jul 16, 2018
2dd7117
Fewer line breaks
Jul 16, 2018
7d289a6
Clarify language
Jul 16, 2018
e4c49cf
Add initial guide/documentation around new adapter module
Jul 18, 2018
04116de
Migrate last requests call out of Client class and into aws_utils
Jul 18, 2018
3a92e78
Update put call in recently added read_lease method
Jul 18, 2018
4828420
versionadded notes and link to requests module
Jul 19, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
add breaking changes section
  • Loading branch information
Jeffrey Hogan committed Jul 16, 2018
commit 2e36e8addcd62555afb46bf384ac478ac182529a
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,10 @@ the latest `vault` binary is available in your `PATH`.
### Examples

Example code or general guides for methods in this module can be added under [docs/examples](docs/examples).

## Backwards Compatibility Breaking Changes

Due to the close connection between this module and HashiCorp Vault versions, breaking changes are sometimes required. This can also occur as part of code refactoring to enable improvements in the module generally. In these cases:

* A deprecation notice should be displayed to callers of the module until the minor revision +2. E.g., a notice added in version 0.6.2 could see the marked method / functionality removed in version 0.8.0.
* Breaking changes should be called out in the [CHANGELOG.md](CHANGELOG.md) for the affected version.