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

Use an operation's request type name if specified #598

Merged
merged 2 commits into from
Sep 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 18 additions & 11 deletions openapi/code/service.go
Original file line number Diff line number Diff line change
Expand Up @@ -255,19 +255,26 @@ func (svc *Service) nameAndDefineRequest(request *Entity, op *openapi.Operation)
if request.Name != "" {
panic(fmt.Sprintf("request entity already has a name: %s", request.Name))
}
// when there was a merge of params with a request or new entity was made
signularServiceName := svc.Singular().PascalName()
notExplicit := !strings.Contains(op.Name(), signularServiceName)
if op.Name() == "list" && notExplicit {
request.Name = op.Name() + svc.Name + "Request"
} else if crudNames[strings.ToLower(op.Name())] {
request.Name = op.Name() + signularServiceName + "Request"

// If the operation defines a request type name, use it.
if op.RequestTypeName != "" {
request.Name = op.RequestTypeName
} else {
request.Name = op.Name() + "Request"
}
if svc.Package.Name == "scim" {
request.Name = strings.ReplaceAll(request.Name, "Account", "")
// Otherwise, synthesize a request type name.
singularServiceName := svc.Singular().PascalName()
notExplicit := !strings.Contains(op.Name(), singularServiceName)
if op.Name() == "list" && notExplicit {
request.Name = op.Name() + svc.Name + "Request"
} else if crudNames[strings.ToLower(op.Name())] {
request.Name = op.Name() + singularServiceName + "Request"
} else {
request.Name = op.Name() + "Request"
}
if svc.Package.Name == "scim" {
request.Name = strings.ReplaceAll(request.Name, "Account", "")
}
}

request.Description = op.Summary
svc.Package.define(request)
}
Expand Down
6 changes: 6 additions & 0 deletions openapi/model.go
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,12 @@ type Operation struct {
// an action and the request body represents the resource.
PathStyle PathStyle `json:"x-databricks-path-style,omitempty"`

// The x-databricks-request-type-name field defines the name to use for
// the request type in the generated client. This may be specified only
// if the operation does NOT have a request body, thus only uses a request
// type to encapsulate path and query parameters.
RequestTypeName string `json:"x-databricks-request-type-name,omitempty"`

// For list APIs, the path to the field in the response entity that contains
// the resource ID.
IdField fieldPath `json:"x-databricks-id,omitempty"`
Expand Down