Schema dependencies should be iterated

[jonaslagoni]

Reason/Context

Currently we do not iterate schema dependencies. We should iterate them and combine properties/items/types etc together.

{
  "type": "object",
  "properties": {
    "name": { "type": "string" },
    "credit_card": { "type": "number" }
  },
  "required": ["name"],
  "dependencies": {
    "credit_card": {
      "properties": {
        "billing_address": { "type": "string" }
      },
      "required": ["billing_address"]
    }
  }
}

should merge it together to give the model:

{
  "type": "object",
  "properties": {
    "name": { "type": "string" },
    "credit_card": { "type": "number" },
    "billing_address": { "type": "string" }
  },
  "required": ["name"]
}

Reason why billing_address is not added to the list of required properties, is that it is a runtime requirement that we cannot do anything about when rendering the model.

see more here: http://json-schema.org/understanding-json-schema/reference/object.html#schema-dependencies

[magicmatatjahu]

@jonaslagoni Please have in mind that final schema is only valid, when you have defined credit_card - like in example in linked web, so I think that there we have an union type with given schema:

{
  oneOf: [
    {
      "type": "object",
      "properties": {
        "name": { "type": "string" },
        "credit_card": { "type": "number" },
        "billing_address": { "type": "string" }
      },
      "required": ["name", "credit_card", "billing_address"]
    },
    {
      "type": "object",
      "properties": {
        "name": { "type": "string" }
      },
      "required": ["name"]
    }
  ]
}

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴
It will be closed in 60 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation.
Thank you for your contributions ❤️

[jonaslagoni]

@jonaslagoni Please have in mind that final schema is only valid, when you have defined credit_card - like in example in linked web, so I think that there we have an union type with given schema:

As we have another issue defining this problem, this union type will not be the focus in this issue.

[asyncapi-bot]

🎉 This issue has been resolved in version 0.10.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