docs/model/current/top.rst

   1 ..
   2    Copyright (c) 2021 Cisco and/or its affiliates.
   3    Licensed under the Apache License, Version 2.0 (the "License");
   4    you may not use this file except in compliance with the License.
   5    You may obtain a copy of the License at:
   6 ..
   7        http://www.apache.org/licenses/LICENSE-2.0
   8 ..
   9    Unless required by applicable law or agreed to in writing, software
  10    distributed under the License is distributed on an "AS IS" BASIS,
  11    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12    See the License for the specific language governing permissions and
  13    limitations under the License.
  14
  15
  16 CSIT model
  17 ^^^^^^^^^^
  18
  19 This document describes what is currently implemented in CSIT,
  20 especially the export side (UTI), not import side (PAL).
  21
  22 Version
  23 ~~~~~~~
  24
  25 This document is valid for CSIT model version 0.1.0.
  26
  27 It is recommended to use semantic versioning: https://semver.org/
  28 That means, if the new model misses a field present in the old model,
  29 bump the major version. If the new model adds a field
  30 not present in the old model, bump the minor version.
  31 Any other edit in the implmenetation (or documentation) bumps the patch version.
  32 If you change value type or formatting,
  33 consider whether the parser (PAL) understands the new value correctly.
  34 Renaming a field is the same as adding a new one and removing the old one.
  35 Parser (PAL) has to know exact major version and minimal minor version,
  36 and unless bugs, it can ignore patch version and bumped minor version.
  37
  38 UTI
  39 ~~~
  40
  41 UTI stands for Unified Test Interface.
  42 It mainly focuses on exporting information gathered during test run
  43 into JSON output files.
  44
  45 Files
  46 -----
  47
  48 No files are exported yet in this version.