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 #29

Merged
merged 2 commits into from
Apr 25, 2023
Merged

Conversation

averche
Copy link
Contributor

@averche averche commented Apr 25, 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
"/{terraform_mount_path}/config" "get" "terraform-cloud-read-configuration"
"/{terraform_mount_path}/config" "post" "terraform-cloud-configure"
"/{terraform_mount_path}/config" "delete" "terraform-cloud-delete-configuration"
"/{terraform_mount_path}/creds/{name}" "get" "terraform-cloud-generate-credentials"
"/{terraform_mount_path}/creds/{name}" "post" "terraform-cloud-generate-credentials2"
"/{terraform_mount_path}/role" "get" "terraform-cloud-list-roles"
"/{terraform_mount_path}/role/{name}" "get" "terraform-cloud-read-role"
"/{terraform_mount_path}/role/{name}" "post" "terraform-cloud-write-role"
"/{terraform_mount_path}/role/{name}" "delete" "terraform-cloud-delete-role"
"/{terraform_mount_path}/rotate-role/{name}" "post" "terraform-cloud-rotate-role"

Related Issues/Pull Requests

@averche averche requested review from a team April 25, 2023 19:24
@averche averche merged commit 0307504 into main Apr 25, 2023
@averche averche deleted the display-attributes branch April 25, 2023 20:20
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