Add a distinguishing prefix to OpenAPI operation IDs for enterprise stubs #22072
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
averche
reviewed
Jul 26, 2023
vault/logical_system_helpers.go
Outdated
| // OpenAPI won't be good for much other than identifying the endpoint exists at all. Thus, it | ||
| // is useful to make it clear that this is only a stub. Code generation will use this to ignore | ||
| // these operations. | ||
| OperationPrefix: "enterprise-stub-system", |
There was a problem hiding this comment.
One quick thought. Would it make sense to call this "enterprise-stub" instead? For other prefixes under /sys, we've been dropping the "system" part. It's not a big deal regardless since it will be filtered out, just a thought.
There was a problem hiding this comment.
The system- prefix had not been dropped for any of these, so I was just prepending enterprise-stub- to what was already there. But, sure, might as well bring these into line with the surrounding convention as well.
In that case, I'll also fix sys/replication/status which is not a stub, but hasn't had the system part dropped yet.
averche
approved these changes
Jul 27, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As discussed in hashicorp/vault-client-go#208