Skip to content

Root repository for ICD model files, contains a Git submodule for each TMT subsystem

Notifications You must be signed in to change notification settings

tmt-icd/ICD-Model-Files

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Repository holding Version Information for ICD model files

The GitHub site tmt-icd contains a number of repositories holding TMT interface control document (ICD) model files. It contains a Git repository for each TMT subsystem.

For an overview of the TMT ICD workflow see here.

ICD model files describe the APIs for TMT subsystems in a format defined by the icd software (based on HOCON, a simplified form of JSON). The model files are validated by the software using JSON Schema.

You can use the icd-git command to import the APIs and ICDs for a selected subsystem (or all subsystems), with version history, into the ICD database.

Warning: The icd-git command will delete the current contents of the local ICD database before ingesting the files from the repository.

Publishing a subsystem API or ICD with icd-git creates an entry in a JSON file under the ./apis or ./icds directory. These files should not be manually edited. They are used to store version related information.

An ICD version is defined by an entry in a JSON formatted file named icd-$subsytem1-$subsystem2.json which is stored in the icds subdirectory of this repository. The file lists the two subsystems that make up the ICD, the ICD version, the versions of the two subsystems along with the user name of the user that created the version, a comment and the date.

See the icd project and icd-git subproject for more information.

About

Root repository for ICD model files, contains a Git submodule for each TMT subsystem

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published