search

hashicorp / vault-plugin-secrets-azure

Vault Azure Secrets plugin
Mozilla Public License 2.0
26 stars 19 forks source link

Add display attributes for OpenAPI OperationID's #141

Closed averche closed 1 year ago

averche commented 1 year ago

Overview

The display attributes added in this PR will be translated into OperationID's in vault-generated OpenAPI documents (when calling /sys/internal/specs/openapi with this plugin enabled). The OperationID's will, in turn, be translated into function / method names in generated OpenAPI-based libraries (e.g. hashicorp/vault-client-go & hashicorp/vault-client-dotnet).

This PR will introduce the following OperationIDs:

Path Method OperationID
"/{azure_mount_path}/config" "get" "azure-read-configuration"
"/{azure_mount_path}/config" "post" "azure-configure"
"/{azure_mount_path}/config" "delete" "azure-delete-configuration"
"/{azure_mount_path}/creds/{role}" "get" "azure-request-service-principal-credentials"
"/{azure_mount_path}/roles" "get" "azure-list-roles"
"/{azure_mount_path}/roles/{name}" "get" "azure-read-role"
"/{azure_mount_path}/roles/{name}" "post" "azure-write-role"
"/{azure_mount_path}/roles/{name}" "delete" "azure-delete-role"
"/{azure_mount_path}/rotate-root" "post" "azure-rotate-root"

Related Issues/Pull Requests

fairclothjm commented 1 year ago
Path Method OperationID
"/{azure_mount_path}/config" "post" "azure-configure"

Any reason why we don't use azure-write-configuration to be more in line with the others?

averche commented 1 year ago

Any reason why we don't use azure-write-configuration to be more in line with the others?

Mostly trying to be consistent with the descriptions in the documentation and make it more human-readable in the generated code (particularly in cases where it's configure-x (e.g. nomad-configure-access).