Skip to content
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.

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

Update wrapping.rst - example for unauthenticated unwrap #789

Merged
merged 4 commits into from
Jan 29, 2023

Conversation

nneul
Copy link
Contributor

@nneul nneul commented Jan 10, 2022

Provide example of using unwrap with just the wrapping token. Previous example is non-functional unless already authenticated.

@nneul nneul requested a review from a team as a code owner January 10, 2022 00:25
@nneul nneul changed the title Update wrapping.rst Update wrapping.rst - example for unauthenticated unwrap Jan 11, 2022
@nneul
Copy link
Contributor Author

nneul commented Sep 17, 2022

ping or close it please so it's not hanging around

@mbieren
Copy link

mbieren commented Nov 30, 2022

@nneul
Copy link
Contributor Author

nneul commented Dec 6, 2022

HVAC maintainers - please consider actually merging this.

Copy link
Member

@colin-pm colin-pm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One small nit, but overall the doc change looks good to me. Sorry for the delay.

docs/usage/system_backend/wrapping.rst Outdated Show resolved Hide resolved
@nneul nneul force-pushed the additional-unwrap-example branch from 30495dc to 83d2a29 Compare December 14, 2022 19:28
@briantist briantist self-assigned this Jan 16, 2023
@briantist briantist added the documentation documentation updates and/or requests for expanded documentation label Jan 16, 2023
Provide example of using unwrap with just the wrapping token. Previous example is non-functional unless already authenticated.
@briantist briantist force-pushed the additional-unwrap-example branch from 83d2a29 to 026eb38 Compare January 27, 2023 23:44
@codecov
Copy link

codecov bot commented Jan 27, 2023

Codecov Report

Merging #789 (ee26b3a) into develop (026d6b5) will increase coverage by 2.17%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           develop     #789      +/-   ##
===========================================
+ Coverage    81.34%   83.51%   +2.17%     
===========================================
  Files           65       65              
  Lines         2969     3003      +34     
===========================================
+ Hits          2415     2508      +93     
+ Misses         554      495      -59     
Impacted Files Coverage Δ
hvac/api/auth_methods/mfa.py 100.00% <0.00%> (ø)
hvac/api/secrets_engines/kv.py 100.00% <0.00%> (ø)
hvac/api/secrets_engines/identity.py 94.00% <0.00%> (+0.02%) ⬆️
hvac/utils.py 77.27% <0.00%> (+0.20%) ⬆️
hvac/adapters.py 86.73% <0.00%> (+0.27%) ⬆️
hvac/api/vault_api_category.py 95.12% <0.00%> (+0.67%) ⬆️
hvac/v1/__init__.py 85.71% <0.00%> (+1.89%) ⬆️
hvac/api/system_backend/namespace.py 83.33% <0.00%> (+33.33%) ⬆️
hvac/api/secrets_engines/transform.py 72.65% <0.00%> (+42.96%) ⬆️

@briantist briantist added this to the 1.1.0 milestone Jan 28, 2023
@briantist
Copy link
Contributor

Hi @nneul ! I'd also like to apologize for the delays. I've updated your PR today to rebase it, and fix up the example so that it passes (we run live tests on examples and it needed some updates).

Calling attention to this doc also made me realize it was totally not showing the correct unwrap method documentation at all, and also included something from the Seal backend, so I've cleaned that up as well.

Thanks very much for the contribution!

@briantist briantist dismissed colin-pm’s stale review January 28, 2023 00:34

Proposed changes were accepted

@briantist briantist merged commit ee0a9e6 into hvac:develop Jan 29, 2023
briantist added a commit that referenced this pull request Mar 6, 2023
* Update wrapping.rst

Provide example of using unwrap with just the wrapping token. Previous example is non-functional unless already authenticated.

* update example

* correct automethod name

* doctest fixes

---------

Co-authored-by: Brian Scholer <1260690+briantist@users.noreply.github.com>
briantist added a commit to briantist/hvac that referenced this pull request May 10, 2023
* Update wrapping.rst

Provide example of using unwrap with just the wrapping token. Previous example is non-functional unless already authenticated.

* update example

* correct automethod name

* doctest fixes

---------

Co-authored-by: Brian Scholer <1260690+briantist@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation documentation updates and/or requests for expanded documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants