mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-18 04:27:02 +02:00
43ae739971
* Refactor `identity/mfa/method/*` endpoints to fix bad OpenAPI There is a problem with how the `identity/mfa/method/*` endpoints are defined, resulting in incorrect OpenAPI generation. I raised hashicorp/vault-client-go#180 to track a consequence, and opened #20873 which explains the problem and adds a log message to detect it. This PR is now the fix. It's actually quite an interesting problem, that has come about through some particular implementation choices, in Vault's first/only case where REST API objects are created by writing to the collection URL, and have their ID allocated by the server, instead of the client. The triggering cause of the malfunction was trying to have a single framework.Path struct instance which optionally includes or excludes the method_id path parameter, and also another framework.Path struct instance handling list operations. The fix is to simplify the path regexes, and have one framework.Path which handles the method_id being present, and one that handles it being absent. The diff is somewhat large, because the affected code had been copy/pasted four times (TOTP, Okta, Duo, PingID) - so I took the opportunity to fix the duplication, creating appropriate helper methods so that the quadruplicated code could be re-unified. * Revise documentation This update refactors how the documentation presents these endpoints to users, both for clarity, and to align with the new structure of the code. From a user perspective, it clears up some unclear presentation of when the `method_id` parameter should and should not be present, adds a missing description of the response to create requests, and changes the `method_id` parameter name to be used consistently (rather than `id` in some cases, unlike the actual code/OpenAPI). * Fix incorrect acronym (review fix) * Accept suggestion of tweaked grammar in documentation Co-authored-by: Anton Averchenkov <84287187+averche@users.noreply.github.com> * Add changelog --------- Co-authored-by: Anton Averchenkov <84287187+averche@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| databases | ||
| identity | ||
| key-management | ||
| kv | ||
| ad.mdx | ||
| alicloud.mdx | ||
| aws.mdx | ||
| azure.mdx | ||
| cassandra.mdx | ||
| consul.mdx | ||
| cubbyhole.mdx | ||
| gcp.mdx | ||
| gcpkms.mdx | ||
| index.mdx | ||
| kmip.mdx | ||
| kubernetes.mdx | ||
| ldap.mdx | ||
| mongodbatlas.mdx | ||
| nomad.mdx | ||
| pki.mdx | ||
| rabbitmq.mdx | ||
| ssh.mdx | ||
| terraform.mdx | ||
| totp.mdx | ||
| transform.mdx | ||
| transit.mdx | ||