Skip to content

Latest commit

 

History

History
45 lines (39 loc) · 1.49 KB

jsonschema.md

File metadata and controls

45 lines (39 loc) · 1.49 KB
Raw

JSON Schema Generation

You can generate JSON schema from any structure by doing something like:

./reslang ./models/gendiagram --jsonschema SegmentDeliveryAttemptStats --stdout

Note a few things:

  • The default is to use the JSON schema root specified (e.g. SegmentDeliveryAttemptStats) and include everything it references
  • If you use "--followresources" it will generate the same definitions it uses for Swagger resources. You can specifically refer to one of the structures generated off the resources as your root - e.g. SegmentInput is generated as the GET representation for a Segment resource
  • If you use "--jsonschema noroot" it will include any structs, unions or enums in the file, and ignore resources. No root will be used, all the structures will go into the "definitions" section

The example above generates the following schema:

{
  "$id": "https://schemas.liveramp.com/segmentdeliveryattemptstats",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "totalAudienceKeys": {
      "type": "integer",
      "format": "int64"
    },
    "audienceKeysMatched": {
      "type": "integer",
      "format": "int64"
    },
    "targetIdentifiersMatched": {
      "type": "integer",
      "format": "int64"
    },
    "targetIdentifiersDelivered": {
      "type": "integer",
      "format": "int64"
    }
  },
  "required": [
    "totalAudienceKeys",
    "audienceKeysMatched",
    "targetIdentifiersMatched",
    "targetIdentifiersDelivered"
  ]
}