dev ---> master: documentation von datenmodellen #1
5
code/python/.gitignore
vendored
5
code/python/.gitignore
vendored
@ -26,6 +26,11 @@
|
||||
!/models/*-schema.yaml
|
||||
!/models/README.md
|
||||
|
||||
!/docs
|
||||
!/docs/*/
|
||||
!/docs/*/Models/
|
||||
!/docs/**/*.md
|
||||
|
||||
!/tests
|
||||
!/tests/**/
|
||||
!/tests/**/*.py
|
||||
|
9
code/python/docs/commands/Models/Command.md
Normal file
9
code/python/docs/commands/Models/Command.md
Normal file
@ -0,0 +1,9 @@
|
||||
# Command
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | [**EnumAlgorithmNames**](EnumAlgorithmNames.md) | | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
12
code/python/docs/commands/Models/CommandHirschberg.md
Normal file
12
code/python/docs/commands/Models/CommandHirschberg.md
Normal file
@ -0,0 +1,12 @@
|
||||
# CommandHirschberg
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | [**EnumAlgorithmNames**](EnumAlgorithmNames.md) | | [default to null]
|
||||
**word1** | [**String**](string.md) | Word that gets placed vertically in algorithm. | [default to null]
|
||||
**word2** | [**String**](string.md) | Word that gets placed horizontally in algorithm | [default to null]
|
||||
**once** | [**Boolean**](boolean.md) | | [optional] [default to false]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
11
code/python/docs/commands/Models/CommandTarjan.md
Normal file
11
code/python/docs/commands/Models/CommandTarjan.md
Normal file
@ -0,0 +1,11 @@
|
||||
# CommandTarjan
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | [**EnumAlgorithmNames**](EnumAlgorithmNames.md) | | [default to null]
|
||||
**nodes** | [**List**](anyOf<integer,number,string>.md) | | [default to null]
|
||||
**edges** | [**List**](array.md) | | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
11
code/python/docs/commands/Models/CommandTsp.md
Normal file
11
code/python/docs/commands/Models/CommandTsp.md
Normal file
@ -0,0 +1,11 @@
|
||||
# CommandTsp
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | [**EnumAlgorithmNames**](EnumAlgorithmNames.md) | | [default to null]
|
||||
**dist** | [**List**](array.md) | | [default to null]
|
||||
**optimise** | [**EnumTSPOptimise**](EnumTSPOptimise.md) | | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
8
code/python/docs/commands/Models/EnumAlgorithmNames.md
Normal file
8
code/python/docs/commands/Models/EnumAlgorithmNames.md
Normal file
@ -0,0 +1,8 @@
|
||||
# EnumAlgorithmNames
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
8
code/python/docs/commands/Models/EnumTSPOptimise.md
Normal file
8
code/python/docs/commands/Models/EnumTSPOptimise.md
Normal file
@ -0,0 +1,8 @@
|
||||
# EnumTSPOptimise
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
26
code/python/docs/commands/README.md
Normal file
26
code/python/docs/commands/README.md
Normal file
@ -0,0 +1,26 @@
|
||||
# Documentation for Schemata for command instructions
|
||||
|
||||
<a name="documentation-for-api-endpoints"></a>
|
||||
## Documentation for API Endpoints
|
||||
|
||||
All URIs are relative to *http://.*
|
||||
|
||||
Class | Method | HTTP request | Description
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
|
||||
<a name="documentation-for-models"></a>
|
||||
## Documentation for Models
|
||||
|
||||
- [Command](.//Models/Command.md)
|
||||
- [CommandHirschberg](.//Models/CommandHirschberg.md)
|
||||
- [CommandTarjan](.//Models/CommandTarjan.md)
|
||||
- [CommandTsp](.//Models/CommandTsp.md)
|
||||
- [EnumAlgorithmNames](.//Models/EnumAlgorithmNames.md)
|
||||
- [EnumTSPOptimise](.//Models/EnumTSPOptimise.md)
|
||||
|
||||
|
||||
<a name="documentation-for-authorization"></a>
|
||||
## Documentation for Authorization
|
||||
|
||||
All endpoints do not require authorization.
|
13
code/python/docs/config/Models/AppOptions.md
Normal file
13
code/python/docs/config/Models/AppOptions.md
Normal file
@ -0,0 +1,13 @@
|
||||
# AppOptions
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**logMinuslevel** | [**EnumLogLevel**](EnumLogLevel.md) | | [default to null]
|
||||
**verbose** | [**Boolean**](boolean.md) | Global setting for verbosity. | [optional] [default to false]
|
||||
**tarjan** | [**AppOptions_tarjan**](AppOptions_tarjan.md) | | [default to null]
|
||||
**tsp** | [**AppOptions_tarjan**](AppOptions_tarjan.md) | | [default to null]
|
||||
**hirschberg** | [**AppOptions_hirschberg**](AppOptions_hirschberg.md) | | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
13
code/python/docs/config/Models/AppOptionsHirschberg.md
Normal file
13
code/python/docs/config/Models/AppOptionsHirschberg.md
Normal file
@ -0,0 +1,13 @@
|
||||
# AppOptionsHirschberg
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**penalityMinusmismatch** | [**BigDecimal**](number.md) | | [default to 1]
|
||||
**penalityMinusgap** | [**BigDecimal**](number.md) | | [default to 1]
|
||||
**moveMinuspriorities** | [**AppOptions_hirschberg_move_priorities**](AppOptions_hirschberg_move_priorities.md) | | [default to null]
|
||||
**verbose** | [**List**](EnumHirschbergVerbosity.md) | | [optional] [default to []]
|
||||
**show** | [**List**](EnumHirschbergShow.md) | | [optional] [default to []]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
@ -0,0 +1,11 @@
|
||||
# AppOptionsHirschbergMovePriorities
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**diagonal** | [**Integer**](integer.md) | | [optional] [default to 0]
|
||||
**horizontal** | [**Integer**](integer.md) | | [optional] [default to 1]
|
||||
**vertical** | [**Integer**](integer.md) | | [optional] [default to 2]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
9
code/python/docs/config/Models/AppOptionsTarjan.md
Normal file
9
code/python/docs/config/Models/AppOptionsTarjan.md
Normal file
@ -0,0 +1,9 @@
|
||||
# AppOptionsTarjan
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**verbose** | [**Boolean**](boolean.md) | | [default to false]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
10
code/python/docs/config/Models/Config.md
Normal file
10
code/python/docs/config/Models/Config.md
Normal file
@ -0,0 +1,10 @@
|
||||
# Config
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**info** | [**Info**](Info.md) | | [default to null]
|
||||
**options** | [**AppOptions**](AppOptions.md) | | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
8
code/python/docs/config/Models/EnumHirschbergShow.md
Normal file
8
code/python/docs/config/Models/EnumHirschbergShow.md
Normal file
@ -0,0 +1,8 @@
|
||||
# EnumHirschbergShow
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
@ -0,0 +1,8 @@
|
||||
# EnumHirschbergVerbosity
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
8
code/python/docs/config/Models/EnumLogLevel.md
Normal file
8
code/python/docs/config/Models/EnumLogLevel.md
Normal file
@ -0,0 +1,8 @@
|
||||
# EnumLogLevel
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
11
code/python/docs/config/Models/Info.md
Normal file
11
code/python/docs/config/Models/Info.md
Normal file
@ -0,0 +1,11 @@
|
||||
# Info
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**title** | [**String**](string.md) | | [default to null]
|
||||
**description** | [**String**](string.md) | | [default to null]
|
||||
**author** | [**String**](string.md) | | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
29
code/python/docs/config/README.md
Normal file
29
code/python/docs/config/README.md
Normal file
@ -0,0 +1,29 @@
|
||||
# Documentation for Schemata for config models
|
||||
|
||||
<a name="documentation-for-api-endpoints"></a>
|
||||
## Documentation for API Endpoints
|
||||
|
||||
All URIs are relative to *http://.*
|
||||
|
||||
Class | Method | HTTP request | Description
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
|
||||
<a name="documentation-for-models"></a>
|
||||
## Documentation for Models
|
||||
|
||||
- [AppOptions](.//Models/AppOptions.md)
|
||||
- [AppOptionsHirschberg](.//Models/AppOptionsHirschberg.md)
|
||||
- [AppOptionsHirschbergMovePriorities](.//Models/AppOptionsHirschbergMovePriorities.md)
|
||||
- [AppOptionsTarjan](.//Models/AppOptionsTarjan.md)
|
||||
- [Config](.//Models/Config.md)
|
||||
- [EnumHirschbergShow](.//Models/EnumHirschbergShow.md)
|
||||
- [EnumHirschbergVerbosity](.//Models/EnumHirschbergVerbosity.md)
|
||||
- [EnumLogLevel](.//Models/EnumLogLevel.md)
|
||||
- [Info](.//Models/Info.md)
|
||||
|
||||
|
||||
<a name="documentation-for-authorization"></a>
|
||||
## Documentation for Authorization
|
||||
|
||||
All endpoints do not require authorization.
|
Loading…
Reference in New Issue
Block a user