ClusterCockpit/cc-specifications
1
0
Fork 0
mirror of https://github.com/ClusterCockpit/cc-specifications.git synced 2024-11-10 01:37:25 +01:00
Code Issues Packages Projects Releases Activity

Update README.md

Browse Source
This commit is contained in:
Jan Eitzinger 2022-03-18 15:29:31 +01:00 committed by GitHub
parent 7eefe0f6b0
commit eb1353948e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -1,14 +1,6 @@
# ClusterCockpit Standardization of APIs and data formats
# Specifications of datastructures, interfaces, and file formats
## RESTful API specifications
The specifications are defined following the [OpenAPI Initiative](https://www.openapis.org) format standard.
## Data exchange formats
Main data exchange format is JSON.
The specifications are defined following the [JSON schema](https://json-schema.org) format standard.
## Database schema
Recommended minimal SQL database schema for job meta data.
* **Generic datastructure specifications**: To be used in applications, as payloads in apis, or as file formats.
* **API Interfaces offered by ClusterCockpit**
* **HPC Job-Archive specification**
* **SQL Jobs Table Schema**