Template GA4GH Beacon API v1.0.0 Specification doc

mcupak · Mar 20, 2018 · 610c07b · 610c07b
1 parent 2a71542
commit 610c07b
Showing 1 changed file with 48 additions and 0 deletions.
diff --git a/beacon.md b/beacon.md
@@ -0,0 +1,48 @@
+# Beacon API Specification v1.0.0
+
+#### Name: Beacon
+#### Description: A Beacon is a web service for genetic data sharing that can be queried for information about specific alleles.
+
+#### Authors:
+- ...
+
+#### Publication Date: 
+#### Version: 1.0.0
+
+## Executive Summary
+
+## Document Scope 
+
+### Referenced External Standards
+- ADA-M [version]
+- Consent Codes [version]
+
+## Design Principles
+
+
+## API Protocol
+
+HTTP Transport Protocol...
+
+### Security...
+
+## Beacon API Methods
+
+
+
+## Beacon API Objects
+
+### 1. Beacon 
+
+### 2. BeaconOrganisation 
+
+### 3. BeaconDataset
+
+#### 4. BeaconAlleleRequest
+
+#### 5. BeaconAlleleResponse
+
+#### 5. BeaconDatasetAlleleDResponse
+
+
+## Beacon API Example