Skip to content

Conversation

kevin-loehfelm
Copy link
Contributor

Description

This PR makes two changes to Azure Secrets Engine HTTP API documentation

  • Add documentation for 'Read role'. This has been available but was missing in documentation.
  • Update default values and descriptions for 'max_ttl' and 'explicit_max_ttl' in 'Create/update role'. When these values are not explicitly set, they default to 0. The update clarifies that there is a default value and the expected behavior.

TODO only if you're a HashiCorp employee

  • Backport Labels: If this fix needs to be backported, use the appropriate backport/ label that matches the desired release branch. Note that in the CE repo, the latest release branch will look like backport/x.x.x, but older release branches will be backport/ent/x.x.x+ent.
    • LTS: If this fixes a critical security vulnerability or severity 1 bug, it will also need to be backported to the current LTS versions of Vault. To ensure this, use all available enterprise labels.
  • ENT Breakage: If this PR either 1) removes a public function OR 2) changes the signature
    of a public function, even if that change is in a CE file, double check that
    applying the patch for this PR to the ENT repo and running tests doesn't
    break any tests. Sometimes ENT only tests rely on public functions in CE
    files.
  • Jira: If this change has an associated Jira, it's referenced either
    in the PR description, commit message, or branch name.
  • RFC: If this change has an associated RFC, please link it in the description.
  • ENT PR: If this change has an associated ENT PR, please link it in the
    description. Also, make sure the changelog is in this PR, not in your ENT PR.

PCI review checklist

  • I have documented a clear reason for, and description of, the change I am making.
  • If applicable, I've documented a plan to revert these changes if they require more than reverting the pull request.
  • If applicable, I've documented the impact of any changes to security controls.

Examples of changes to security controls include using new access control methods, adding or removing logging pipelines, etc.

Copy link

vercel bot commented Aug 25, 2025

@kevin-loehfelm is attempting to deploy a commit to the HashiCorp Team on Vercel.

A member of the Team first needs to authorize it.

@kevin-loehfelm kevin-loehfelm requested a deployment to community-pull-request August 25, 2025 19:43 — with GitHub Actions Waiting
@heatherezell heatherezell added agent hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed and removed agent labels Aug 26, 2025
Copy link
Contributor

@schavis schavis left a comment

Choose a reason for hiding this comment

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

I added suggestions to make things easy, but you'll need to recreate your PR with the changes under the hashicorp/web-unified-docs repo to actually publish your updates. We no longer manage the product docs out of the Vault repo

kevin-loehfelm and others added 5 commits August 27, 2025 08:59
update to active voice for max_ttl

Co-authored-by: Sarah Chavis <[email protected]>
update to active voice for explict_max_ttl

Co-authored-by: Sarah Chavis <[email protected]>
update to active voice for read role description

Co-authored-by: Sarah Chavis <[email protected]>
consolidated intro

Co-authored-by: Sarah Chavis <[email protected]>
Update title heading for path parameters

Co-authored-by: Sarah Chavis <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants