Skip to content
Snippets Groups Projects
Commit c83381a2 authored by J.Müller's avatar J.Müller
Browse files

Update Rest api

parent 75b1a40a
No related branches found
No related tags found
1 merge request!6Feature/fix neuron properties
Show whitespace changes
Inline Side-by-side
access_node/swagger/swagger.yaml
+ 53
− 31
View file @ c83381a2
...@@ -77,7 +77,7 @@ paths: ...@@ -77,7 +77,7 @@ paths:
get: get:
tags: tags:
- "arbor" - "arbor"
summary: "Retrieves the list of all cell ids." summary: "Retrieves a list of all cell ids."
operationId: "arbor_get_cell_ids" operationId: "arbor_get_cell_ids"
produces: produces:
- "application/json" - "application/json"
...@@ -90,6 +90,9 @@ paths: ...@@ -90,6 +90,9 @@ paths:
items: items:
type: "integer" type: "integer"
format: "uint64" format: "uint64"
example:
- 1
- 2
400: 400:
description: "Operation failed." description: "Operation failed."
schema: schema:
...@@ -100,7 +103,7 @@ paths: ...@@ -100,7 +103,7 @@ paths:
get: get:
tags: tags:
- "arbor" - "arbor"
summary: "Retrieves the list of all probes for a given attribute (optional)." summary: "Retrieves a list of all probes for a given attribute (optional)."
operationId: "arbor_get_probes" operationId: "arbor_get_probes"
produces: produces:
- "application/json" - "application/json"
...@@ -127,7 +130,7 @@ paths: ...@@ -127,7 +130,7 @@ paths:
get: get:
tags: tags:
- "arbor" - "arbor"
summary: "Retrieves the list of all attributes." summary: "Retrieves a list of all attributes."
operationId: "arbor_get_attributes" operationId: "arbor_get_attributes"
produces: produces:
- "application/json" - "application/json"
...@@ -161,7 +164,7 @@ paths: ...@@ -161,7 +164,7 @@ paths:
parameters: parameters:
- name: "attribute" - name: "attribute"
in: "query" in: "query"
description: "The attribute to query (e.g., 'V_m' for the membrane potential)" description: "The attribute to query"
required: true required: true
type: "string" type: "string"
- name: "probe_ids" - name: "probe_ids"
...@@ -192,7 +195,7 @@ paths: ...@@ -192,7 +195,7 @@ paths:
format: "uint64" format: "uint64"
- name: "limit" - name: "limit"
in: "query" in: "query"
description: "The maximum of entries to be result." description: "The maximum of entries to be returned."
required: false required: false
type: "integer" type: "integer"
format: "uint64" format: "uint64"
...@@ -211,7 +214,7 @@ paths: ...@@ -211,7 +214,7 @@ paths:
get: get:
tags: tags:
- "arbor" - "arbor"
summary: "Retrieves simulation time information." summary: "Retrieves simulation time information(begin, current, end)."
operationId: "arbor_get_simulation_time_info" operationId: "arbor_get_simulation_time_info"
produces: produces:
- "application/json" - "application/json"
...@@ -261,7 +264,7 @@ paths: ...@@ -261,7 +264,7 @@ paths:
get: get:
tags: tags:
- "nest" - "nest"
summary: "Retrieves simulation time information." summary: "Retrieves simulation time information (begin, current, end)."
operationId: "nest_get_simulation_time_info" operationId: "nest_get_simulation_time_info"
produces: produces:
- "application/json" - "application/json"
...@@ -281,7 +284,7 @@ paths: ...@@ -281,7 +284,7 @@ paths:
get: get:
tags: tags:
- "nest" - "nest"
summary: "Retrieves the list of all GID." summary: "Retrieves a list of all gids."
operationId: "nest_get_gids" operationId: "nest_get_gids"
produces: produces:
- "application/json" - "application/json"
...@@ -294,6 +297,11 @@ paths: ...@@ -294,6 +297,11 @@ paths:
items: items:
type: "integer" type: "integer"
format: "uint64" format: "uint64"
example:
- 1
- 2
- 3
- 15
400: 400:
description: "Operation failed." description: "Operation failed."
schema: schema:
...@@ -311,7 +319,7 @@ paths: ...@@ -311,7 +319,7 @@ paths:
parameters: parameters:
- name: "gids" - name: "gids"
in: "query" in: "query"
description: "A list of GIDs queried for properties." description: "A list of gids queried for properties."
required: false required: false
type: "array" type: "array"
items: items:
...@@ -334,7 +342,7 @@ paths: ...@@ -334,7 +342,7 @@ paths:
get: get:
tags: tags:
- "nest" - "nest"
summary: "Retrieves the list of all population IDs." summary: "Retrieves a list of all population IDs."
operationId: "nest_get_populations" operationId: "nest_get_populations"
produces: produces:
- "application/json" - "application/json"
...@@ -347,6 +355,10 @@ paths: ...@@ -347,6 +355,10 @@ paths:
items: items:
type: "integer" type: "integer"
format: "uint64" format: "uint64"
example:
- 1
- 2
- 3
400: 400:
description: "Operation failed." description: "Operation failed."
schema: schema:
...@@ -358,7 +370,7 @@ paths: ...@@ -358,7 +370,7 @@ paths:
tags: tags:
- "nest" - "nest"
summary: "Retrieves the spikes for the given simulation steps (optional) and\ summary: "Retrieves the spikes for the given simulation steps (optional) and\
\ GIDS (optional)." \ gids (optional)."
operationId: "nest_get_spikes" operationId: "nest_get_spikes"
consumes: consumes:
- "application/json" - "application/json"
...@@ -379,7 +391,7 @@ paths: ...@@ -379,7 +391,7 @@ paths:
format: "double" format: "double"
- name: "gids" - name: "gids"
in: "query" in: "query"
description: "A list of GIDs queried for spike data." description: "A list of gids queried for spike data."
required: false required: false
type: "array" type: "array"
items: items:
...@@ -393,7 +405,7 @@ paths: ...@@ -393,7 +405,7 @@ paths:
format: "uint64" format: "uint64"
- name: "limit" - name: "limit"
in: "query" in: "query"
description: "The maximum of entries to be result." description: "The maximum of entries to be returned."
required: false required: false
type: "integer" type: "integer"
format: "uint64" format: "uint64"
...@@ -446,7 +458,7 @@ paths: ...@@ -446,7 +458,7 @@ paths:
format: "uint64" format: "uint64"
- name: "limit" - name: "limit"
in: "query" in: "query"
description: "The maximum of entries to be result." description: "The maximum of entries to be returned."
required: false required: false
type: "integer" type: "integer"
format: "uint64" format: "uint64"
...@@ -487,7 +499,7 @@ paths: ...@@ -487,7 +499,7 @@ paths:
get: get:
tags: tags:
- "nest" - "nest"
summary: "Retrieves the measurements for a multimeter, attribute and GIDS (optional)." summary: "Retrieves the measurements for a multimeter, attribute and gids (optional)."
operationId: "nest_get_multimeter_measurements" operationId: "nest_get_multimeter_measurements"
consumes: consumes:
- "application/json" - "application/json"
...@@ -498,8 +510,8 @@ paths: ...@@ -498,8 +510,8 @@ paths:
in: "query" in: "query"
description: "The multimeter to query" description: "The multimeter to query"
required: true required: true
type: "number" type: "integer"
format: "integer" format: "uint64"
- name: "attribute" - name: "attribute"
in: "query" in: "query"
description: "The attribute to query (e.g., 'V_m' for the membrane potential)" description: "The attribute to query (e.g., 'V_m' for the membrane potential)"
...@@ -519,7 +531,7 @@ paths: ...@@ -519,7 +531,7 @@ paths:
format: "double" format: "double"
- name: "gids" - name: "gids"
in: "query" in: "query"
description: "A list of GIDs queried for spike data." description: "A list of gids queried for spike data."
required: false required: false
type: "array" type: "array"
items: items:
...@@ -552,7 +564,7 @@ paths: ...@@ -552,7 +564,7 @@ paths:
get: get:
tags: tags:
- "nest" - "nest"
summary: "Retrieves the list of all neuron IDs within the population." summary: "Retrieves the list of all neuron ids within the population."
operationId: "nest_get_gids_in_population" operationId: "nest_get_gids_in_population"
produces: produces:
- "application/json" - "application/json"
...@@ -571,6 +583,9 @@ paths: ...@@ -571,6 +583,9 @@ paths:
items: items:
type: "integer" type: "integer"
format: "uint64" format: "uint64"
example:
- 1
- 2
400: 400:
description: "Operation failed." description: "Operation failed."
schema: schema:
...@@ -594,11 +609,11 @@ definitions: ...@@ -594,11 +609,11 @@ definitions:
format: "uint64" format: "uint64"
example: example:
simulation_times: simulation_times:
- 0.8008281904610115 - 0.8
- 0.8008281904610115 - 0.9
gids: gids:
- 6.027456183070403 - 1
- 6.027456183070403 - 2
MultimeterInfo: MultimeterInfo:
type: "array" type: "array"
items: items:
...@@ -607,6 +622,10 @@ definitions: ...@@ -607,6 +622,10 @@ definitions:
- id: 0 - id: 0
attributes: attributes:
- "V_m" - "V_m"
gids:
- 1
- 2
- 3
MultimeterMeasurement: MultimeterMeasurement:
type: "object" type: "object"
properties: properties:
...@@ -724,7 +743,9 @@ definitions: ...@@ -724,7 +743,9 @@ definitions:
type: "object" type: "object"
properties: {} properties: {}
example: example:
population: "pop1" gid: 1
properties:
population: 2
position: position:
- 0.1 - 0.1
- 0.1 - 0.1
...@@ -742,9 +763,9 @@ definitions: ...@@ -742,9 +763,9 @@ definitions:
type: "number" type: "number"
format: "double" format: "double"
example: example:
current: 1.4658129805029452 current: 2.1
start: 0.8008281904610115 start: 0.1
end: 6.027456183070403 end: 4.5
MultimeterInfo_inner: MultimeterInfo_inner:
properties: properties:
id: id:
...@@ -759,3 +780,4 @@ definitions: ...@@ -759,3 +780,4 @@ definitions:
items: items:
type: "integer" type: "integer"
format: "uint64" format: "uint64"
\ No newline at end of file
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment