Incorrect documentation around ACL token deletion.
- Dominant language
- Go
- Stars
- 30.1k
- Forks
- 4.6k
- Avg merge
- 1d 18h
- Merged PRs (30d)
- 39
Description
The ACL docs say (https://developer.hashicorp.com/consul/api-docs/v1.13.x/acl/tokens#delete-a-token):
> Even though the return type is application/json, the value is either true or false, indicating whether the delete succeeded.
Yet the code (if I found the correct one) nowhere returns false:
https://github.com/hashicorp/consul/blob/748458a07bee3375ad7764780aa07b6105423c1b/agent/acl_endpoint.go#L472-L490
Should the docs be updated to say that they return a 404 and only `true` in case of a successful deletion?
Contributor guide
Research direction
Start by comparing the ACL token deletion documentation with agent/acl_endpoint.go around lines 472-490, then verify the documented response behavior against the API implementation. Update the ACL token documentation so its success and failure responses match the verified behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100