Skip to content
Snippets Groups Projects
Commit 5a28e90b authored by Simon Oehrl's avatar Simon Oehrl
Browse files

Update swagger.yaml

parent c4b04658
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
access_node/swagger/swagger.yaml
+ 27
− 221
View file @ 5a28e90b
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
swagger: "2.0" swagger: "2.0"
info: info:
description: "This is the REST API for the in-situ pipeline." description: "This is the REST API for the in-situ pipeline."
version: "0.0.2" version: "1.0.0"
title: "In-Situ Pipeline REST API" title: "In-Situ Pipeline REST API"
host: "localhost" host: "localhost"
basePath: "/" basePath: "/"
...@@ -10,12 +10,12 @@ schemes: ...@@ -10,12 +10,12 @@ schemes:
- "https" - "https"
- "http" - "http"
paths: paths:
/info: /timestep:
get: get:
tags: tags:
- "nest" - "nest"
summary: "Retrieves general simulation information." summary: "Retrieves the time between two simulation steps."
operationId: "get_info" operationId: "get_timestep"
produces: produces:
- "application/json" - "application/json"
parameters: [] parameters: []
...@@ -23,18 +23,19 @@ paths: ...@@ -23,18 +23,19 @@ paths:
200: 200:
description: "Operation successful." description: "Operation successful."
schema: schema:
$ref: "#/definitions/Info" type: "number"
format: "double"
400: 400:
description: "Operation failed." description: "Operation failed."
schema: schema:
$ref: "#/definitions/Error" $ref: "#/definitions/Error"
x-swagger-router-controller: "access_node.controllers.nest_controller" x-swagger-router-controller: "access_node.controllers.nest_controller"
/current_simulation_time: /simulation_step_count:
get: get:
tags: tags:
- "nest" - "nest"
summary: "Retrieves the current simulation time." summary: "Retrieves the number of simulation steps."
operationId: "get_current_simulation_time" operationId: "get_simulation_step_count"
produces: produces:
- "application/json" - "application/json"
parameters: [] parameters: []
...@@ -43,18 +44,18 @@ paths: ...@@ -43,18 +44,18 @@ paths:
description: "Operation successful." description: "Operation successful."
schema: schema:
type: "number" type: "number"
format: "double" format: "int64"
400: 400:
description: "Operation failed." description: "Operation failed."
schema: schema:
$ref: "#/definitions/Error" $ref: "#/definitions/Error"
x-swagger-router-controller: "access_node.controllers.nest_controller" x-swagger-router-controller: "access_node.controllers.nest_controller"
/neuron_ids: /gids:
get: get:
tags: tags:
- "nest" - "nest"
summary: "Retrieves the list of all neuron IDs." summary: "Retrieves the list of all neuron IDs."
operationId: "get_neuron_ids" operationId: "get_gids"
produces: produces:
- "application/json" - "application/json"
parameters: [] parameters: []
...@@ -71,82 +72,6 @@ paths: ...@@ -71,82 +72,6 @@ paths:
schema: schema:
$ref: "#/definitions/Error" $ref: "#/definitions/Error"
x-swagger-router-controller: "access_node.controllers.nest_controller" x-swagger-router-controller: "access_node.controllers.nest_controller"
/multimeters:
get:
tags:
- "nest"
summary: "Retrieves the details of all multimeters."
operationId: "get_multimeters"
produces:
- "application/json"
parameters: []
responses:
200:
description: "Operation successful."
schema:
type: "array"
items:
$ref: "#/definitions/MultimeterInfo"
400:
description: "Operation failed."
schema:
$ref: "#/definitions/Error"
x-swagger-router-controller: "access_node.controllers.nest_controller"
/data:
get:
tags:
- "nest"
summary: "Retrieves the per-neuron attributes for the given multimeter name,\
\ attribute name, duration (from - to) (optional) and neuron IDs (optional)."
operationId: "get_data"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- name: "multimeter"
in: "query"
description: "Multimeter name."
required: true
type: "string"
- name: "attribute"
in: "query"
description: "Attribute name."
required: true
type: "string"
- name: "from"
in: "query"
description: "First timestep to retreive (leave empty for first step possible)."
required: false
type: "number"
collectionFormat: "multi"
format: "double"
- name: "to"
in: "query"
description: "Last timestep to retreive (leave empty for last step possible)."
required: false
type: "number"
collectionFormat: "multi"
format: "double"
- name: "neuron_ids"
in: "query"
description: "Neuron IDs (leave empty for all neurons)."
required: false
type: "array"
items:
type: "number"
format: "int64"
collectionFormat: "multi"
responses:
200:
description: "Operation successful."
schema:
$ref: "#/definitions/Multimeter"
400:
description: "Operation failed."
schema:
$ref: "#/definitions/Error"
x-swagger-router-controller: "access_node.controllers.nest_controller"
/spikes: /spikes:
get: get:
tags: tags:
...@@ -159,24 +84,18 @@ paths: ...@@ -159,24 +84,18 @@ paths:
produces: produces:
- "application/json" - "application/json"
parameters: parameters:
- name: "simulation_steps" - name: "from"
in: "query" in: "query"
description: "Simulation steps (leave empty for all steps)." description: "TODO"
required: false required: false
type: "array" type: "number"
items: format: "int64"
type: "number" - name: "to"
format: "int64"
collectionFormat: "multi"
- name: "neuron_ids"
in: "query" in: "query"
description: "Neuron IDs (leave empty for all neurons)." description: "TODO"
required: false required: false
type: "array" type: "number"
items: format: "int64"
type: "number"
format: "int64"
collectionFormat: "multi"
responses: responses:
200: 200:
description: "Operation successful." description: "Operation successful."
...@@ -188,137 +107,24 @@ paths: ...@@ -188,137 +107,24 @@ paths:
$ref: "#/definitions/Error" $ref: "#/definitions/Error"
x-swagger-router-controller: "access_node.controllers.nest_controller" x-swagger-router-controller: "access_node.controllers.nest_controller"
definitions: definitions:
Precision:
type: "string"
enum:
- "double"
- "integer"
Attribute:
type: "object"
properties:
name:
type: "string"
precision:
$ref: "#/definitions/Precision"
example:
precision: {}
name: "name"
Multimeter:
type: "object"
properties:
name:
type: "string"
interval:
type: "number"
format: "double"
attribute:
$ref: "#/definitions/Attribute"
measurement_times:
type: "array"
items:
type: "number"
format: "double"
from:
type: "number"
format: "double"
to:
type: "number"
format: "double"
neuron_ids:
type: "array"
items:
type: "number"
format: "int64"
values:
type: "array"
items:
type: "array"
items:
type: "number"
example:
name: "Multimeter_name"
interval: 0.2
attribute:
name: "voltage"
precission: "double"
timesteps:
- 1.2
- 1.4
from: 1.2
to: 1.4
neuron_ids:
- 1
- 2
values:
- - 61.48
- 45.23
- - 13.46
- 23.77
MultimeterInfo:
type: "object"
properties:
name:
type: "string"
interval:
type: "number"
format: "double"
attributes:
type: "array"
items:
$ref: "#/definitions/Attribute"
example:
name: "name"
interval: 0.1
attributes:
- precision: {}
name: "name"
- precision: {}
name: "name"
Info:
type: "object"
properties:
simulation_resolution:
type: "number"
format: "double"
multimeters:
type: "array"
items:
$ref: "#/definitions/MultimeterInfo"
example:
simulation_resolution: 0.01
multimeters:
- name: "name"
interval: 0.1
attributes:
- precision: {}
name: "name"
- precision: {}
name: "name"
- name: "name"
interval: 0.2
attributes:
- precision: {}
name: "name"
- precision: {}
name: "name"
Spikes: Spikes:
type: "object" type: "object"
properties: properties:
simulation_times: simulation_steps:
type: "array" type: "array"
items: items:
type: "number" type: "number"
format: "int64" format: "int64"
neuron_ids: gids:
type: "array" type: "array"
items: items:
type: "number" type: "number"
format: "int64" format: "int64"
example: example:
simulation_times: simulation_steps:
- 0.2 - 2
- 0.3 - 5
neuron_ids: gids:
- 1 - 1
- 2 - 2
Error: Error:
...@@ -327,4 +133,4 @@ definitions: ...@@ -327,4 +133,4 @@ definitions:
code: code:
type: "number" type: "number"
message: message:
type: "string" type: "string"
\ No newline at end of file
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment