OpenAPITools / OpenAPITools/openapi-generator

[BUG][Dart] Object type is missing from list of object in OAS3.1

Open
#18,193 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
Description

With OAS3.1 it's no longer possible to generate typed lists for API responses. A response like this:

	"200": {
		"content": {
			"application/json": {
				"schema": {
					"properties": {
						"result": {
							"items": {
								"$ref": "#/components/schemas/Thing"
							},
							"type": "array"
						}
					},
					"type": "object"
				}
			}
		},
	}

... used to generate a model with a field List<Thing> result;, but when changing the openapi option to 3.1.0 the type of the result field becomes Object? instead.

openapi-generator version

v7.4.0 and v7.5.0

OpenAPI declaration file content or url and steps to reproduce

https://github.com/traed/openapi-dart-bug

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the reproduction project at https://github.com/traed/openapi-dart-bug and generate the Dart client from the supplied OAS3.1 declaration. Compare the generated response model with OAS3.0 behavior, focusing on the result field. Done means an array of Thing references is generated as List rather than Object?.

Written by the indexing model from the issue text.

Assessment

Tech stack
dart, java, openapi
Domain
api, devtools
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.