1
0
Fork 0
mirror of https://git.rwth-aachen.de/acs/public/villas/node/ synced 2025-03-09 00:00:00 +01:00

fix openapi refs for API endpoints

This commit is contained in:
Steffen Vogel 2022-03-28 14:30:04 +02:00
parent 7da0733e47
commit e8d1d2e228
7 changed files with 24 additions and 12 deletions

View file

@ -58,8 +58,8 @@ properties:
Two modes are currently supported:
- `any``: The path will trigger the path as soon as any of the masked (see `mask`) input nodes received new samples.
- `all``: The path will trigger the path as soon as all input nodes received at least one new sample.
- `any`: The path will trigger the path as soon as any of the masked (see `mask`) input nodes received new samples.
- `all`: The path will trigger the path as soon as all input nodes received at least one new sample.
mask:
description: |

View file

@ -10,7 +10,7 @@ get:
content:
application/json:
schema:
$ref: '../openapi.yaml#/components/schemas/Config'
$ref: ../components/schemas/config.yaml
examples:
example1:
value:

View file

@ -11,6 +11,8 @@ get:
description: Success
content:
application/json:
schema:
$ref: ../../components/schemas/config/node_obj.yaml
examples:
example1:
value:

View file

@ -9,6 +9,10 @@ get:
content:
application/json:
examples:
schema:
type: array
items:
$ref: ../components/schemas/config/node_obj.yaml
example1:
value:
- name: udp_node1

View file

@ -10,6 +10,8 @@ post:
description: Success
content:
application/json:
schema:
$ref: ../../components/schemas/config/path.yaml
examples:
example1:
value:

View file

@ -8,6 +8,10 @@ get:
description: Success
content:
application/json:
schema:
type: array
items:
$ref: ../components/schemas/config/path.yaml
examples:
example1:
value:

View file

@ -12,15 +12,15 @@ post:
properties:
config:
oneOf:
- type: string
example: 'http://example.com/path/to/config.json'
title: URL
description: |
An optional path or URI to a new configuration file which
should be loaded after restarting the node.
The file referenced by the URL must be a [VILLASnode configuration file](#tag/config)
- $ref: '../openapi.yaml#/components/schemas/Config'
- type: string
example: 'http://example.com/path/to/config.json'
title: URL
description: |
An optional path or URI to a new configuration file which
should be loaded after restarting the node.
The file referenced by the URL must be a [VILLASnode configuration file](#tag/config)
- $ref: ../components/schemas/config.yaml
responses:
'200':
description: Success. The instance has been restarted.