Skip to content

Generate schema

RSF only

Schema generation only supports RSF and not JSON Schema. Future development may include this functionality.

For generating a schema from a file, gen is used. The gen tool is used for generating schemas from input. This is a useful step to start from, where a developer can then further define the schema.

rickle schema gen -h

Prints the following options:

optional arguments:
 -h, --help          show this help message and exit
 --input  [ ...]     input file(s) to generate from
 --output  [ ...]    output file(s) to write to
 --silent, -s        silence output
 --extras, -e        include extra properties

Consider the following example file:

my-example.yaml
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
root:
 null_type: null
 dict_type:
   key_one: 99
   key_two: 'text'
 a_string_list:
   - lorem
   - ipsum
 a_floats_list:
   - 0.8
   - 0.9
 a_mixed_list:
   - lorem
   - 0.9

Running the gen tool:

rickle schema gen --input my-example.yaml

will create the file my-example.schema.yaml as the following:

my-example.schema.yaml
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
type: object
properties:
 root:
   type: object
   properties:
     null_type:
       type: 'null'
     dict_type:
       type: object
       properties:
         key_one:
           type: integer
         key_two:
           type: string
     a_string_list:
       type: array
       items:
       - type: string
     a_floats_list:
       type: array
       items:
       - type: number
     a_mixed_list:
       type: array
       items:
       - type: 'null'

It will print the following:

.\my-example.yaml -> .\my-example.schema.yaml

Note

This can be suppressed by using the --silent flag.

Note

Note that if no output name is given the filename becomes <filename>.schema.<ext>.

Of course the type can also be defined by either using --output-type:

rickle --output-type JSON schema gen --input my-example.yaml

Or implicitly with extensions in filenames:

rickle schema gen --input my-example.yaml --output my-schema.json

Which will result in:

my-schema.json
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
{
   "type": "object",
   "properties": {
       "root": {
           "type": "object",
           "properties": {
               "null_type": {
                   "type": "null"
               },
               "dict_type": {
                   "type": "object",
                   "properties": {
                       "key_one": {
                           "type": "integer
                           "
                       },
                       "key_two": {
                           "type": "string"
                       }
                   }
               },
               "a_string_list": {
                   "type": "array",
                   "items": [{
                           "type": "string"
                       }
                   ]
               },
               "a_floats_list": {
                   "type": "array",
                   "items": [{
                           "type": "number"
                       }
                   ]
               },
               "a_mixed_list": {
                   "type": "array",
                   "items": [{
                           "type": "null"
                       }
                   ]
               }
           }
       }
   }
}