component-json-schemas/README.md

   1 # Component JSON Schemas
   2
   3 This repository contains the custom JSON schemas to support the onboarding of components:
   4
   5 * Component specification schema
   6 * Auxilary component specification schema for Docker
   7 * Auxilary component specification schema for CDAP
   8 * Data formats schema
   9
  10 ## Testing changes
  11
  12 Use the Python `jsonschema` command-line tool to do validation checks:
  13
  14 Example:
  15
  16 ```
  17 $ jsonschema -i tests/component-spec-docker.json component-spec-schema.json
  18 ```
  19
  20 ## Uploading to Nexus
  21
  22 For the component specification schema:
  23
  24 ```
  25 curl -v --user <user>:<password> https://<your file server host>/schemas/component-specification/<tag>/component-spec-schema.json --upload-file component-spec-schema.json
  26 ```
  27
  28 For the data format schema:
  29
  30 ```
  31 curl -v --user <user>:<password> https://<your file server host>/schemas/data-format/<tag>/data-format-schema.json --upload-file data-format-schema.json
  32 ```
  33
  34 ### `dcae-cli`
  35
  36 The `dcae-cli` looks for these schemas under a tag that is of the format `dcae-cli-v<major version>` where the major version is an integer that is the major part of semver.  For schema changes that are breaking, you must bump the `<major version>`.  Otherwise, you can simply replace the existing schema by uploading using the same tag.