diff --git a/code/python/.gitignore b/code/python/.gitignore index adea656..a2d60ed 100644 --- a/code/python/.gitignore +++ b/code/python/.gitignore @@ -26,6 +26,11 @@ !/models/*-schema.yaml !/models/README.md +!/docs +!/docs/*/ +!/docs/*/Models/ +!/docs/**/*.md + !/tests !/tests/**/ !/tests/**/*.py diff --git a/code/python/docs/commands/Models/Command.md b/code/python/docs/commands/Models/Command.md new file mode 100644 index 0000000..bf8f9e0 --- /dev/null +++ b/code/python/docs/commands/Models/Command.md @@ -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) + diff --git a/code/python/docs/commands/Models/CommandHirschberg.md b/code/python/docs/commands/Models/CommandHirschberg.md new file mode 100644 index 0000000..7f485dd --- /dev/null +++ b/code/python/docs/commands/Models/CommandHirschberg.md @@ -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) + diff --git a/code/python/docs/commands/Models/CommandTarjan.md b/code/python/docs/commands/Models/CommandTarjan.md new file mode 100644 index 0000000..4ba26b3 --- /dev/null +++ b/code/python/docs/commands/Models/CommandTarjan.md @@ -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) + diff --git a/code/python/docs/commands/Models/CommandTsp.md b/code/python/docs/commands/Models/CommandTsp.md new file mode 100644 index 0000000..ec644a1 --- /dev/null +++ b/code/python/docs/commands/Models/CommandTsp.md @@ -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) + diff --git a/code/python/docs/commands/Models/EnumAlgorithmNames.md b/code/python/docs/commands/Models/EnumAlgorithmNames.md new file mode 100644 index 0000000..7a4fb0c --- /dev/null +++ b/code/python/docs/commands/Models/EnumAlgorithmNames.md @@ -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) + diff --git a/code/python/docs/commands/Models/EnumTSPOptimise.md b/code/python/docs/commands/Models/EnumTSPOptimise.md new file mode 100644 index 0000000..7a902a6 --- /dev/null +++ b/code/python/docs/commands/Models/EnumTSPOptimise.md @@ -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) + diff --git a/code/python/docs/commands/README.md b/code/python/docs/commands/README.md new file mode 100644 index 0000000..42fb44b --- /dev/null +++ b/code/python/docs/commands/README.md @@ -0,0 +1,26 @@ +# Documentation for Schemata for command instructions + + +## Documentation for API Endpoints + +All URIs are relative to *http://.* + +Class | Method | HTTP request | Description +------------ | ------------- | ------------- | ------------- + + + +## 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) + + + +## Documentation for Authorization + +All endpoints do not require authorization. diff --git a/code/python/docs/config/Models/AppOptions.md b/code/python/docs/config/Models/AppOptions.md new file mode 100644 index 0000000..8015c77 --- /dev/null +++ b/code/python/docs/config/Models/AppOptions.md @@ -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) + diff --git a/code/python/docs/config/Models/AppOptionsHirschberg.md b/code/python/docs/config/Models/AppOptionsHirschberg.md new file mode 100644 index 0000000..d53e887 --- /dev/null +++ b/code/python/docs/config/Models/AppOptionsHirschberg.md @@ -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) + diff --git a/code/python/docs/config/Models/AppOptionsHirschbergMovePriorities.md b/code/python/docs/config/Models/AppOptionsHirschbergMovePriorities.md new file mode 100644 index 0000000..0fd6aa3 --- /dev/null +++ b/code/python/docs/config/Models/AppOptionsHirschbergMovePriorities.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) + diff --git a/code/python/docs/config/Models/AppOptionsTarjan.md b/code/python/docs/config/Models/AppOptionsTarjan.md new file mode 100644 index 0000000..4793a79 --- /dev/null +++ b/code/python/docs/config/Models/AppOptionsTarjan.md @@ -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) + diff --git a/code/python/docs/config/Models/Config.md b/code/python/docs/config/Models/Config.md new file mode 100644 index 0000000..1cc470c --- /dev/null +++ b/code/python/docs/config/Models/Config.md @@ -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) + diff --git a/code/python/docs/config/Models/EnumHirschbergShow.md b/code/python/docs/config/Models/EnumHirschbergShow.md new file mode 100644 index 0000000..2aac6d3 --- /dev/null +++ b/code/python/docs/config/Models/EnumHirschbergShow.md @@ -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) + diff --git a/code/python/docs/config/Models/EnumHirschbergVerbosity.md b/code/python/docs/config/Models/EnumHirschbergVerbosity.md new file mode 100644 index 0000000..ca0e2c8 --- /dev/null +++ b/code/python/docs/config/Models/EnumHirschbergVerbosity.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) + diff --git a/code/python/docs/config/Models/EnumLogLevel.md b/code/python/docs/config/Models/EnumLogLevel.md new file mode 100644 index 0000000..8f120a1 --- /dev/null +++ b/code/python/docs/config/Models/EnumLogLevel.md @@ -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) + diff --git a/code/python/docs/config/Models/Info.md b/code/python/docs/config/Models/Info.md new file mode 100644 index 0000000..77e5486 --- /dev/null +++ b/code/python/docs/config/Models/Info.md @@ -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) + diff --git a/code/python/docs/config/README.md b/code/python/docs/config/README.md new file mode 100644 index 0000000..19aa598 --- /dev/null +++ b/code/python/docs/config/README.md @@ -0,0 +1,29 @@ +# Documentation for Schemata for config models + + +## Documentation for API Endpoints + +All URIs are relative to *http://.* + +Class | Method | HTTP request | Description +------------ | ------------- | ------------- | ------------- + + + +## 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) + + + +## Documentation for Authorization + +All endpoints do not require authorization.