X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=docs%2Fmodel%2Fcurrent%2Ftop.rst;fp=docs%2Fmodel%2Fcurrent%2Ftop.rst;h=640abe23432952148ea9833ea58a36805b683b8c;hp=0000000000000000000000000000000000000000;hb=cca05a55f3434d8a031b98f4a496adb8df20c122;hpb=aa094dc1a834bf89ebd6549a292fedf2446fb682

diff --git a/docs/model/current/top.rst b/docs/model/current/top.rst
new file mode 100644
index 0000000000..640abe2343
--- /dev/null
+++ b/docs/model/current/top.rst
@@ -0,0 +1,48 @@
+..
+   Copyright (c) 2021 Cisco and/or its affiliates.
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at:
+..
+       http://www.apache.org/licenses/LICENSE-2.0
+..
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+
+CSIT model
+^^^^^^^^^^
+
+This document describes what is currently implemented in CSIT,
+especially the export side (UTI), not import side (PAL).
+
+Version
+~~~~~~~
+
+This document is valid for CSIT model version 0.1.0.
+
+It is recommended to use semantic versioning: https://semver.org/
+That means, if the new model misses a field present in the old model,
+bump the major version. If the new model adds a field
+not present in the old model, bump the minor version.
+Any other edit in the implmenetation (or documentation) bumps the patch version.
+If you change value type or formatting,
+consider whether the parser (PAL) understands the new value correctly.
+Renaming a field is the same as adding a new one and removing the old one.
+Parser (PAL) has to know exact major version and minimal minor version,
+and unless bugs, it can ignore patch version and bumped minor version.
+
+UTI
+~~~
+
+UTI stands for Unified Test Interface.
+It mainly focuses on exporting information gathered during test run
+into JSON output files.
+
+Files
+-----
+
+No files are exported yet in this version.