Skip to content

Backport of docs: Add complete auth method payloads into release/1.16.x#18912

Merged
hc-github-team-consul-core merged 1 commit intorelease/1.16.xfrom
backport/docs/complete-auth-method-example-payloads/literally-native-tarpon
Sep 21, 2023
Merged

Backport of docs: Add complete auth method payloads into release/1.16.x#18912
hc-github-team-consul-core merged 1 commit intorelease/1.16.xfrom
backport/docs/complete-auth-method-example-payloads/literally-native-tarpon

Conversation

@hc-github-team-consul-core
Copy link
Collaborator

Backport

This PR is auto-generated from #18849 to be assessed for backporting due to the inclusion of the label backport/1.16.

The below text is copied from the body of the original PR.


Description

This commit modifies the example payloads for various auth methods to remove 'other fields' and instead use complete example payloads.

This helps readers clearly understand how the payloads should be constructed for the /v1/acl/auth-method API endpoint.

PR Checklist

  • updated test coverage
  • external facing docs updated
  • appropriate backport labels added
  • not a security concern

Overview of commits

@hc-github-team-consul-core hc-github-team-consul-core requested a review from a team as a code owner September 19, 2023 23:35
@hc-github-team-consul-core hc-github-team-consul-core force-pushed the backport/docs/complete-auth-method-example-payloads/literally-native-tarpon branch 2 times, most recently from 01fab38 to 26c5342 Compare September 19, 2023 23:35
Copy link
Collaborator

Choose a reason for hiding this comment

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

Auto approved Consul Bot automated PR

@github-actions github-actions bot added the type/docs Documentation needs to be created/updated/clarified label Sep 19, 2023
@blake blake force-pushed the backport/docs/complete-auth-method-example-payloads/literally-native-tarpon branch from 26c5342 to 496c279 Compare September 20, 2023 18:30
@blake blake force-pushed the backport/docs/complete-auth-method-example-payloads/literally-native-tarpon branch from 496c279 to 596d78c Compare September 20, 2023 23:05
@blake blake force-pushed the backport/docs/complete-auth-method-example-payloads/literally-native-tarpon branch from 596d78c to d8ddbfe Compare September 20, 2023 23:28
@blake blake added the pr/no-changelog PR does not need a corresponding .changelog entry label Sep 21, 2023
@blake blake force-pushed the backport/docs/complete-auth-method-example-payloads/literally-native-tarpon branch from d8ddbfe to 3d27959 Compare September 21, 2023 00:07
@hc-github-team-consul-core hc-github-team-consul-core merged commit d7edc01 into release/1.16.x Sep 21, 2023
@hc-github-team-consul-core hc-github-team-consul-core deleted the backport/docs/complete-auth-method-example-payloads/literally-native-tarpon branch September 21, 2023 00:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr/no-changelog PR does not need a corresponding .changelog entry type/docs Documentation needs to be created/updated/clarified

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants