node/doc/openapi/openapi.yaml at master · VILLASframework/node · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
# SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
# SPDX-License-Identifier: Apache-2.0
---
openapi: 3.1.0

info:
  title: VILLASnode API
  version: 0.10.0

  description: >-
    A HTTP/REST API for controlling VILLASnode remotely without the need to
    restart the daemon.
  termsOfService: 'https://www.fein-aachen.org/projects/villas-node/'

  contact:
    name: Steffen Vogel
    email: post@steffenvogel.de
    url: 'https://fein-aachen.org/contact/'

  license:
    name: Apache-2.0
    url: 'https://www.apache.org/licenses/LICENSE-2.0'

externalDocs:
  url: 'https://villas.fein-aachen.org/doc/node.html'

servers:
- url: 'https://villas.k8s.eonerc.rwth-aachen.de/api/v2'
  description: The production API server in our EONERC OpenStack Kubernetes

- url: 'http://localhost:8080'
  description: Your local host

tags:
- name: super-node
  x-displayName: Super Node
  description: Global super-node related operations.

- name: nodes
  x-displayName: Nodes
  description: Node related operations.

- name: paths
  x-displayName: Paths
  description: Path related operations.

- name: config
  x-displayName: VILLASnode configuration file
  description: |
    This section decribes the schema of the VILLASnode configuration file.
    Please use the `>` to expand the individual sub-sections.

    <SchemaDefinition schemaRef="#/components/schemas/config" />

- name: format-edgeflex
  x-displayName: Edgeflex Format
  description: |
    <SchemaDefinition schemaRef="#/components/schemas/FormatEdgeflex" />

- name: format-igor
  x-displayName: Igor's Format
  description: |
    <SchemaDefinition schemaRef="#/components/schemas/FormatIgor" />

- name: format-sogno
  x-displayName: SOGNO Format
  description: |
    <SchemaDefinition schemaRef="#/components/schemas/FormatSogno" />

- name: format-sogno-old
  x-displayName: Old SOGNO Format
  description: |
    <SchemaDefinition schemaRef="#/components/schemas/FormatSognoOld" />

x-tagGroups:
- name: VILLASnode APIs
  tags:
  - super-node
  - nodes
  - paths

- name: Configuration Files
  tags:
  - config

- name: Format Schemas
  tags:
  - format-edgeflex
  - format-igor
  - format-sogno
  - format-sogno-old

paths:
  /status:
    $ref: paths/status.yaml
  /capabilities:
    $ref: paths/capabilities.yaml
  /config:
    $ref: paths/config.yaml
  /restart:
    $ref: paths/restart.yaml
  /shutdown:
    $ref: paths/shutdown.yaml
  /nodes:
    $ref: paths/nodes.yaml
  '/node/{uuid-or-name}':
    $ref: 'paths/node/node@{uuid-or-name}.yaml'
  '/node/{uuid-or-name}/stats':
    $ref: 'paths/node/node@{uuid-or-name}@stats.yaml'
  '/node/{uuid-or-name}/stats/reset':
    $ref: 'paths/node/node@{uuid-or-name}@stats@reset.yaml'
  '/node/{uuid-or-name}/start':
    $ref: 'paths/node/node@{uuid-or-name}@start.yaml'
  '/node/{uuid-or-name}/stop':
    $ref: 'paths/node/node@{uuid-or-name}@stop.yaml'
  '/node/{uuid-or-name}/pause':
    $ref: 'paths/node/node@{uuid-or-name}@pause.yaml'
  '/node/{uuid-or-name}/resume':
    $ref: 'paths/node/node@{uuid-or-name}@resume.yaml'
  '/node/{uuid-or-name}/restart':
    $ref: 'paths/node/node@{uuid-or-name}@restart.yaml'
  '/node/{uuid-or-name}/file/rewind':
    $ref: 'paths/node/node@{uuid-or-name}@file@rewind.yaml'
  '/node/{uuid-or-name}/file/seek':
    $ref: 'paths/node/node@{uuid-or-name}@file@seek.yaml'
  /paths:
    $ref: paths/paths.yaml
  '/path/{uuid}':
    $ref: 'paths/path/path@{uuid}.yaml'
  '/path/{uuid}/start':
    $ref: 'paths/path/path@{uuid}@start.yaml'
  '/path/{uuid}/stop':
    $ref: 'paths/path/path@{uuid}@stop.yaml'
  '/graph.{format}':
    $ref: 'paths/graph.{format}.yaml'

components:
  schemas:
    Config:
      $ref: components/schemas/config.yaml
    FormatEdgeflex:
      $ref: components/schemas/formats/edgeflex.yaml
    FormatIgor:
      $ref: components/schemas/formats/igor.yaml
    FormatSognoOld:
      $ref: components/schemas/formats/sogno-old.yaml
    FormatSogno:
      $ref: components/schemas/formats/sogno.yaml