Bundle references into definitions

Let’s say we have a schema that has external references to another schema’s definitions:

foo.json

{
  "definitions": {
    "foo": {
      "properties": {
        "a": {
          "$ref": "./bar.json#/definitions/bar"
        },
        "b": {
          "$ref": "./bar.json#/definitions/bar"
        },
        "c": {
          "$ref": "./bar.json#/definitions/bar"
        }
      }
    }
  }
}

bar.json

{
  "definitions": {
    "bar": {
      "properties": {
        "a": {
          "type": "string"
        },
        "b": {
          "type": "number",
          "maximum": 20
        }
      }
    }
  }
}

When using parser.bundle('foo.json') to bundle the external references, this is the resulting schema:

{
  "definitions": {
    "foo": {
      "properties": {
        "a": {
          "properties": {
            "a": {
              "type": "string"
            },
            "b": {
              "type": "number",
              "maximum": 20
            }
          }
        },
        "b": {
          "$ref": "#/definitions/foo/properties/a"
        },
        "c": {
          "$ref": "#/definitions/foo/properties/a"
        }
      }
    }
  }
}

While this is a valid schema, it seems more straightforward to copy the definition for bar into definitions, especially if it is referenced in multiple places:

{
  "definitions": {
    "foo": {
      "properties": {
        "a": {
          "$ref": "#/definitions/bar"
        },
        "b": {
          "$ref": "#/definitions/bar"
        },
        "c": {
          "$ref": "#/definitions/bar"
        }
      }
    },
    "bar": {
      "properties": {
        "a": {
          "type": "string"
        },
        "b": {
          "type": "number",
          "maximum": 20
        }
      }
    }
  }
}

Can this be done somehow?

[aaronschwartz]

This ability is super helpful for creating files that are used by other class generator tools.

Are there any plans to have an option to create the shared definition entries automatically?

When maintaining multiple files, it’s kind of hard to remember/enforce that the definition entry is created along with the other references. And if those references ever change you need to make sure to go update the definition entry as well.

[JamesMessinger]

You can accomplish this by referencing bar in the definitions section, like this:

{
  "definitions": {
    "foo": {
      "properties": {
        "a": {
          "$ref": "./bar.json#/definitions/bar"
        },
        "b": {
          "$ref": "./bar.json#/definitions/bar"
        },
        "c": {
          "$ref": "./bar.json#/definitions/bar"
        }
      }
    }
  },
  "bar": {
    "$ref": "./bar.json#/definitions/bar" 
  }
}