Generate anonymous objects referenced in schemas by jamietanna · Pull Request #648 · oapi-codegen/oapi-codegen

jamietanna · 2022-06-30T08:19:22Z

Closes #626, #636.

examples/authenticated-api/echo/api/api.gen.go

internal/test/components/components.gen.go

pkg/codegen/schema.go

veger · 2022-07-13T15:37:47Z

I am very interested to try it, when it is finished, as I think it is solving a similar issue I am experiencing... 👍

riftsin · 2022-11-17T07:41:08Z

Hi guys, I was wondering if there was any update on that issue ?

jamietanna · 2022-11-23T16:32:14Z

@deepmap-marcinr I think I may need a hand with the PascalSchema error, currently trying to work out the intent of those tests to work out what handling needs to be added

pkg/codegen/codegen.go

jamietanna · 2022-11-25T17:56:18Z

I've got this working finally 👏

If you're happy with it, @deepmap-marcinr, I'll sort out the Git history then merge it.

I'll test it out with a few other specs that have been mentioned to be affected, too

jamietanna · 2022-11-27T13:19:48Z

Got a couple of tweaks to make:

anonymous requestBodies
~~anonymous parameters~~
handle when there's i.e. content: {}

rew! handle absent content/mediaType

As part of future changes we need to be able to reference all the types in the defined `responses` of a specification. However, as we're currently only rendering `application/json` media types, this fails. Instead, we can generate `json.RawMessage` (which is an alias of `[]byte`) for these types, which allow referencing them, and (un)marshaling data to the types.

As part of future changes we need to be able to reference all the types in the defined `requestBodies` of a specification. However, as we're currently only rendering `application/json` media types, this fails. Instead, we can generate `json.RawMessage` (which is an alias of `[]byte`) for these types, which allow referencing them, and (un)marshaling data to the types.

Previously, there was no way to render any anonymous types that are referenced in the `paths` of an OpenAPI specification. Although there is a strong preference in the community to use the `/components/schemas/`, there are times that it's out of our control to move objects around. This generates both the `requestBody` and `responses`. TODO Closes 626 TODO

deepmap-marcinr · 2022-11-29T01:06:40Z

pkg/codegen/codegen.go

+					} else {
+						typeName += ToCamelCase(strings.ToLower(operationName)) + ToCamelCase(pathName)
+					}
+					typeName += fmt.Sprintf("ResponseBody%s", ToCamelCase(statusCodeOrDefault))


Is this sufficient to avoid type conflict? What if a request has two response bodies with different content types for the same response code? What happens in that case?

In that case, yep, it'll handle the conflict well enough

i.e.:

// NewPetResponseBody200ApplicationYaml defines model for the response body for POST /pets (200, application/yaml). type NewPetResponseBody200ApplicationYaml = map[string]interface{} // NewPetResponseBody200TextPlain defines model for the response body for POST /pets (200, text/plain). type NewPetResponseBody200TextPlain = map[string]interface{}

mmorells · 2023-05-09T15:15:31Z

Bump

massenz · 2023-10-03T00:50:28Z

Is there any updated on this?
It is impacting using go generate for k8s Object DeepCopy etc, as the inlined anonymous structs cannot be consumed to generate the functions.

Simplifying the issue, we have this generated code:

