luxolus/open-vault
2
0
Fork 0
Code Issues 1 Pull requests Releases Activity

openapi: Better comments for OperationPrefix/Verb/Suffix (#20162)

Browse source
This commit is contained in:
Anton Averchenkov 2023-04-13 18:47:14 -04:00 committed by GitHub
parent c36ab935c4
commit 624acfe62a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
sdk/framework/path.go
View file

@ -228,21 +228,25 @@ type DisplayAttributes struct {
Action string `json:"action,omitempty"` Action string `json:"action,omitempty"`
// OperationPrefix is a hyphenated lower-case string used to construct // OperationPrefix is a hyphenated lower-case string used to construct
// OpenAPI OperationID. It is typically the name of the plugin. // OpenAPI OperationID (prefix + verb + suffix). OperationPrefix is
// typically a human-readable name of the plugin or a prefix shared by
// multiple related endpoints.
OperationPrefix string `json:"operationPrefix,omitempty"` OperationPrefix string `json:"operationPrefix,omitempty"`
// OperationPrefix is a hyphenated lower-case string used to construct // OperationVerb is a hyphenated lower-case string used to construct
// OpenAPI OperationID. It is typically an action to be performed // OpenAPI OperationID (prefix + verb + suffix). OperationVerb is typically
// (e.g. "generate", "sign", "login", etc.). If not specified, the verb // an action to be performed (e.g. "generate", "sign", "login", etc.). If
// defaults to `logical.Operation.String()` (e.g. "read", "delete", etc.). // not specified, the verb defaults to `logical.Operation.String()`
// (e.g. "read", "list", "delete", "write" for Create/Update)
OperationVerb string `json:"operationVerb,omitempty"` OperationVerb string `json:"operationVerb,omitempty"`
// OperationPrefix is a hyphenated lower-case string used to construct // OperationSuffix is a hyphenated lower-case string used to construct
// OpenAPI OperationID. It is typically the name of the resource on which // OpenAPI OperationID (prefix + verb + suffix). It is typically the name
// the action is performed (e.g. "role", "credentials", etc.). A pipe (|) // of the resource on which the action is performed (e.g. "role",
// separator can be used to list different suffixes for various permutations // "credentials", etc.). A pipe (|) separator can be used to list different
// of the `Path.Pattern` regular expression. If not specified, the suffix // suffixes for various permutations of the `Path.Pattern` regular
// defaults to the `Path.Pattern` split by dashes. // expression. If not specified, the suffix defaults to the `Path.Pattern`
// split by dashes.
OperationSuffix string `json:"operationSuffix,omitempty"` OperationSuffix string `json:"operationSuffix,omitempty"`
// EditType is the optional type of form field needed for a property // EditType is the optional type of form field needed for a property