dev > master: code py - documentation als HTML
This commit is contained in:
parent
036c87f829
commit
3548ec5c6f
3
code/python/.gitignore
vendored
3
code/python/.gitignore
vendored
@ -28,8 +28,7 @@
|
|||||||
|
|
||||||
!/docs
|
!/docs
|
||||||
!/docs/*/
|
!/docs/*/
|
||||||
!/docs/*/Models/
|
!/docs/**/*.html
|
||||||
!/docs/**/*.md
|
|
||||||
|
|
||||||
!/tests
|
!/tests
|
||||||
!/tests/**/
|
!/tests/**/
|
||||||
|
|||||||
@ -1,9 +0,0 @@
|
|||||||
# 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)
|
|
||||||
|
|
||||||
@ -1,12 +0,0 @@
|
|||||||
# 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)
|
|
||||||
|
|
||||||
@ -1,11 +0,0 @@
|
|||||||
# 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)
|
|
||||||
|
|
||||||
@ -1,11 +0,0 @@
|
|||||||
# 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)
|
|
||||||
|
|
||||||
@ -1,8 +0,0 @@
|
|||||||
# 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)
|
|
||||||
|
|
||||||
@ -1,8 +0,0 @@
|
|||||||
# 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)
|
|
||||||
|
|
||||||
@ -1,26 +0,0 @@
|
|||||||
# 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.
|
|
||||||
260
code/python/docs/commands/index.html
Normal file
260
code/python/docs/commands/index.html
Normal file
@ -0,0 +1,260 @@
|
|||||||
|
<!doctype html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<title>Schemata for command instructions</title>
|
||||||
|
<style type="text/css">
|
||||||
|
body {
|
||||||
|
font-family: Trebuchet MS, sans-serif;
|
||||||
|
font-size: 15px;
|
||||||
|
color: #444;
|
||||||
|
margin-right: 24px;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1 {
|
||||||
|
font-size: 25px;
|
||||||
|
}
|
||||||
|
h2 {
|
||||||
|
font-size: 20px;
|
||||||
|
}
|
||||||
|
h3 {
|
||||||
|
font-size: 16px;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
hr {
|
||||||
|
height: 1px;
|
||||||
|
border: 0;
|
||||||
|
color: #ddd;
|
||||||
|
background-color: #ddd;
|
||||||
|
}
|
||||||
|
|
||||||
|
.app-desc {
|
||||||
|
clear: both;
|
||||||
|
margin-left: 20px;
|
||||||
|
}
|
||||||
|
.param-name {
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
.license-info {
|
||||||
|
margin-left: 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.license-url {
|
||||||
|
margin-left: 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.model {
|
||||||
|
margin: 0 0 0px 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.method {
|
||||||
|
margin-left: 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.method-notes {
|
||||||
|
margin: 10px 0 20px 0;
|
||||||
|
font-size: 90%;
|
||||||
|
color: #555;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre {
|
||||||
|
padding: 10px;
|
||||||
|
margin-bottom: 2px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.http-method {
|
||||||
|
text-transform: uppercase;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre.get {
|
||||||
|
background-color: #0f6ab4;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre.post {
|
||||||
|
background-color: #10a54a;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre.put {
|
||||||
|
background-color: #c5862b;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre.delete {
|
||||||
|
background-color: #a41e22;
|
||||||
|
}
|
||||||
|
|
||||||
|
.huge {
|
||||||
|
color: #fff;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre.example {
|
||||||
|
background-color: #f3f3f3;
|
||||||
|
padding: 10px;
|
||||||
|
border: 1px solid #ddd;
|
||||||
|
}
|
||||||
|
|
||||||
|
code {
|
||||||
|
white-space: pre;
|
||||||
|
}
|
||||||
|
|
||||||
|
.nickname {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
.method-path {
|
||||||
|
font-size: 1.5em;
|
||||||
|
background-color: #0f6ab4;
|
||||||
|
}
|
||||||
|
|
||||||
|
.up {
|
||||||
|
float:right;
|
||||||
|
}
|
||||||
|
|
||||||
|
.parameter {
|
||||||
|
width: 500px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.param {
|
||||||
|
width: 500px;
|
||||||
|
padding: 10px 0 0 20px;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
.param-desc {
|
||||||
|
width: 700px;
|
||||||
|
padding: 0 0 0 20px;
|
||||||
|
color: #777;
|
||||||
|
}
|
||||||
|
|
||||||
|
.param-type {
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
|
||||||
|
.param-enum-header {
|
||||||
|
width: 700px;
|
||||||
|
padding: 0 0 0 60px;
|
||||||
|
color: #777;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
.param-enum {
|
||||||
|
width: 700px;
|
||||||
|
padding: 0 0 0 80px;
|
||||||
|
color: #777;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
|
||||||
|
.field-label {
|
||||||
|
padding: 0;
|
||||||
|
margin: 0;
|
||||||
|
clear: both;
|
||||||
|
}
|
||||||
|
|
||||||
|
.field-items {
|
||||||
|
padding: 0 0 15px 0;
|
||||||
|
margin-bottom: 15px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.return-type {
|
||||||
|
clear: both;
|
||||||
|
padding-bottom: 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.param-header {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
.method-tags {
|
||||||
|
text-align: right;
|
||||||
|
}
|
||||||
|
|
||||||
|
.method-tag {
|
||||||
|
background: none repeat scroll 0% 0% #24A600;
|
||||||
|
border-radius: 3px;
|
||||||
|
padding: 2px 10px;
|
||||||
|
margin: 2px;
|
||||||
|
color: #FFF;
|
||||||
|
display: inline-block;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<h1>Schemata for command instructions</h1>
|
||||||
|
<div class="app-desc">No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)</div>
|
||||||
|
<div class="app-desc">More information: <a href="https://openapi-generator.tech">https://openapi-generator.tech</a></div>
|
||||||
|
<div class="app-desc">Contact Info: <a href="team@openapitools.org">team@openapitools.org</a></div>
|
||||||
|
<div class="app-desc">Version: 0.1.0</div>
|
||||||
|
<div class="app-desc">BasePath:</div>
|
||||||
|
<div class="license-info">All rights reserved</div>
|
||||||
|
<div class="license-url">http://apache.org/licenses/LICENSE-2.0.html</div>
|
||||||
|
<h2>Access</h2>
|
||||||
|
|
||||||
|
<h2><a name="__Methods">Methods</a></h2>
|
||||||
|
[ Jump to <a href="#__Models">Models</a> ]
|
||||||
|
|
||||||
|
<h3>Table of Contents </h3>
|
||||||
|
<div class="method-summary"></div>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a name="__Models">Models</a></h2>
|
||||||
|
[ Jump to <a href="#__Methods">Methods</a> ]
|
||||||
|
|
||||||
|
<h3>Table of Contents</h3>
|
||||||
|
<ol>
|
||||||
|
<li><a href="#Command"><code>Command</code> - </a></li>
|
||||||
|
<li><a href="#CommandHirschberg"><code>CommandHirschberg</code> - </a></li>
|
||||||
|
<li><a href="#CommandTarjan"><code>CommandTarjan</code> - </a></li>
|
||||||
|
<li><a href="#CommandTsp"><code>CommandTsp</code> - </a></li>
|
||||||
|
<li><a href="#EnumAlgorithmNames"><code>EnumAlgorithmNames</code> - </a></li>
|
||||||
|
<li><a href="#EnumTSPOptimise"><code>EnumTSPOptimise</code> - </a></li>
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
<div class="model">
|
||||||
|
<h3><a name="Command"><code>Command</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||||
|
<div class='model-description'>Instructions for command to call</div>
|
||||||
|
<div class="field-items">
|
||||||
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#EnumAlgorithmNames">EnumAlgorithmNames</a></span> </div>
|
||||||
|
</div> <!-- field-items -->
|
||||||
|
</div>
|
||||||
|
<div class="model">
|
||||||
|
<h3><a name="CommandHirschberg"><code>CommandHirschberg</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||||
|
<div class='model-description'>Instructions for execution of Hirschberg-Algorithm</div>
|
||||||
|
<div class="field-items">
|
||||||
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#EnumAlgorithmNames">EnumAlgorithmNames</a></span> </div>
|
||||||
|
<div class="param">word1 </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Word that gets placed vertically in algorithm. </div>
|
||||||
|
<div class="param">word2 </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Word that gets placed horizontally in algorithm </div>
|
||||||
|
<div class="param">once (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
||||||
|
</div> <!-- field-items -->
|
||||||
|
</div>
|
||||||
|
<div class="model">
|
||||||
|
<h3><a name="CommandTarjan"><code>CommandTarjan</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||||
|
<div class='model-description'>Instructions for execution of Tarjan-Algorithm</div>
|
||||||
|
<div class="field-items">
|
||||||
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#EnumAlgorithmNames">EnumAlgorithmNames</a></span> </div>
|
||||||
|
<div class="param">nodes </div><div class="param-desc"><span class="param-type"><a href="#anyOf<integer,number,string>">array[anyOf<integer,number,string>]</a></span> </div>
|
||||||
|
<div class="param">edges </div><div class="param-desc"><span class="param-type"><a href="#array">array[array[anyOf<integer,number,string>]]</a></span> </div>
|
||||||
|
</div> <!-- field-items -->
|
||||||
|
</div>
|
||||||
|
<div class="model">
|
||||||
|
<h3><a name="CommandTsp"><code>CommandTsp</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||||
|
<div class='model-description'>Instructions for execution of TSP-Algorithm</div>
|
||||||
|
<div class="field-items">
|
||||||
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#EnumAlgorithmNames">EnumAlgorithmNames</a></span> </div>
|
||||||
|
<div class="param">dist </div><div class="param-desc"><span class="param-type"><a href="#array">array[array[BigDecimal]]</a></span> </div>
|
||||||
|
<div class="param">optimise </div><div class="param-desc"><span class="param-type"><a href="#EnumTSPOptimise">EnumTSPOptimise</a></span> </div>
|
||||||
|
</div> <!-- field-items -->
|
||||||
|
</div>
|
||||||
|
<div class="model">
|
||||||
|
<h3><a name="EnumAlgorithmNames"><code>EnumAlgorithmNames</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||||
|
<div class='model-description'>Enumeration of possible algorithm options.</div>
|
||||||
|
<div class="field-items">
|
||||||
|
</div> <!-- field-items -->
|
||||||
|
</div>
|
||||||
|
<div class="model">
|
||||||
|
<h3><a name="EnumTSPOptimise"><code>EnumTSPOptimise</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||||
|
<div class='model-description'>Enumeration of optimisation options for TSP</div>
|
||||||
|
<div class="field-items">
|
||||||
|
</div> <!-- field-items -->
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@ -1,13 +0,0 @@
|
|||||||
# 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)
|
|
||||||
|
|
||||||
@ -1,13 +0,0 @@
|
|||||||
# 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)
|
|
||||||
|
|
||||||
@ -1,11 +0,0 @@
|
|||||||
# 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)
|
|
||||||
|
|
||||||
@ -1,9 +0,0 @@
|
|||||||
# 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)
|
|
||||||
|
|
||||||
@ -1,10 +0,0 @@
|
|||||||
# 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)
|
|
||||||
|
|
||||||
@ -1,8 +0,0 @@
|
|||||||
# 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)
|
|
||||||
|
|
||||||
@ -1,8 +0,0 @@
|
|||||||
# 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)
|
|
||||||
|
|
||||||
@ -1,8 +0,0 @@
|
|||||||
# 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)
|
|
||||||
|
|
||||||
@ -1,11 +0,0 @@
|
|||||||
# 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)
|
|
||||||
|
|
||||||
@ -1,29 +0,0 @@
|
|||||||
# 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.
|
|
||||||
289
code/python/docs/config/index.html
Normal file
289
code/python/docs/config/index.html
Normal file
@ -0,0 +1,289 @@
|
|||||||
|
<!doctype html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<title>Schemata for config models</title>
|
||||||
|
<style type="text/css">
|
||||||
|
body {
|
||||||
|
font-family: Trebuchet MS, sans-serif;
|
||||||
|
font-size: 15px;
|
||||||
|
color: #444;
|
||||||
|
margin-right: 24px;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1 {
|
||||||
|
font-size: 25px;
|
||||||
|
}
|
||||||
|
h2 {
|
||||||
|
font-size: 20px;
|
||||||
|
}
|
||||||
|
h3 {
|
||||||
|
font-size: 16px;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
hr {
|
||||||
|
height: 1px;
|
||||||
|
border: 0;
|
||||||
|
color: #ddd;
|
||||||
|
background-color: #ddd;
|
||||||
|
}
|
||||||
|
|
||||||
|
.app-desc {
|
||||||
|
clear: both;
|
||||||
|
margin-left: 20px;
|
||||||
|
}
|
||||||
|
.param-name {
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
.license-info {
|
||||||
|
margin-left: 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.license-url {
|
||||||
|
margin-left: 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.model {
|
||||||
|
margin: 0 0 0px 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.method {
|
||||||
|
margin-left: 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.method-notes {
|
||||||
|
margin: 10px 0 20px 0;
|
||||||
|
font-size: 90%;
|
||||||
|
color: #555;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre {
|
||||||
|
padding: 10px;
|
||||||
|
margin-bottom: 2px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.http-method {
|
||||||
|
text-transform: uppercase;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre.get {
|
||||||
|
background-color: #0f6ab4;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre.post {
|
||||||
|
background-color: #10a54a;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre.put {
|
||||||
|
background-color: #c5862b;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre.delete {
|
||||||
|
background-color: #a41e22;
|
||||||
|
}
|
||||||
|
|
||||||
|
.huge {
|
||||||
|
color: #fff;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre.example {
|
||||||
|
background-color: #f3f3f3;
|
||||||
|
padding: 10px;
|
||||||
|
border: 1px solid #ddd;
|
||||||
|
}
|
||||||
|
|
||||||
|
code {
|
||||||
|
white-space: pre;
|
||||||
|
}
|
||||||
|
|
||||||
|
.nickname {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
.method-path {
|
||||||
|
font-size: 1.5em;
|
||||||
|
background-color: #0f6ab4;
|
||||||
|
}
|
||||||
|
|
||||||
|
.up {
|
||||||
|
float:right;
|
||||||
|
}
|
||||||
|
|
||||||
|
.parameter {
|
||||||
|
width: 500px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.param {
|
||||||
|
width: 500px;
|
||||||
|
padding: 10px 0 0 20px;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
.param-desc {
|
||||||
|
width: 700px;
|
||||||
|
padding: 0 0 0 20px;
|
||||||
|
color: #777;
|
||||||
|
}
|
||||||
|
|
||||||
|
.param-type {
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
|
||||||
|
.param-enum-header {
|
||||||
|
width: 700px;
|
||||||
|
padding: 0 0 0 60px;
|
||||||
|
color: #777;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
.param-enum {
|
||||||
|
width: 700px;
|
||||||
|
padding: 0 0 0 80px;
|
||||||
|
color: #777;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
|
||||||
|
.field-label {
|
||||||
|
padding: 0;
|
||||||
|
margin: 0;
|
||||||
|
clear: both;
|
||||||
|
}
|
||||||
|
|
||||||
|
.field-items {
|
||||||
|
padding: 0 0 15px 0;
|
||||||
|
margin-bottom: 15px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.return-type {
|
||||||
|
clear: both;
|
||||||
|
padding-bottom: 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.param-header {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
.method-tags {
|
||||||
|
text-align: right;
|
||||||
|
}
|
||||||
|
|
||||||
|
.method-tag {
|
||||||
|
background: none repeat scroll 0% 0% #24A600;
|
||||||
|
border-radius: 3px;
|
||||||
|
padding: 2px 10px;
|
||||||
|
margin: 2px;
|
||||||
|
color: #FFF;
|
||||||
|
display: inline-block;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<h1>Schemata for config models</h1>
|
||||||
|
<div class="app-desc">No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)</div>
|
||||||
|
<div class="app-desc">More information: <a href="https://openapi-generator.tech">https://openapi-generator.tech</a></div>
|
||||||
|
<div class="app-desc">Contact Info: <a href="team@openapitools.org">team@openapitools.org</a></div>
|
||||||
|
<div class="app-desc">Version: 0.1.0</div>
|
||||||
|
<div class="app-desc">BasePath:</div>
|
||||||
|
<div class="license-info">All rights reserved</div>
|
||||||
|
<div class="license-url">http://apache.org/licenses/LICENSE-2.0.html</div>
|
||||||
|
<h2>Access</h2>
|
||||||
|
|
||||||
|
<h2><a name="__Methods">Methods</a></h2>
|
||||||
|
[ Jump to <a href="#__Models">Models</a> ]
|
||||||
|
|
||||||
|
<h3>Table of Contents </h3>
|
||||||
|
<div class="method-summary"></div>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a name="__Models">Models</a></h2>
|
||||||
|
[ Jump to <a href="#__Methods">Methods</a> ]
|
||||||
|
|
||||||
|
<h3>Table of Contents</h3>
|
||||||
|
<ol>
|
||||||
|
<li><a href="#AppOptions"><code>AppOptions</code> - </a></li>
|
||||||
|
<li><a href="#AppOptions_hirschberg"><code>AppOptions_hirschberg</code> - </a></li>
|
||||||
|
<li><a href="#AppOptions_hirschberg_move_priorities"><code>AppOptions_hirschberg_move_priorities</code> - </a></li>
|
||||||
|
<li><a href="#AppOptions_tarjan"><code>AppOptions_tarjan</code> - </a></li>
|
||||||
|
<li><a href="#Config"><code>Config</code> - </a></li>
|
||||||
|
<li><a href="#EnumHirschbergShow"><code>EnumHirschbergShow</code> - </a></li>
|
||||||
|
<li><a href="#EnumHirschbergVerbosity"><code>EnumHirschbergVerbosity</code> - </a></li>
|
||||||
|
<li><a href="#EnumLogLevel"><code>EnumLogLevel</code> - </a></li>
|
||||||
|
<li><a href="#Info"><code>Info</code> - </a></li>
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
<div class="model">
|
||||||
|
<h3><a name="AppOptions"><code>AppOptions</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||||
|
<div class='model-description'>Options pertaining to the rudimentary setup of the app.</div>
|
||||||
|
<div class="field-items">
|
||||||
|
<div class="param">logMinuslevel </div><div class="param-desc"><span class="param-type"><a href="#EnumLogLevel">EnumLogLevel</a></span> </div>
|
||||||
|
<div class="param">verbose (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Global setting for verbosity. </div>
|
||||||
|
<div class="param">tarjan </div><div class="param-desc"><span class="param-type"><a href="#AppOptions_tarjan">AppOptions_tarjan</a></span> </div>
|
||||||
|
<div class="param">tsp </div><div class="param-desc"><span class="param-type"><a href="#AppOptions_tarjan">AppOptions_tarjan</a></span> </div>
|
||||||
|
<div class="param">hirschberg </div><div class="param-desc"><span class="param-type"><a href="#AppOptions_hirschberg">AppOptions_hirschberg</a></span> </div>
|
||||||
|
</div> <!-- field-items -->
|
||||||
|
</div>
|
||||||
|
<div class="model">
|
||||||
|
<h3><a name="AppOptions_hirschberg"><code>AppOptions_hirschberg</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||||
|
<div class='model-description'></div>
|
||||||
|
<div class="field-items">
|
||||||
|
<div class="param">penalityMinusmismatch </div><div class="param-desc"><span class="param-type"><a href="#number">BigDecimal</a></span> </div>
|
||||||
|
<div class="param">penalityMinusgap </div><div class="param-desc"><span class="param-type"><a href="#number">BigDecimal</a></span> </div>
|
||||||
|
<div class="param">moveMinuspriorities </div><div class="param-desc"><span class="param-type"><a href="#AppOptions_hirschberg_move_priorities">AppOptions_hirschberg_move_priorities</a></span> </div>
|
||||||
|
<div class="param">verbose (optional)</div><div class="param-desc"><span class="param-type"><a href="#EnumHirschbergVerbosity">array[EnumHirschbergVerbosity]</a></span> </div>
|
||||||
|
<div class="param">show (optional)</div><div class="param-desc"><span class="param-type"><a href="#EnumHirschbergShow">array[EnumHirschbergShow]</a></span> </div>
|
||||||
|
</div> <!-- field-items -->
|
||||||
|
</div>
|
||||||
|
<div class="model">
|
||||||
|
<h3><a name="AppOptions_hirschberg_move_priorities"><code>AppOptions_hirschberg_move_priorities</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||||
|
<div class='model-description'></div>
|
||||||
|
<div class="field-items">
|
||||||
|
<div class="param">diagonal (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
|
||||||
|
<div class="param">horizontal (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
|
||||||
|
<div class="param">vertical (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
|
||||||
|
</div> <!-- field-items -->
|
||||||
|
</div>
|
||||||
|
<div class="model">
|
||||||
|
<h3><a name="AppOptions_tarjan"><code>AppOptions_tarjan</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||||
|
<div class='model-description'></div>
|
||||||
|
<div class="field-items">
|
||||||
|
<div class="param">verbose </div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
||||||
|
</div> <!-- field-items -->
|
||||||
|
</div>
|
||||||
|
<div class="model">
|
||||||
|
<h3><a name="Config"><code>Config</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||||
|
<div class='model-description'>Data model for all parts of the configuration.</div>
|
||||||
|
<div class="field-items">
|
||||||
|
<div class="param">info </div><div class="param-desc"><span class="param-type"><a href="#Info">Info</a></span> </div>
|
||||||
|
<div class="param">options </div><div class="param-desc"><span class="param-type"><a href="#AppOptions">AppOptions</a></span> </div>
|
||||||
|
</div> <!-- field-items -->
|
||||||
|
</div>
|
||||||
|
<div class="model">
|
||||||
|
<h3><a name="EnumHirschbergShow"><code>EnumHirschbergShow</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||||
|
<div class='model-description'>Enumeration of verbosity options for Hirschberg</div>
|
||||||
|
<div class="field-items">
|
||||||
|
</div> <!-- field-items -->
|
||||||
|
</div>
|
||||||
|
<div class="model">
|
||||||
|
<h3><a name="EnumHirschbergVerbosity"><code>EnumHirschbergVerbosity</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||||
|
<div class='model-description'>Enumeration of verbosity options for Hirschberg</div>
|
||||||
|
<div class="field-items">
|
||||||
|
</div> <!-- field-items -->
|
||||||
|
</div>
|
||||||
|
<div class="model">
|
||||||
|
<h3><a name="EnumLogLevel"><code>EnumLogLevel</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||||
|
<div class='model-description'>Enumeration of settings for log level.</div>
|
||||||
|
<div class="field-items">
|
||||||
|
</div> <!-- field-items -->
|
||||||
|
</div>
|
||||||
|
<div class="model">
|
||||||
|
<h3><a name="Info"><code>Info</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||||
|
<div class='model-description'>Contains meta data about project.</div>
|
||||||
|
<div class="field-items">
|
||||||
|
<div class="param">title </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
||||||
|
<div class="param">description </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
||||||
|
<div class="param">author </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
||||||
|
</div> <!-- field-items -->
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@ -62,7 +62,7 @@ _generate-models-documentation path name:
|
|||||||
@- just _create-folder-if-not-exists "docs/{{name}}"
|
@- just _create-folder-if-not-exists "docs/{{name}}"
|
||||||
@- {{GEN_MODELS_DOCUMENTATION}} generate \
|
@- {{GEN_MODELS_DOCUMENTATION}} generate \
|
||||||
--input-spec {{path}}/{{name}}-schema.yaml \
|
--input-spec {{path}}/{{name}}-schema.yaml \
|
||||||
--generator-name markdown \
|
--generator-name html \
|
||||||
--output "docs/{{name}}"
|
--output "docs/{{name}}"
|
||||||
@- just _clean-all-files .openapi-generator*
|
@- just _clean-all-files .openapi-generator*
|
||||||
@- just _clean-all-folders .openapi-generator*
|
@- just _clean-all-folders .openapi-generator*
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user