User documentation

• Build documentation
  • Requirements
  • Getting the code
  • Build
• Build and initialize the workspace client
  • Python client
  • Java client
  • Javascript client
• Workspace typed objects
  • Typed object basics
  • Typed object registration & versioning
  • Typed object validation
  • Typed object annotations
• Developing typed object definitions
  • TO size and composition
  • Very large objects
  • Annotations
• Type checking error messages
  • Missing property
  • Float vs. string
  • Integer vs. string
  • Integer vs. float
  • String vs. integer
  • Embedded
  • Optional
• Workspaces
  • Creating workspaces
  • Retrieving information about workspaces
  • Listing workspaces
  • Sharing workspaces
• Objects
  • Save an object
  • Save a new version
  • Save an object with metadata
  • Save an object with provenance
  • Save an object with dependency references
  • List objects
• Paging workspace objects
  • Sort order
  • Object ID versus reference limits
  • Paging by object ID limits
  • Paging by reference limit
• Subsetting objects
• Traversing object references
• Locking and publishing workspaces
• Shock integration with the workspace service
  • Overview
  • Resources
  • Direct Shock links vs. Handles
  • Handles
  • Direct Shock links
• Sample service integration with the workspace service
  • Overview
  • Resources
  • Creating objects linked to samples
• Workspace limits
  • Limits
  • Notes on sorting
  • Notes on workspace references
• FAQ
  • I can release a mapping / list / string / etc. type, but I can’t save anything as that type. Why not?
  • Why do I keep getting type checking errors in Perl when I know I created the right type?
• Known user-facing bugs
• Workspace API documentation