feat(map): Codegen for JsonSchema Target

[jonathan-casey]

Description

Add JsonSchema code generation for Map Type. Validated against Schema Draft v7.

Sample <String, String>

{
  "$id": "org.acme.hr.Address.dictionary1",
  "schema": {
    "title": "Map1",
    "description": "An instance of org.acme.hr.Map1",
    "type": "object",
    "propertyNames": {
      "type": "string"
    },
    "additionalProperties": {
      "type": "string"
    }
  }
}

Sample <String, Boolean>

{
  "$id": "org.acme.hr.Address.dictionary1",
  "schema": {
    "title": "Map1",
    "description": "An instance of org.acme.hr.Map1",
    "type": "object",
    "propertyNames": {
      "type": "string"
    },
    "additionalProperties": {
      "type": "boolean"
    }
  }
}

Sample <String, Number>

{
  "$id": "org.acme.hr.Address.dictionary1",
  "schema": {
    "title": "Map1",
    "description": "An instance of org.acme.hr.Map1",
    "type": "object",
    "propertyNames": {
      "type": "string"
    },
    "additionalProperties": {
      "type": "integer"
    }
  }
}

Sample <String, Person>

{
  "$id": "org.acme.hr.Address.dictionary1",
  "schema": {
    "title": "Map1",
    "description": "An instance of org.acme.hr.Map1",
    "type": "object",
    "propertyNames": {
      "type": "string"
    },
    "additionalProperties": {
      "type": "number",
       "$ref": "#/definitions/org.acme.hr.Person"
    }
  }
}

Author Checklist

• Ensure you provide a DCO sign-off for your commits using the --signoff option of git commit.
• Vital features and changes captured in unit and/or integration tests
• Commits messages follow AP format
• Extend the documentation, if necessary

[github-actions]

coverage: 98.899% (+0.006%) from 98.893% when pulling 4646741 on jonathan/codegen_map_json_schema into 64de665 on main.

[dselman]

I noticed that in draft 6 of JSON Schema you can now do:

"propertyNames": {
    "pattern": "^[A-Za-z_][A-Za-z0-9_]*$"
  }

And even define different regexes for values, by key!

"patternProperties": {
    "^S_": { "type": "string" },
    "^I_": { "type": "integer" }
  },

We could use that for keys that have a regex validator (in a follow-on PR?).

Which version of JSON Schema are we currently targeting?

[jonathan-casey]

@dselman see PR description, (http://json-schema.org/draft-07/schema)

Regarding regex validation, I'm assuming this would apply to validators on Scalar Types used within a Map? If thats the case then I see no reason why that shouldn't be in scope for this PR.

[dselman]

Regex support for strings is a really useful addition but it should be supported for both scalar strings and regular strings.

[dselman]

If we add support for regex validators for scalars we should also support it for string properties.

[jonathan-casey]

That wasn't part of the original spec unfortunately. Supporting regex on Map elements of type string is a fundamental change at the parser level, and on through validation, etc. We should definitely add this as an enhancement at a later stage.

fyi @mttrbrts

[mttrbrts]

There may be a misunderstanding here?

We support regexs where they are defined in the Scalar type, we don't support them inline in the Map definition (for either Strings or Scalar types).

[dselman]

Bravo!