hashicorp / vault-plugin-secrets-mongodbatlas

Mozilla Public License 2.0
5 stars 3 forks source link

Add display attributes for OpenAPI OperationID's #45

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
"/{mongodbatlas_mount_path}/config" "get" "mongo-db-atlas-read-configuration"
"/{mongodbatlas_mount_path}/config" "post" "mongo-db-atlas-configure"
"/{mongodbatlas_mount_path}/creds/{name}" "get" "mongo-db-atlas-generate-credentials"
"/{mongodbatlas_mount_path}/creds/{name}" "post" "mongo-db-atlas-generate-credentials2"
"/{mongodbatlas_mount_path}/roles" "get" "mongo-db-atlas-list-roles"
"/{mongodbatlas_mount_path}/roles/{name}" "get" "mongo-db-atlas-read-role"
"/{mongodbatlas_mount_path}/roles/{name}" "post" "mongo-db-atlas-write-role"
"/{mongodbatlas_mount_path}/roles/{name}" "delete" "mongo-db-atlas-delete-role"

Related Issues/Pull Requests