type MyBucket struct {
	Spec *struct {
		
		ArchivePeriod *BucketSpecArchivePeriod `json:"archivePeriod,omitempty"`
	 	Cors          *struct {
	 		 ...
	 	}
	 	// other fields
}

when running go generated ./generated we get the following error:

└─( go generate ./generated
command-line-arguments:-: name requested for invalid type: struct{Cors *struct{MaxAgeSeconds *float32 "json:\"maxAgeSeconds,omitempty\""; Methods *[]string "json:\"methods,omitempty\""; Origins *[]string "json:\"origins,omitempty\""; ResponseHeaders *[]string "json:\"responseHeaders,omitempty\""} "json:\"cors,omitempty\""; Status *struct{FromProvider *map[string]interface{} "json:\"fromProvider,omitempty\""} "json:\"status,omitempty\""}
Error: not all generators ran successfully
run `controller-gen object paths=types.gen.go -w` to see all available markers, or `controller-gen object paths=types.gen.go -h` for usage
generated/types.gen.go:6: running "controller-gen": exit status 1

By trying a few different combinations, it appears that the anonymoust structs are the cause of the error.
Thanks!

gainsley · 2024-10-22T20:59:41Z

Another bump for this.

Tommy-42 · 2025-03-27T20:58:35Z

Hey @jamietanna do you have any news for this feature ? We would benefit a lot from this and would like to see it merge.

Do you have any blockers ?

Cheers

jamietanna · 2025-03-27T21:10:43Z

We would benefit a lot from this and would like to see it merge.

Do you have any blockers ?

Main blocker is time to be honest 😅

As noted in #1606 the project would appreciate sponsors to help with dedicating time to the project's maintenance, and if the company you're working at would benefit from this, I'd appreciate sponsorship to help the work along

I've got quite a few things to do before v2.5.0 and an ever growing backlog, on top of long standing issues like this that would benefit many users

jamietanna force-pushed the defect/626 branch from c11125b to 196700a Compare June 30, 2022 08:23

jamietanna commented Jun 30, 2022

View reviewed changes

examples/authenticated-api/echo/api/api.gen.go Outdated Show resolved Hide resolved

jamietanna commented Jun 30, 2022

View reviewed changes

internal/test/components/components.gen.go Outdated Show resolved Hide resolved

AlainODea reviewed Jul 1, 2022

View reviewed changes

pkg/codegen/schema.go Outdated Show resolved Hide resolved

veger mentioned this pull request Jul 15, 2022

allOf code generation does not work with types from other packages #655

Open

jamietanna mentioned this pull request Nov 23, 2022

Anonymously defined enums (i.e. in paths) do not get generated #870

Open

jamietanna force-pushed the defect/626 branch 2 times, most recently from 31b8bcd to c0a2c50 Compare November 23, 2022 15:29

jamietanna commented Nov 25, 2022

View reviewed changes

pkg/codegen/codegen.go Outdated Show resolved Hide resolved

jamietanna force-pushed the defect/626 branch 2 times, most recently from 9ef3dd1 to 52a07d9 Compare November 25, 2022 17:52

jamietanna marked this pull request as ready for review November 25, 2022 17:54

jamietanna requested a review from deepmap-marcinr November 25, 2022 17:54

jamietanna force-pushed the defect/626 branch from b4f4d67 to 698edfe Compare November 27, 2022 15:40

jamietanna and others added 6 commits November 27, 2022 16:00

rew! allow content to be empty

80b258c

rew! handle absent content/mediaType

Fix typo in openapi in spec

4d9a2d5

make-generate

fe82a4b

prefactor into generateTypesForRequestBody

ab1ddd0

jamietanna force-pushed the defect/626 branch from 698edfe to 1772661 Compare November 27, 2022 21:28

Jamie Tanna and others added 2 commits November 28, 2022 17:41

make-generate

aa7cfee

jamietanna force-pushed the defect/626 branch from 1772661 to aa7cfee Compare November 28, 2022 17:42

deepmap-marcinr reviewed Nov 29, 2022

View reviewed changes

jamietanna mentioned this pull request Jul 31, 2023

Generate a type for nested struct in respond instead of anonymous struct #1139

Open

jamietanna mentioned this pull request Jan 23, 2024

enum not generated when used with anyof #1429

Open

jamietanna mentioned this pull request Jul 2, 2024

Support breaking out Anonymous Structs #1671

Closed

gainsley mentioned this pull request Oct 23, 2024

generate anonymous objects option edgexr/oapi-codegen#1

Merged

vbargl added a commit to vbargl/oapi-codegen that referenced this pull request Feb 7, 2025

fix oapi-codegen#648

3d884bd

vbargl added a commit to vbargl/oapi-codegen that referenced this pull request Feb 7, 2025

fix oapi-codegen#648 (#1)

d161603

aBMania mentioned this pull request Feb 12, 2025

Unusable code for schema response with oneOf #1900

Open

jamietanna marked this pull request as draft March 27, 2025 21:03

Uh oh!

Conversation

jamietanna commented Jun 30, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

veger commented Jul 13, 2022

Uh oh!

riftsin commented Nov 17, 2022

Uh oh!

jamietanna commented Nov 23, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

jamietanna commented Nov 25, 2022

Uh oh!

jamietanna commented Nov 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

deepmap-marcinr Nov 29, 2022

Choose a reason for hiding this comment

Uh oh!

jamietanna Nov 30, 2022

Choose a reason for hiding this comment

Uh oh!

mmorells commented May 9, 2023

Uh oh!

massenz commented Oct 3, 2023

Uh oh!

gainsley commented Oct 22, 2024

Uh oh!

Tommy-42 commented Mar 27, 2025

Uh oh!

jamietanna commented Mar 27, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

jamietanna commented Jun 30, 2022 •

edited

Loading

jamietanna commented Nov 23, 2022 •

edited

Loading

jamietanna commented Nov 27, 2022 •

edited

Loading