1
0
Fork 0
mirror of https://git.rwth-aachen.de/acs/public/villas/node/ synced 2025-03-16 00:00:02 +01:00
VILLASnode/doc/openapi/paths/node/node@{uuid-or-name}@file@seek.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

31 lines
942 B
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: seek-file-node
summary: Rewind the playback file to the beginning.
tags:
- nodes
parameters:
- $ref: ../../components/parameters/node-uuid-name.yaml
requestBody:
description: Sample position in file
required: true
content:
application/json:
schema:
type: object
required:
- position
properties:
position:
type: integer
example: 123
description: Skip the first nth samples in the file.
responses:
'200':
description: Success. The read-pointer of the file has been changed.
'404':
description: Error. There is no node with the given UUID.