Skip to content
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 display attributes for OpenAPI OperationID's #104

Merged
merged 3 commits into from
Apr 20, 2023
Merged

Conversation

averche
Copy link
Contributor

@averche averche commented Apr 12, 2023

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
"/{kv-v1_mount_path}/{path}" "get" "kv-v1-read"
"/{kv-v1_mount_path}/{path}" "post" "kv-v1-write"
"/{kv-v1_mount_path}/{path}" "delete" "kv-v1-delete"
"/{kv-v2_mount_path}/config" "get" "kv-v2-read-configuration"
"/{kv-v2_mount_path}/config" "post" "kv-v2-configure"
"/{kv-v2_mount_path}/data/{path}" "get" "kv-v2-read"
"/{kv-v2_mount_path}/data/{path}" "post" "kv-v2-write"
"/{kv-v2_mount_path}/data/{path}" "delete" "kv-v2-delete"
"/{kv-v2_mount_path}/delete/{path}" "post" "kv-v2-delete-versions"
"/{kv-v2_mount_path}/destroy/{path}" "post" "kv-v2-destroy-versions"
"/{kv-v2_mount_path}/metadata/{path}" "get" "kv-v2-read-metadata"
"/{kv-v2_mount_path}/metadata/{path}" "post" "kv-v2-write-metadata"
"/{kv-v2_mount_path}/metadata/{path}" "delete" "kv-v2-delete-metadata"
"/{kv-v2_mount_path}/subkeys/{path}" "get" "kv-v2-read-subkeys"
"/{kv-v2_mount_path}/undelete/{path}" "post" "kv-v2-undelete-versions"

Related Issues/Pull Requests

@averche averche requested review from a team April 12, 2023 21:08
@averche averche merged commit 536ccba into main Apr 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants