Skip to content

Latest commit

 

History

History
35 lines (29 loc) · 2.8 KB

settings.rst

File metadata and controls

35 lines (29 loc) · 2.8 KB
Raw

Settings

The settings of RESTable are set in the file `settings.yaml'.

The schema of this file is the following:

Field Type Description Example Required
port Integer Port where the interface is waiting for request. 9999 True
debug Boolean Activates the debug. True False
project String Project name ASTRID
True
title String Title of the service. RESTable Test True
description String Description of the service True
commands Dictionary1 Available commands False
configurations Dictionary2 Available configurations False
parameters Dictionary3 Available parameters False

  1. Key: command ID (String), value: commands-settings-model.↩

  2. Key: configuration ID (String), value: configurations-settings-model.↩

  3. Key: parameter ID (String), value: parameters-settings-model.↩