Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Page about component & deployment databases

Table of Contents
outlinetrue
stylenone

Component Database

Resources

...

API Documentation: Swagger UI (stanford.edu)

Potential Schema

Code Block
linenumberstrue
collapsetrue
/* new schema for component db */

// Note - Not all fields are populated depending on the api endpoint
{
    "id": "",                   // Primary Key of json object
    "name": "",                 // Name of component (corresponds to name of repository)
    "organization": "",         // Name of organization
    "description": "",          // Description of component
    "version": "",              // Version of component
    "environment": "",          // Development environment - ex: ['rhel7', 'rhel8', 'matlab']
    "url": "",                  // URL/filepath to the component object
    "approval": "",             // Determines what kind of approval was done - ex: ['all', 'none']
    "dependOnComponentIds": [   // Component dependencies
      "",
      ""
    ]
}

/* Example */
{
  "id": "663e591ce77eef11eb66a54f",
  "name": "mps_central_node",
  "organization": "slaclab",
  "description": "central node for machine protection system",
  "version": "v1",
  "environment": "rhel7", 
  "url": "s3df/slaclab/mps_central_node",
  "approval": "all",
  "dependOnComponentIds": [
    "567fsfjenvbu123ed21",
    "dsfn8923fcnsdiujp20"
  ]
}

Other Notes

  1. cbs - core build system
  2. docker-compose.yml file is used to create the database locally (for development purposes). Where you would use a 'docker compose up' command to execute

...