summaryrefslogtreecommitdiff
path: root/opendc-api-spec.yml
diff options
context:
space:
mode:
authorGeorgios Andreadis <info@gandreadis.com>2020-07-08 16:21:29 +0200
committerFabian Mastenbroek <mail.fabianm@gmail.com>2020-08-24 19:47:59 +0200
commit37da1e52419075889ccd8e37279a32578462112a (patch)
tree6d73342f03ffb9f192b791d269f53f946029c43f /opendc-api-spec.yml
parent5d2ddb814da1fc299792fde2e09a04f600b25dd7 (diff)
parent0a1579e749663e872a53e25fa9fd26e209a9e019 (diff)
Merge pull request #7 from atlarge-research/feature/portfolio-scenario-endpoints
Portfolio and scenario endpoints
Diffstat (limited to 'opendc-api-spec.yml')
-rw-r--r--opendc-api-spec.yml62
1 files changed, 6 insertions, 56 deletions
diff --git a/opendc-api-spec.yml b/opendc-api-spec.yml
index ad9c91fc..aa78a84a 100644
--- a/opendc-api-spec.yml
+++ b/opendc-api-spec.yml
@@ -500,7 +500,7 @@ paths:
put:
tags:
- scenarios
- description: "Update this Scenario."
+ description: "Update this Scenario's name (other properties are read-only)."
parameters:
- name: scenarioId
in: path
@@ -509,7 +509,7 @@ paths:
type: string
- name: scenario
in: body
- description: Scenario's new properties.
+ description: Scenario with new name.
required: true
schema:
$ref: '#/definitions/Scenario'
@@ -550,7 +550,7 @@ paths:
/schedulers:
get:
tags:
- - experiments
+ - simulation
description: Get all available Schedulers
responses:
'200':
@@ -564,7 +564,7 @@ paths:
/traces:
get:
tags:
- - experiments
+ - simulation
description: Get all available Traces (non-populated).
responses:
'200':
@@ -583,7 +583,7 @@ paths:
'/traces/{traceId}':
get:
tags:
- - experiments
+ - simulation
description: Get this Trace.
parameters:
- name: traceId
@@ -703,22 +703,6 @@ paths:
description: Prefab not found.
definitions:
- MachineState:
- type: object
- properties:
- _id:
- type: string
- machineId:
- type: string
- experimentId:
- type: string
- tick:
- type: integer
- inUseMemoryMb:
- type: integer
- loadFraction:
- type: number
- format: float
Prefab:
type: object
properties:
@@ -732,38 +716,6 @@ definitions:
datetimeLastEdited:
type: string
format: dateTime
- RackState:
- type: object
- properties:
- _id:
- type: string
- rackId:
- type: string
- experimentId:
- type: string
- tick:
- type: integer
- inUseMemoryMb:
- type: integer
- loadFraction:
- type: number
- format: float
- RoomState:
- type: object
- properties:
- _id:
- type: string
- roomId:
- type: string
- experimentId:
- type: string
- tick:
- type: integer
- inUseMemoryMb:
- type: integer
- loadFraction:
- type: number
- format: float
Scheduler:
type: object
properties:
@@ -786,7 +738,7 @@ definitions:
type: array
items:
type: string
- experimentIds:
+ portfolioIds:
type: array
items:
type: string
@@ -886,8 +838,6 @@ definitions:
type: string
name:
type: string
- type:
- type: string
scenarioIds:
type: array
items: