hashicorp / hashicorp/consul

Clarify whether "token" parameter should be the accessor or secret ID

Open
#12,664 0 comments 1 reaction 0 assignees View on GitHub
type/docs
Dominant language
Go
Stars
30.1k
Forks
4.6k
Avg merge
1d 18h
Merged PRs (30d)
39

Description

Per https://github.com/hashicorp/consul/issues/4478#issuecomment-586741457, some areas of the documentation mention specifying an ACL token, but don't specify whether `AccessorID` or `SecretID` is needed.

We should be consistently explicit about whether `AccessorID` or `SecretID` is needed, including in:
- CLI docs
- HTTP API docs
- CLI command help within the `consul` binary

Contributor guide

Open the contributing guide

Research direction

Review the CLI docs, HTTP API docs, and command help within the consul binary, focusing on references to ACL tokens. Make each reference explicit about whether AccessorID or SecretID is required, and confirm that the three listed areas use consistent terminology.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
api, cli, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.