Title: Incorrect array response generation with multiple refs · Issue #1509 · oapi-codegen/oapi-codegen · GitHub
Open Graph Title: Incorrect array response generation with multiple refs · Issue #1509 · oapi-codegen/oapi-codegen
X Title: Incorrect array response generation with multiple refs · Issue #1509 · oapi-codegen/oapi-codegen
Description: Version v2.1.0 Issue When referencing a response component multiple times, the generated code incorrectly uses struct embedding. In this example the generated server.go contains type MyObjectResponseJSONResponse []MyObject type MyAnother...
Open Graph Description: Version v2.1.0 Issue When referencing a response component multiple times, the generated code incorrectly uses struct embedding. In this example the generated server.go contains type MyObjectRespon...
X Description: Version v2.1.0 Issue When referencing a response component multiple times, the generated code incorrectly uses struct embedding. In this example the generated server.go contains type MyObjectRespon...
Opengraph URL: https://github.com/oapi-codegen/oapi-codegen/issues/1509
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Incorrect array response generation with multiple refs","articleBody":"## Version\r\nv2.1.0\r\n\r\n## Issue\r\nWhen referencing a response component multiple times, the generated code incorrectly uses struct embedding. In this example the generated `server.go` contains\r\n```go\r\ntype MyObjectResponseJSONResponse []MyObject\r\ntype MyAnotherQuery200JSONResponse struct{ MyObjectResponseJSONResponse }\r\ntype MyQuery200JSONResponse struct{ MyObjectResponseJSONResponse }\r\n```\r\nresulting in the response being nested inside the field `MyObjectResponseJSONResponse` like\r\n```json\r\n{\r\n \"MyObjectResponseJSONResponse\": [\r\n {\"myField\": \"value\"}\r\n ]\r\n}\r\n```\r\nThe code I would expect is something like\r\n```go\r\ntype MyObjectResponseJSONResponse []MyObject\r\ntype MyAnotherQuery200JSONResponse MyObjectResponseJSONResponse\r\ntype MyQuery200JSONResponse MyObjectResponseJSONResponse\r\n```\r\nA workaround is not not use the response component and instead define the response under each path. Thanks in advance for response and this awesome library 🙏 .\r\n\r\n## To reproduce\r\n```\r\ngo run github.com/deepmap/oapi-codegen/v2/cmd/oapi-codegen@v2.1.0 --config=server.cfg.yaml openapi.yaml > server.go\r\n```\r\n\r\n`server.cfg.yaml`\r\n```\r\npackage: gen\r\ngenerate:\r\n echo-server: true\r\n strict-server: true\r\n embedded-spec: true\r\n```\r\n\r\n`openapi.yaml`\r\n```\r\nopenapi: 3.1.0\r\ninfo:\r\n version: 1.0.0\r\n title: bug?\r\npaths:\r\n /myobject/query:\r\n get:\r\n operationId: MyQuery\r\n parameters: []\r\n responses:\r\n \"200\":\r\n $ref: '#/components/responses/MyObjectResponse'\r\n x-visible: true\r\n /my-object/another-query:\r\n get:\r\n operationId: MyAnotherQuery\r\n parameters: []\r\n responses:\r\n \"200\":\r\n $ref: '#/components/responses/MyObjectResponse'\r\n x-visible: true\r\ncomponents:\r\n schemas:\r\n MyObject:\r\n type: object\r\n properties:\r\n myField:\r\n type: string\r\n responses:\r\n MyObjectResponse:\r\n description: Successful response\r\n content:\r\n application/json:\r\n schema:\r\n type: array\r\n items:\r\n $ref: '#/components/schemas/MyObject'\r\n```\r\n","author":{"url":"https://github.com/robertschonfeld","@type":"Person","name":"robertschonfeld"},"datePublished":"2024-03-24T14:58:32Z","url":"https://github.com/oapi-codegen/oapi-codegen/issues/1509"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react-reconciler,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@d5750093facf |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:45e2f034-4e18-cb1e-b0aa-b6e6d880bc0b |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 93C4:3D2677:2EAA7C8:3D3F966:6AF9CFF1 |
| html-safe-nonce | fb32238ace992c552ffb5ed48306cd87a254aede156c399795244d06115eb2bd |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5M0M0OjNEMjY3NzoyRUFBN0M4OjNEM0Y5NjY6NkFGOUNGRjEiLCJ2aXNpdG9yX2lkIjoiOTUzMjU2MzE5NDIwODQ2MDY1IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | 8d12b3c72f54072f9c59e86b0f1bcfdb3d56eb4212434e7108f26d6e157e1c96 |
| hovercard-subject-tag | issue:2204392160 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/oapi-codegen/oapi-codegen/1509/issue_layout |
| twitter:image | https://opengraph.githubassets.com/be15dc8ae94b151385f3e1106ffd7218652b84c2503bb48f67fa9f17903798e6/oapi-codegen/oapi-codegen/issues/1509 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/be15dc8ae94b151385f3e1106ffd7218652b84c2503bb48f67fa9f17903798e6/oapi-codegen/oapi-codegen/issues/1509 |
| og:image:alt | Version v2.1.0 Issue When referencing a response component multiple times, the generated code incorrectly uses struct embedding. In this example the generated server.go contains type MyObjectRespon... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | robertschonfeld |
| hostname | github.com |
| expected-hostname | github.com |
| None | 612d3e6ffd693e7ea8d9fcf452370995872baef31d825b1fedef704cd3d24ac7 |
| turbo-cache-control | no-preview |
| go-import | github.com/oapi-codegen/oapi-codegen git https://github.com/oapi-codegen/oapi-codegen.git |
| octolytics-dimension-user_id | 142752710 |
| octolytics-dimension-user_login | oapi-codegen |
| octolytics-dimension-repository_id | 173009358 |
| octolytics-dimension-repository_nwo | oapi-codegen/oapi-codegen |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 173009358 |
| octolytics-dimension-repository_network_root_nwo | oapi-codegen/oapi-codegen |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 072e34035c13c31543fba9f025cbbbda4210dae4 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width