Skip to content

You're not viewing the latest version. Click here to go to latest.

DaSCH Service Platform Documentation

Back End

Initializing search

Overview
DSP-APP
DSP-API
DSP-TOOLS
DSP-INGEST
DSP-META
Developers

DaSCH Service Platform Documentation

Overview
DSP-APP
DSP-APP
- Introduction
- User Guide
  User Guide
  - Introduction
  - Project Administration
  - System Administration
  - Data Management
    Data Management
    
    Start from scratch
    
    Search and browse
    
    Search results
    
    Work on your data
  - User Profile
- Contribution
  Contribution
DSP-API
DSP-API
- Introduction
  Introduction
- DSP Ontologies
  DSP Ontologies
- DSP-API Endpoints
  DSP-API Endpoints
  - DSP-API V2
    DSP-API V2
    
    Introduction
    
    Authentication
    
    Reading and Searching Resources
    
    Reading the User's Permissions on Resources and Values
    
    Getting Lists
    
    Gravsearch - Virtual Graph Search
    
    Creating and Editing Resources
    
    Creating and Editing Values
    
    Querying, Creating, and Updating Ontologies
    
    Textual Data in DSP-API
    Textual Data in DSP-API
    
    Overview
    
    Standard Standoff Markup
    
    Custom Standoff Mapping
    
    TEI XML
    
    Permalinks
    
    IRIs
  - Admin API
    Admin API
    
    Introduction
    
    Overview
    
    Users Endpoint
    
    Projects Endpoint
    
    Groups Endpoint
    
    Lists Endpoint
    
    Permissions Endpoint
    
    Stores Endpoint
    
    OpenApi Documentation
  - Util API
    Util API
    
    Version
  - Instrumentation API
    Instrumentation API
    
    Introduction
    
    Health Endpoint
    
    Metrics Endpoint
- Publishing and Deployment
  Publishing and Deployment
  - Publishing
  - Configuration
- DSP Internals
  DSP Internals
  - Design
    Design
    
    Architectural Decision Records (ADR)
    Architectural Decision Records (ADR)
    
    0001 Record Architectural Decisions
    
    0002 Change Cache Service Manager from Akka-Actor to ZLayer
    
    0003 Change IIIF Service Manager and Sipi implementation to zlayer
    
    0004 Change Triplestore Service Manager and Fuseki implementation to ZLayer
    
    0005 Change ResponderManager to a simple case class
    
    0006 Gradually Replace Akka-HTTP with ZIO-HTTP
    
    0007 ZIO-fication of Responders
    
    0008 Replace Akka with Pekko
    
    DSP-API Design Principles
    DSP-API Design Principles
    
    Design Overview
    
    Store Module
    
    Triplestore Updates
    
    Consistency Checking
    
    Authentication
    
    RDF Processing API
    
    DSP-API V2 Design
    DSP-API V2 Design
    
    API v2 Design Overview
    
    Ontology Schemas
    
    Smart IRIs
    
    Content Wrappers
    
    How to Add an API v2 Route
    
    JSON-LD Parsing and Formatting
    
    Ontology Management
    
    DSP-API and Sipi
    
    Gravsearch Design
    
    Standoff Markup
    
    Archival Resource Key (ARK)
    
    SPARQL Query Design
    
    Admin API Design
    
    DSP Domain
    DSP Domain
    
    Domain Entities and Relations
    
    System Instances
    
    Class and Property Hierarchies
  - Development
    Development
    
    Overview
    
    Build and Running
    
    Setup Visual Studio Code for development of DSP-API
    
    Testing
    
    Docker Cheat Sheet
    
    Starting the DSP-Stack inside Docker Container
    
    Updating Repositories
    
    Third-Party Dependencies
- SIPI
  SIPI
  - Overview
  - Interaction between Sipi and DSP-API
- Lucene
  Lucene
  - Lucene Query Parser Syntax
- Frequently Asked Questions
- Release Notes
  Release Notes
  - Changelog
- Migration Guides and Deprecations
DSP-TOOLS
DSP-TOOLS
- Overview
- CLI commands
- File formats
  File formats
  - JSON project file
    JSON project file
    
    Overview
    
    Ontologies
    
    Caveats
  - XML data file
  - excel2json
  - excel2xml
- Incremental xmlupload
- excel2xml module
- Running DSP locally
- Information for developers
  Information for developers
  - Developers documentation
  - Dependencies, packaging & distribution
  - User data
  - MkDocs and markdown-link-validator
  - Code quality tools
    Code quality tools
    
    Overview
    
    General formatting
    
    Python formatting
    
    Python docstring formatting
    
    Python type checking
    
    Python linting
    
    Security checks
    
    See also
- Changelog
- xmllib API documentation
  xmllib API documentation
  - XMLRoot
  - Resource
  - DSP base resources
    DSP base resources
    
    RegionResource
    
    LinkResource
    
    VideoSegmentResource
    
    AudioSegmentResource
  - Configuration options
  - Value Checkers
  - Value Converters
  - Helpers
DSP-INGEST
DSP-INGEST
- Overview
  Overview
  - Introduction
  - Ingesting Assets
  - API documentation
    API documentation
    
    Projects Endpoints
    
    Monitoring Endpoints
    
    Maintenance Endpoints
    
    Authentication
  - Service documentation
    Service documentation
    
    Configuration
    
    Filesystem Setup
DSP-META
DSP-META
- DSP-META
- Metadata
  Metadata
- Code Documentation
  Code Documentation
Developers
Developers
- Getting Started
- Basics
  Basics
  - Introduction
  - RDF
  - Sipi
  - Libraries
- Contribution

Back-End

The back-end of the DSP Metadata Browser is built with Rust.

Info

More documentation will be added progressively.

September 20, 2024

Made with Material for MkDocs