1
1
Robot Framework and Libdoc schema definitions
2
2
=============================================
3
3
4
- This directory contains schema definitions for Robot Frameworks XML output files
5
- as well as for XML and JSON spec files created by Libdoc _ .
4
+ This directory contains schema definitions for various Robot Framework and
5
+ Libdoc _ output files.
6
6
7
7
Only the latest schema versions are directly available and they may not be
8
8
compatible with older Robot Framework versions. If you need to access old
@@ -13,6 +13,7 @@ Schema files
13
13
------------
14
14
15
15
- `<robot.xsd >`_ - Robot Framework XML output schema in XSD _ format.
16
+ - `<running.json >`_ - `JSON Schema `_ for ``robot.running.TestSuite `` model structure.
16
17
- `<libdoc.xsd >`_ - Libdoc XML spec schema in XSD _ format.
17
18
- `<libdoc.json >`_ - Libdoc JSON spec schema in `JSON Schema `_ format.
18
19
@@ -24,16 +25,18 @@ Schema files themselves contain embedded documentation and comments explaining
24
25
the structure in more detail. They also contain instructions how to make them
25
26
XSD 1.1 compatible if needed.
26
27
27
- Libdoc's JSON schema uses JSON Schema Draft 2020-12.
28
+ JSON schemas use JSON Schema Draft 2020-12.
28
29
29
30
Updating schemas
30
31
----------------
31
32
32
33
XSD schemas are created by hand and updates need to be done directly to them.
33
34
34
- Libdoc's JSON schema is generated based on a model created using pydantic _.
35
- To modify the schema, update the model in `<libdoc_json_schema.py >`_ file
36
- and execute the file to regenerate `<libdoc.json >`_.
35
+ JSON schemas are generated based on models created using pydantic _.
36
+ To modify these schemas, first update the appropriate pydantic model either
37
+ in `<running_json_schema.py >`_ or `<libdoc_json_schema.py >`_
38
+ and then execute that file to regenerate the actual schema file in
39
+ `<running.json >`_ or `<libdoc.json >`_, respectively.
37
40
38
41
Testing schemas
39
42
---------------
0 commit comments