1
0
Fork 0
mirror of https://git.rwth-aachen.de/acs/public/villas/node/ synced 2025-03-09 00:00:00 +01:00
VILLASnode/doc/openapi/paths/restart.yaml
Steffen Vogel 626e77557a Apply suggestions from Philipps code review
Co-authored-by: Philipp Jungkamp <56401138+PJungkamp@users.noreply.github.com>
Signed-off-by: Steffen Vogel <steffen.vogel@opal-rt.com>
2023-09-07 11:16:04 +02:00

40 lines
1.3 KiB
YAML

# 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
---
post:
operationId: restart
summary: Restart the VILLASnode instance.
tags:
- super-node
requestBody:
required: false
content:
application/json:
schema:
type: object
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: ../components/schemas/config.yaml
responses:
'200':
description: Success. The instance has been restarted.
content:
application/json:
examples:
example1:
value:
restarts: 5
config: 'http://example.com/path/to/config.json'
'400':
description: Failure