KBase Workspace Service Manual

Overview

The Workspace Service (WSS) is a language independent remote storage and retrieval system for KBase typed objects (TO) defined with the KBase Interface Description Language (KIDL). It has the following primary features:

• Immutable storage of TOs with

  • user defined metadata

  • data provenance

• Versioning of TOs

• Referencing from TO to TO

• Typechecking of all saved objects against a KIDL specification

• Collecting typed objects into a workspace

• Sharing workspaces with specific KBase users or the world

• Freezing and publishing workspaces

• Serverside extraction of portions of an object

Manual

• Workspace fundamentals
  • Typed object relationships
  • Addressing workspaces and objects
  • The object graph
  • Example
• User documentation
  • Build documentation
  • Build and initialize the workspace client
  • Workspace typed objects
  • Developing typed object definitions
  • Type checking error messages
  • Workspaces
  • Objects
  • Paging workspace objects
  • Subsetting objects
  • Traversing object references
  • Locking and publishing workspaces
  • Shock integration with the workspace service
  • Sample service integration with the workspace service
  • Workspace limits
  • FAQ
  • Known user-facing bugs
  • Workspace API documentation
• Server Administrator Documentation
  • Build, configure, and deploy
  • Test
  • Workspace events
  • Workspace scaling
  • Workspace resource requirements
  • Administration interface
  • Upgrading the workspace
  • Known administration bugs
• Developer documentation
  • Contributions and branches
  • Recompiling the generated code
  • Release checklist
  • Deploying the Workspace Service locally
• Workspace service release notes
  • VERSION: 0.15.0 (Released TBD)
  • VERSION: 0.14.2 (Released 11/9/2023)
  • VERSION: 0.14.1 (Released 6/21/2022)
  • VERSION: 0.14.0 (Released 6/10/2022)
  • VERSION: 0.13.2 (Released 6/1/2022)
  • VERSION: 0.13.1 (Released 4/27/2022)
  • VERSION: 0.13.0 (Released 4/13/2022)
  • VERSION: 0.12.1 (Released 1/25/2022)
  • VERSION: 0.12.0 (Released 11/16/21)
  • VERSION: 0.11.5 (Released 4/27/21)
  • VERSION: 0.11.4 (Released 1/6/21)
  • VERSION: 0.11.3 (Released 10/15/20)
  • VERSION: 0.11.2 (Released 3/23/20)
  • VERSION: 0.11.1 (Released 8/20/19)
  • VERSION: 0.11.0 (Released 7/25/19)
  • VERSION: 0.10.1 (Released 7/11/19)
  • VERSION: 0.10.0 (Released 7/2/19)
  • VERSION: 0.9.1 (Released 4/18/19)
  • VERSION: 0.9.0 (Released 4/10/19)
  • VERSION: 0.8.2 (Released 12/3/18)
  • VERSION: 0.8.1 (Released 4/24/18)
  • VERSION: 0.8.0 (Released 1/30/18)
  • VERSION: 0.7.1 (Released 6/22/17)
  • VERSION: 0.7.0 (Released 5/5/17)
  • VERSION: 0.6.0 (Released 12/9/16)
  • VERSION: 0.5.0 (Released 8/12/16)
  • VERSION: 0.4.1 (Released 5/27/16)
  • VERSION: 0.4.0 (Released 2/2/16)
  • VERSION: 0.3.5 (Released 5/15/15)
  • VERSION: 0.3.4 (Released 4/10/15)
  • VERSION: 0.3.3 (Released 10/28/14)
  • VERSION: 0.3.2 (Released 10/20/14)
  • VERSION: 0.3.1 (Released 10/1/2014)
  • VERSION: 0.3.0 (Released 9/2/2014)
  • VERSION: 0.2.1 (Released 7/11/14)
  • VERSION: 0.2.0 (Released 5/18/14)
  • VERSION: 0.1.6 (Released 3/3/14)
  • VERSION: 0.1.5 (Released 2/5/14)
  • VERSION: 0.1.4 (Released 1/30/14)
  • VERSION: 0.1.3 (Released 1/24/14)
  • VERSION: 0.1.2 (Released 1/23/14)
  • VERSION: 0.1.1 (Released 1/21/14)
  • VERSION: 0.1.0 (Released 1/9/2014)
  • VERSION: 0.0.5 (Released 11/19/2013)
  • VERSION: 0.0.4 (Released 8/13/2013)
  • VERSION: 0.0.3 (Released 1/1/2012)
  • VERSION: 0.0.2 (Released 11/30/2012)
  • VERSION: 0.0.1 (Released 10/12/2012)
• Documentation TODO list