-
Notifications
You must be signed in to change notification settings - Fork 4.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add additional endpoints, remove non-protected endpoints #20669
Add additional endpoints, remove non-protected endpoints #20669
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
Checked with engineering on open questions:
|
I created a separate ticket to address auth/token/create. I have left it in the table currently as there are cases, according to the existing docs, that it could require sudo. New ticket shares your suggestions on additional clarity but need more time to research and collaborate with engineering. |
| [sys/raw:path](/vault/api-docs/system/raw) | GET, POST, DELETE | Used to access the raw underlying store in Vault | | ||
| [sys/raw:prefix](/vault/api-docs/system/raw#list-raw) | GET, LIST | Returns a list keys for a given path prefix | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This new representation of sys/raw
does not communicate well to users.
There is a single API, which can be best described as sys/raw/:path
, accepting GET, LIST, POST, DELETE:
| [sys/raw:path](/vault/api-docs/system/raw) | GET, POST, DELETE | Used to access the raw underlying store in Vault | | |
| [sys/raw:prefix](/vault/api-docs/system/raw#list-raw) | GET, LIST | Returns a list keys for a given path prefix | | |
| [sys/raw/:path](/vault/api-docs/system/raw) | GET, LIST, POST, DELETE | Used to access the raw underlying store in Vault | |
It doesn't make sense to single out LIST to a separate row, use different path-parameter placeholders for the two rows, duplicate GET over both of them, or omit the slash character before the colons.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for checking in. I matched the table to our docs which list /sys/raw/:prefix
and sys/raw:path
on https://developer.hashicorp.com/vault/api-docs/system/raw
* Add additional endpoints, remove non-protected endpoints * Add step-down per engineering * Match HTTP verb to individual doc pages * Add /sys/internal/inspect/router to table * Apply additional suggestions * Updates based on engineering feedback * Adding unsaved changes
β¦0765) * Add additional endpoints, remove non-protected endpoints * Add step-down per engineering * Match HTTP verb to individual doc pages * Add /sys/internal/inspect/router to table * Apply additional suggestions * Updates based on engineering feedback * Adding unsaved changes Co-authored-by: Jonathan Frappier <92055993+jonathanfrappier@users.noreply.github.com>
Oops, my bad there - you're right, it doesn't, I misread the match patterns and data from the OpenAPI spec. In order to track the remaining open issues, I've opened #20780 |
ποΈ Jira ticket
π Deploy preview
Description
sys/auth/:path/tune | GET, POST, DELETE | Manage the auth methods (enable, read, delete, and tune)
sys/raw
which was pointed out as an example of being incorrect, but according to our documentation is correct in the table.Update: