Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert optional references to oneOf type with null #13

Open
sandrokeil opened this issue Apr 29, 2022 · 0 comments
Open

Convert optional references to oneOf type with null #13

sandrokeil opened this issue Apr 29, 2022 · 0 comments
Labels
bug Something isn't working
Milestone

Comments

@sandrokeil
Copy link
Member

If null is provided as data, then the JSON schema validation will fail, if we don't allow type of null for optional references. The reference object must allow null to pass JSON schema validation, which is wrong.

The shorthand syntax of:

{
  "shorthand": true,
  "schema": {
    "customerId": "/Customer/CustomerId",
    "externalId?": "/Acme/ExternalId"
  }
}

should be translated into

{
    "type": "object",
    "properties": {
        "customerId": {
            "$ref": "#/definitions/Customer/CustomerId",
            "namespace": "/Customer"
        },
        "externalId": {
            "oneOf": [
                {"type": "null"},
                {"$ref": "#/definitions/Acme/ExternalId"}
            ],
            "namespace": "/Acme"
        }
    },
    "required": [
        "customerId"
    ],
    "additionalProperties": false
}
@sandrokeil sandrokeil added the bug Something isn't working label Apr 29, 2022
@sandrokeil sandrokeil added this to the 0.4.0 milestone Apr 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant