Skip to content
This repository has been archived by the owner on Mar 30, 2021. It is now read-only.
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: ga4gh-beacon/beacon-network-specification
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: develop
Choose a base ref
...
head repository: EbiEga/beacon-network-specification
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: develop
Choose a head ref
Able to merge. These branches can be automatically merged.
  • 4 commits
  • 1 file changed
  • 1 contributor

Commits on Sep 7, 2018

  1. Added API Key to Beacon requests

    Saif Ur-Rehman committed Sep 7, 2018
    Copy the full SHA
    07bf570 View commit details

  2. Added API Key to Beacon requests

    Saif Ur-Rehman committed Sep 7, 2018
    Copy the full SHA
    509cc0c View commit details

  3. Added API Key to Beacon requests

    Saif Ur-Rehman committed Sep 7, 2018
    Copy the full SHA
    055dba3 View commit details

  4. Switched response to query to harmonise endpoints between the network… 

    … and the individual beacons
    Saif Ur-Rehman committed Sep 7, 2018
    Copy the full SHA
    fa02828 View commit details
Showing with 40 additions and 12 deletions.
  1. +40 −12 swagger.yaml
52 changes: 40 additions & 12 deletions swagger.yaml
View file
Original file line number Diff line number Diff line change
@@ -1,20 +1,26 @@
---
swagger: "2.0"
info:
version: "1.0-SNAPSHOT"
version: "1"
title: "Beacon Network API"
termsOfService: "http://localhost:8080/#/terms"
host: "localhost:8080"
basePath: "/api"
# host: "localhost:8080"
# basePath: "/api"
tags:
- name: "Alleles"
- name: "Beacons"
- name: "Chromosomes"
- name: "Organizations"
- name: "References"
- name: "Responses"
schemes:
- "http"
# schemes:
# - "http"
securityDefinitions:
# X-API-Key: abcdef12345
APIKeyHeader:
type: apiKey
in: header
name: beacon_api_key
# /path?beacon_api_key=abcdef12345
paths:
/alleles:
get:
@@ -26,6 +32,8 @@ paths:
produces:
- "application/xml"
- "application/json"
security:
- APIKeyHeader: []
parameters: []
responses:
200:
@@ -54,6 +62,8 @@ paths:
produces:
- "application/xml"
- "application/json"
security:
- APIKeyHeader: []
parameters:
- name: "beacon"
in: "query"
@@ -93,6 +103,8 @@ paths:
produces:
- "application/xml"
- "application/json"
security:
- APIKeyHeader: []
parameters:
- name: "beaconId"
in: "path"
@@ -122,10 +134,12 @@ paths:
- "Chromosomes"
summary: "List all chromosomes"
description: "Lists all the supported chromosomes in their canonical form."
operationId: "showAll"
operationId: "showAll_1"
produces:
- "application/xml"
- "application/json"
security:
- APIKeyHeader: []
parameters: []
responses:
200:
@@ -166,13 +180,15 @@ paths:
- "Organizations"
summary: "List organizations"
description: "Lists organizations."
operationId: "show"
operationId: "showOrganization"
consumes:
- "application/xml"
- "application/json"
produces:
- "application/xml"
- "application/json"
security:
- APIKeyHeader: []
parameters:
- name: "organization"
in: "query"
@@ -205,13 +221,15 @@ paths:
- "Organizations"
summary: "Find organization by ID"
description: "Finds organization with the given ID."
operationId: "showOrganization"
operationId: "showOrganization_"
consumes:
- "application/xml"
- "application/json"
produces:
- "application/xml"
- "application/json"
security:
- APIKeyHeader: []
parameters:
- name: "organizationId"
in: "path"
@@ -242,7 +260,7 @@ paths:
summary: "List all references"
description: "Lists all the supported references in their canonical form (hg-based\
\ notation)."
operationId: "showAll"
operationId: "showAll_2"
produces:
- "application/xml"
- "application/json"
@@ -260,7 +278,7 @@ paths:
- "HG18"
- "HG17"
- "HG16"
/responses:
/query:
get:
tags:
- "Responses"
@@ -273,6 +291,8 @@ paths:
produces:
- "application/xml"
- "application/json"
security:
- APIKeyHeader: []
parameters:
- name: "beacon"
in: "query"
@@ -331,7 +351,7 @@ paths:
description: "internal server error"
schema:
$ref: "#/definitions/Error"
/responses/{beaconId}:
/query/{beaconId}:
get:
tags:
- "Responses"
@@ -344,6 +364,8 @@ paths:
produces:
- "application/xml"
- "application/json"
security:
- APIKeyHeader: []
parameters:
- name: "beaconId"
in: "path"
@@ -592,3 +614,9 @@ definitions:
- "HG16"
xml:
name: "query"
# Added by API Auto Mocking Plugin
host: virtserver.swaggerhub.com
basePath: /EMBL-EBI/network/1
schemes:
- https
- http