Docs: Updating HTTP API endpoints with CLI equivalent links #12004
Conversation
ChipV223
added
type/docs
ChipV223
changed the title
jkirschner-hashicorp
added
the
pr/no-changelog
There was a problem hiding this comment.
@ChipV223 : looks good! I'm excited to have these additions in the docs.
I spotted some minor corrections that (unfortunately) affect every line, but hopefully won't take too long to fix. I also have an open question for @karl-cardenas-coding / @trujillo-adam. Let's wait for them to respond before making any changes so that you just need to make one more pass through everything.
One other thing I noticed: none of the admin partition commands are included in this change. These don't exist in my spreadsheet because I created the spreadsheet before admin partitions were released. Should we include those in this PR? Or will that need to be done separately? I posted a similar question to @msiege2 on #11984.
| @@ -34,7 +34,9 @@ The table below shows this endpoint's support for | |||
| | ---------------- | ----------------- | ------------- | ------------ | | |||
| | `NO` | `none` | `none` | `acl:write` | | |||
|
|
|||
| ### Payload Fields | |||
There was a problem hiding this comment.
Thanks for noticing and correcting this inconsistency :)
| @@ -156,6 +160,8 @@ The table below shows this endpoint's support for | |||
| | ---------------- | ----------------- | ------------- | ------------ | | |||
| | `YES` | `all` | `none` | `acl:read` | | |||
|
|
|||
| -> The corresponding CLI command is [`consul acl policy read -name=<string>`](https://www.consul.io/commands/acl/policy/read#name) | |||
There was a problem hiding this comment.
Nice - I like the use of the flag here!
|
@jkirschner-hashicorp : The latest commit contains the links fixes as well as the addition of "." at the end of the sentence |
| @@ -34,7 +34,9 @@ The table below shows this endpoint's support for | |||
| | ---------------- | ----------------- | ------------- | ------------ | | |||
| | `NO` | `none` | `none` | `acl:write` | | |||
|
|
|||
| ### Payload Fields | |||
| -> The corresponding CLI command is [`consul acl auth-method create`](/commands/acl/auth-method/create). | |||
There was a problem hiding this comment.
After discussing with @karl-cardenas-coding and @trujillo-adam , we agree that we need to remove the info box treatment for these sentences (that gives them the blue background). Can you go through all these and remove the -> at the front?
| -> The corresponding CLI command is [`consul acl auth-method create`](/commands/acl/auth-method/create). | |
| The corresponding CLI command is [`consul acl auth-method create`](/commands/acl/auth-method/create). |
There was a problem hiding this comment.
I addressed my own feedback
jkirschner-hashicorp
changed the title
|
🍒 If backport labels were added before merging, cherry-picking will start automatically. To retroactively trigger a backport after merging, add backport labels and re-run https://circleci.com/gh/hashicorp/consul/555551. |
|
🍒✅ Cherry pick of commit 8a22562 onto |
Docs: Updating HTTP API endpoints with CLI equivalent links
|
🍒✅ Cherry pick of commit 8a22562 onto |
Docs: Updating HTTP API endpoints with CLI equivalent links
As the title suggests, this docs changes is to include a link to the CLI command from the equivalent HTTP API page