search

hashicorp / vault-plugin-secrets-openldap

OpenLDAP secret engine for Vault
Mozilla Public License 2.0
17 stars 7 forks source link

Add display attributes for OpenAPI OperationID's #62

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
"/{ldap_mount_path}/config" "get" "ldap-read-configuration"
"/{ldap_mount_path}/config" "post" "ldap-configure"
"/{ldap_mount_path}/config" "delete" "ldap-delete-configuration"
"/{ldap_mount_path}/creds/{name}" "get" "ldap-request-dynamic-role-credentials"
"/{ldap_mount_path}/library" "get" "ldap-library-list"
"/{ldap_mount_path}/library/manage/{name}/check-in" "post" "ldap-library-force-check-in"
"/{ldap_mount_path}/library/{name}" "get" "ldap-library-read"
"/{ldap_mount_path}/library/{name}" "post" "ldap-library-configure"
"/{ldap_mount_path}/library/{name}" "delete" "ldap-library-delete"
"/{ldap_mount_path}/library/{name}/check-in" "post" "ldap-library-check-in"
"/{ldap_mount_path}/library/{name}/check-out" "post" "ldap-library-check-out"
"/{ldap_mount_path}/library/{name}/status" "get" "ldap-library-check-status"
"/{ldap_mount_path}/role" "get" "ldap-list-dynamic-roles"
"/{ldap_mount_path}/role/{name}" "get" "ldap-read-dynamic-role"
"/{ldap_mount_path}/role/{name}" "post" "ldap-write-dynamic-role"
"/{ldap_mount_path}/role/{name}" "delete" "ldap-delete-dynamic-role"
"/{ldap_mount_path}/rotate-role/{name}" "post" "ldap-rotate-static-role"
"/{ldap_mount_path}/rotate-root" "post" "ldap-rotate-root-credentials"
"/{ldap_mount_path}/static-cred/{name}" "get" "ldap-request-static-role-credentials"
"/{ldap_mount_path}/static-role" "get" "ldap-list-static-roles"
"/{ldap_mount_path}/static-role/{name}" "get" "ldap-read-static-role"
"/{ldap_mount_path}/static-role/{name}" "post" "ldap-write-static-role"
"/{ldap_mount_path}/static-role/{name}" "delete" "ldap-delete-static-role"

Related Issues/Pull Requests