Using hashmaps produces invalid openapi schema

[ostrolucky]

API Platform version(s) affected: 4.0.9

Description

How to reproduce

#[ApiResource]
class Test {
    /** @var array<string, Foo> */
    public array $foos;
}

class Foo {
    public string $bar;
}

above produces schema like so

"Test": {
  "type": "object",
  "description": "",
  "deprecated": false,
  "properties": {
    "foos": {
      "type": "object",
      "additionalProperties": {
        "type": "unknown_type"
      }
    }
  }
},

since "unknown_type" isn't actually recognized by OpenAPI, openapi schema validators will reject this kind of schema.

Instead, I would expect it generates schema like so

"Test": {
  "type": "object",
  "description": "",
  "deprecated": false,
  "properties": {
    "foos": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "properties": {"bar": {"type": "string"}}
      }
    }
  }
},

Possible Solution

Additional Context

[vinceAmstoutz]

@ostrolucky Have you tried with Foo[] or array<Foo>?

[ostrolucky]

That's not accurate though, for us it's really a hashmap like so

{
  "foos": { 
    "randomProp123" : {
      "bar: "string"
    },
    "randomProp321" : {
      "bar": "string"
    }
  }
}

hence needs to be reflected in php docblocks and openapi docs as such. Especially openapi docs because they are consumed by FE devs and for them it makes a big difference treating the prop as object or array.

In places where we don't use hashmap but list, that's documented as list<Foo> and generated openapi docs is correct, hence this issue is only about hashmaps.

[soyuka]

Do you have phpstan/phpdoc-parser ? Can you try adding phpdocumentor/reflection-docblock ?
We do handle the case of an embeded object I don't get why the array makes any difference. Could you check at:

core/src/JsonSchema/Metadata/Property/Factory/SchemaPropertyMetadataFactory.php

Line 192 in fb47197

Type::BUILTIN_TYPE_OBJECT => $this->getClassType($type->getClassName(), $type->isNullable(), $readableLink),

[ostrolucky]

I have both packages installed. To me it seems issue is that $keyType is not passed to getType

[soyuka]

Thanks for the details @ostrolucky !