Skip to content

Commit 82f3b04

Browse files
committed
Add schema for robot.running JSON model. Part of #3902.
Also minor changes to the JSON model itself. Most importatnly, fix `While` to include `on_limit`.
1 parent 41dcf39 commit 82f3b04

File tree

7 files changed

+1083
-22
lines changed

7 files changed

+1083
-22
lines changed

doc/schema/README.rst

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
Robot Framework and Libdoc schema definitions
22
=============================================
33

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.
66

77
Only the latest schema versions are directly available and they may not be
88
compatible with older Robot Framework versions. If you need to access old
@@ -13,6 +13,7 @@ Schema files
1313
------------
1414

1515
- `<robot.xsd>`_ - Robot Framework XML output schema in XSD_ format.
16+
- `<running.json>`_ - `JSON Schema`_ for ``robot.running.TestSuite`` model structure.
1617
- `<libdoc.xsd>`_ - Libdoc XML spec schema in XSD_ format.
1718
- `<libdoc.json>`_ - Libdoc JSON spec schema in `JSON Schema`_ format.
1819

@@ -24,16 +25,18 @@ Schema files themselves contain embedded documentation and comments explaining
2425
the structure in more detail. They also contain instructions how to make them
2526
XSD 1.1 compatible if needed.
2627

27-
Libdoc's JSON schema uses JSON Schema Draft 2020-12.
28+
JSON schemas use JSON Schema Draft 2020-12.
2829

2930
Updating schemas
3031
----------------
3132

3233
XSD schemas are created by hand and updates need to be done directly to them.
3334

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.
3740

3841
Testing schemas
3942
---------------

0 commit comments

Comments
 (0)