How ga4gh/ga4gh-schemas works
Main Components
a. Schema Definition Layer
• Protocol Buffers (.proto files) in src/main/proto/ga4gh/
• Core data models for genomics data
• Service definitions for each data type
b. Generated Code Layer
• Python implementations (python/ga4gh/schemas/ga4gh/)
• Protocol buffer generated classes
• Service interfaces
c. Documentation System
• Sphinx documentation engine
• API documentation
• RST source files
d. Build & Testing Infrastructure
• Maven build system (pom.xml)
• Python testing framework
• Travis CI integration
┌─────────────────────────────────────────────┐
• Client Applications │
• ┘
• ↓
┌─────────────────────────────────────────────┐
• Service Definitions │
• Read Service - Variant Service │
• Reference Service - Metadata Service │
• Annotation Service - Bio Metadata │
• ┘
• ↓
┌─────────────────────────────────────────────┐
• Data Models │
• Reads - Variants │
• References - Annotations │
• Common - Metadata │
• ┘
• ↓
┌─────────────────────────────────────────────┐
• Protocol Buffer Definitions │
• ┘
Implementation Details to Highlight
• Protocol Buffer message definitions
• Service interface definitions
• Generated language bindings
• Documentation generation flow
• Test infrastructure
Additional Elements
• Documentation generation process
• Test coverage and validation flow
• Extension points for implementers
The documentation system integration
Keep the focus on the schema definition and code generation aspects, as this is primarily a protocol definition project rather than an implementation project.