No nested schema for composed property about php-json-schema-model-generator HOT 5 CLOSED

I see thanks a lot!

from php-json-schema-model-generator.

I think I understand what's the issue. The lib doesn't seem to expect multiple types inside a oneOf or allOf list. However I think this is a valid schema.

from php-json-schema-model-generator.

Hi @giann,
the lib is able to handle compositions like oneOf on the top level of a schema. The issue is located in the first branch of your composition which can be simplified into the following schema which makes the issue more obvious:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "string"
}

This schema can't be represented as a object. If this schema is passed to the generator it would be skipped. Due to the composition the generator starts to generate nested objects for each branch of the composition and fails on the first branch as the branch doesn't provide a nested schema which is representable as an object. I think the error message could be more meaningful.

Your schema is a valid JSON-schema but it can't be represented as a object.

from php-json-schema-model-generator.

Thanks for the quick answer @wol-soft
So i could get around this by using the oneOf in the schemas that reference this one so the oneOf is not at the top level but for, say, a property?

from php-json-schema-model-generator.

yes, if you wrap the composition into an object, let's say like in the following example, the generator will generate an object with the address property which is either a string or an instance of the nested object containing the properties from the second oneOf branch.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "address": {
      "oneOf": [
        { "type": "string" },
        {
          "type": "object",
          "properties": {
            "address": { "type": "string" },
            "specialDelivery": { "type": "string" },
            "zipCode": { "type": "string" },
            "city": { "type": "string" }
          },
          "additionalProperties": false
        }
      ]
    }
  },
  "required": [ "address" ]
}

Also a reference to the schema from another schema (eg. customer) is possible. In this case just make sure you put the schema in let's say an include directory outside of the directory you have configured to generate the models from to make sure the generator doesn't try to generate a model from the address schema.

from php-json-schema-model-generator.