Last active
August 29, 2015 14:25
-
-
Save waltermoreira/c8ea8b2a3ef2fe96282e to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "basePath": "/community/v0.3/ichezhia-dev/gene_by_geneid_v0.2.1", | |
| "definitions": { | |
| "Generic": { | |
| "properties": { | |
| "message": { | |
| "description": "Human readable message", | |
| "type": "string" | |
| }, | |
| "result": { | |
| "description": "Result", | |
| "type": "object" | |
| }, | |
| "status": { | |
| "description": "Status of response", | |
| "enum": [ | |
| "success", | |
| "error" | |
| ], | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "Health": { | |
| "properties": { | |
| "queue_size": { | |
| "description": "Number of queued requests for this service that have not been processed yet (lower is better)", | |
| "type": "integer" | |
| }, | |
| "status": { | |
| "description": "Status of response", | |
| "enum": [ | |
| "success", | |
| "error" | |
| ], | |
| "type": "string" | |
| }, | |
| "total_workers": { | |
| "description": "Total number of workers assigned to this service (higher is better)", | |
| "type": "integer" | |
| }, | |
| "workers_free": { | |
| "description": "Number of workers ready to process requests for this service (higher is better)", | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "Stats": { | |
| "properties": { | |
| "status": { | |
| "description": "Status of response", | |
| "enum": [ | |
| "success", | |
| "error" | |
| ], | |
| "type": "string" | |
| }, | |
| "total_access": { | |
| "description": "Total number of access to the service", | |
| "type": "integer" | |
| }, | |
| "unique_access": { | |
| "description": "Number of unique ip's accessing the service", | |
| "type": "integer" | |
| }, | |
| "users": { | |
| "description": "Number of unique users accessing the service", | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "host": "api.araport.org", | |
| "info": { | |
| "description": "Araport API that serves basic information about genes.", | |
| "title": "Adapter: gene_by_geneid v0.2.1", | |
| "version": "0.2.1" | |
| }, | |
| "paths": { | |
| "/health": { | |
| "get": { | |
| "description": "Get an estimation of the health of a service by counting available workers to process requests", | |
| "operationId": "health_get", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "successful response", | |
| "schema": { | |
| "$ref": "#/definitions/Health" | |
| } | |
| } | |
| }, | |
| "summary": "Service health" | |
| } | |
| }, | |
| "/icon": { | |
| "get": { | |
| "description": "Retrieve a PNG with an icon for the service", | |
| "operationId": "icon_get", | |
| "parameters": [], | |
| "produces": [ | |
| "image/png" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "successful response", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "summary": "Get service icon" | |
| } | |
| }, | |
| "/list": { | |
| "get": { | |
| "description": "Returns a list of all valid GeneIDs.", | |
| "operationId": "list_get", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "successful response", | |
| "schema": { | |
| "$ref": "#/definitions/Generic" | |
| } | |
| } | |
| }, | |
| "summary": "List" | |
| } | |
| }, | |
| "/prov": { | |
| "get": { | |
| "description": "Get static provenance for the service", | |
| "operationId": "prov_get", | |
| "parameters": [ | |
| { | |
| "enum": [ | |
| "json", | |
| "prov", | |
| "prov-n", | |
| "png" | |
| ], | |
| "in": "query", | |
| "name": "format", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json", | |
| "image/png", | |
| "text/provenance-notation" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "successful response", | |
| "schema": {} | |
| } | |
| }, | |
| "summary": "Get provenance" | |
| } | |
| }, | |
| "/search": { | |
| "get": { | |
| "description": "Returns information on a specific GeneID.", | |
| "operationId": "search_get", | |
| "parameters": [ | |
| { | |
| "default": "AT4G34260", | |
| "description": "Enter a geneID to perform a single gene search.", | |
| "in": "query", | |
| "name": "Identifier", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Gene ID to return information for.", | |
| "enum": [ | |
| "both", | |
| "chromosomeLocation.end", | |
| "chromosomeLocation.start" | |
| ], | |
| "in": "query", | |
| "name": "Output", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "successful response", | |
| "schema": { | |
| "$ref": "#/definitions/Generic" | |
| } | |
| } | |
| }, | |
| "summary": "Search" | |
| } | |
| }, | |
| "/stats": { | |
| "get": { | |
| "description": "Get access statistics for the service", | |
| "operationId": "stats_get", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "successful response", | |
| "schema": { | |
| "$ref": "#/definitions/Stats" | |
| } | |
| } | |
| }, | |
| "summary": "Get statistics" | |
| } | |
| } | |
| }, | |
| "schemes": [ | |
| "https" | |
| ], | |
| "swagger": "2.0" | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment