Skip to content

feat(client): Add ContentType() to ClientWithResponses responses #2173

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.

Sign up for GitHub

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

Open
CJourneaux wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(client): Add ContentType() to ClientWithResponses responses #2173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions configuration-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,10 @@
"type": "boolean",
"description": "Enable the generation of a `Bytes()` method on response objects for `ClientWithResponses`"
},
"client-response-content-type-function": {
"type": "boolean",
"description": "Enable the generation of a `ContentType()` method on response objects for `ClientWithResponses`"
},
"prefer-skip-optional-pointer": {
"type": "boolean",
"description": "Allows defining at a global level whether to omit the pointer for a type to indicate that the field/type is optional. This is the same as adding `x-go-type-skip-optional-pointer` to each field (manually, or using an OpenAPI Overlay). A field can set `x-go-type-skip-optional-pointer: false` to still require the optional pointer.",
Expand Down
0 internal/test/issues/issue240/api.yaml → internal/test/issues/issue-240-2149/api.yaml
View file
Open in desktop
File renamed without changes.
3 changes: 2 additions & 1 deletion internal/test/issues/issue240/cfg.yaml → internal/test/issues/issue-240-2149/cfg.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# yaml-language-server: $schema=../../../../configuration-schema.json
package: issue240
package: clientresponsefunctions
output: client.gen.go
generate:
models: true
client: true
output-options:
client-response-bytes-function: true
client-response-content-type-function: true
20 changes: 18 additions & 2 deletions internal/test/issues/issue240/client.gen.go → .../test/issues/issue-240-2149/client.gen.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion internal/test/issues/issue240/generate.go → ...al/test/issues/issue-240-2149/generate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
package issue240
package clientresponsefunctions

//go:generate go run github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen -config cfg.yaml api.yaml
3 changes: 3 additions & 0 deletions pkg/codegen/configuration.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,9 @@ type OutputOptions struct {
// ClientResponseBytesFunction decides whether to enable the generation of a `Bytes()` method on response objects for `ClientWithResponses`
ClientResponseBytesFunction bool `yaml:"client-response-bytes-function,omitempty"`

// ClientResponseContentTypeFunction decides whether to enable the generation of a `ContentType()` method on response objects for `ClientWithResponses`
ClientResponseContentTypeFunction bool `yaml:"client-response-content-type-function,omitempty"`

// PreferSkipOptionalPointer allows defining at a global level whether to omit the pointer for a type to indicate that the field/type is optional.
// This is the same as adding `x-go-type-skip-optional-pointer` to each field (manually, or using an OpenAPI Overlay)
PreferSkipOptionalPointer bool `yaml:"prefer-skip-optional-pointer,omitempty"`
Expand Down
11 changes: 11 additions & 0 deletions pkg/codegen/templates/client-with-responses.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,17 @@ func (r {{genResponseTypeName $opid | ucFirst}}) Bytes() []byte {
return r.Body
}
{{end}}

{{ if opts.OutputOptions.ClientResponseContentTypeFunction }}
// ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (r {{genResponseTypeName $opid | ucFirst}}) ContentType() string {
if r.HTTPResponse != nil {
return r.HTTPResponse.Header.Get("Content-Type")
}
return ""
}
{{end}}

{{end}}


Expand Down