feat: initial upload for AutoRestTest Track A datasets

.gitattributes

@@ -0,0 +1,21 @@
+*.txt filter=lfs diff=lfs merge=lfs -text
+*.jsonl filter=lfs diff=lfs merge=lfs -text
+*.exe filter=lfs diff=lfs merge=lfs -text
+*.jar filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.sql filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.png filter=lfs diff=lfs merge=lfs -text
+*.jpg filter=lfs diff=lfs merge=lfs -text
+*.eot filter=lfs diff=lfs merge=lfs -text
+*.ttf filter=lfs diff=lfs merge=lfs -text
+*.woff filter=lfs diff=lfs merge=lfs -text
+*.woff2 filter=lfs diff=lfs merge=lfs -text
+*.dict filter=lfs diff=lfs merge=lfs -text
+*.map filter=lfs diff=lfs merge=lfs -text
+*solved.json filter=lfs diff=lfs merge=lfs -text
+*.ico filter=lfs diff=lfs merge=lfs -text
+*.eps filter=lfs diff=lfs merge=lfs -text
+*.xlsx filter=lfs diff=lfs merge=lfs -text
+*.exec filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -0,0 +1,62 @@
+.idea/
+.vscode/
+.github/
+.gradle/
+
+# OS artifacts
+.DS_Store
+**/.DS_Store
+
+# Python
+venv/
+.venv/
+**/.venv/
+__pycache__/
+**/__pycache__/
+*.py[cod]
+*.pyo
+.hypothesis/
+
+# Environment
+.env
+
+# Data and cache directories
+data/
+src/data/
+**/data/
+src/cache/
+**/cache/
+**/testing_output/
+**/glove.6B.50d.w2v.txt
+
+# Logs and reports
+logs/
+kittylogs/
+RestlerLogs/
+services/service_logs/
+*.log
+log_*
+*LOG_PATH*
+org.jacoco.*
+jacoco_*
+workloadResultsFile.xlsx
+faultloadResultsFile.xlsx
+
+# Build and tooling outputs
+target/
+output/
+out/
+restler_bin/
+restler/
+rest-gitlab/
+Fuzz/
+Compile/
+services/jdk8/erc20-rest-service/bin/
+
+# Project-specific artifacts
+test.json
+cp.txt
+*.pkl
+evomaster-benchmark-cs-rest-artificial-news.iml
+evomaster.jar
+test.py

Dockerfile

@@ -0,0 +1,11 @@
+FROM python:3.10
+
+WORKDIR /app
+
+COPY . /app
+
+RUN pip install --no-cache-dir -r requirements.txt
+
+ENV PYTHONPATH=/app/src
+
+CMD ["python3", "-m", "autoresttest.autoresttest"]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 selab-gatech
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,393 @@
+# AutoRestTest
+
+### Introduction
+***AutoRestTest*** is a complete testing software for automated API testing that combines the utility of graph
+theory, Large Language Models (LLMs), and multi-agent reinforcement learning (MARL) to parse the OpenAPI Specification
+and create enhanced comprehensive test cases. AutoRestTest specifically supports **OpenAPI Specification 3.0**.
+
+Watch this [demonstration video](https://www.youtube.com/watch?v=VVus2W8rap8) of AutoRestTest to learn how it solves complex challenges in automated REST API testing, as well as its configuration, execution steps, and output.
+
+> [!NOTE]
+> Following the release of the demonstration video, the code base has been refactored.
+> Refer to this `README.md` for the most current setup and execution details.
+
+<p align="center">
+  <a href="https://www.youtube.com/watch?v=VVus2W8rap8">
+    <img src="https://img.youtube.com/vi/VVus2W8rap8/0.jpg" alt="Watch the video">
+  </a>
+</p>
+
+The program uses LLMs for natural-language processing during the creation of the reinforcement
+learning tables and graph edges. AutoRestTest supports any LLM from an OpenAI-API compatible provider, including OpenAI, OpenRouter, Azure OpenAI, and local models (LocalAI, LM Studio, vLLM, Ollama, etc.).
+
+> [!Important]
+> An API key from your chosen LLM provider is required. The cost per execution depends on your provider and model choice.
+> For reference, when testing an average API with ~15 operations using GPT-4o-mini, the cost was approximately $0.1.
+
+## Terminal User Interface (TUI)
+
+AutoRestTest features a modern, interactive terminal user interface built with [Rich](https://github.com/Textualize/rich) that provides:
+
+### Interactive Configuration Wizard
+
+On startup, AutoRestTest launches an interactive configuration wizard that allows you to:
+- **Select API specifications** from discovered files or enter custom paths
+- **Choose LLM providers** (OpenAI, OpenRouter, Local) with pre-configured model options
+- **Configure test duration** with convenient presets (5, 10, 20, 30, 60 minutes)
+- **Adjust Q-learning parameters** (learning rate, discount factor, exploration)
+- **Toggle caching options** for faster repeated runs
+- **Override API URLs** for local testing
+
+The wizard uses sensible defaults from `configurations.toml`, so you can simply press Enter to accept defaults or customize any setting.
+
+### Live Execution Dashboard
+
+During request generation, a real-time dashboard displays:
+
+```
+╔══════════════════════════════════════════════════════════════════════════════╗
+║ [STATUS] Request Generation                                                   ║
+╠══════════════════════════════════════════════════════════════════════════════╣
+║  ┌──────────────────────────────────────────────────────────────────────┐    ║
+║  │ Time Elapsed: 00:15:32            Time Remaining: 00:04:28           │    ║
+║  │ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 77.8%    │    ║
+║  └──────────────────────────────────────────────────────────────────────┘    ║
+║                                                                               ║
+║  Successfully Processed (2xx) Operations:          1,482                     ║
+║  Operation Coverage:                               85.2%                     ║
+║  Unique Server Errors (5xx):                       7                         ║
+║  Total Requests Sent:                              3,847                     ║
+║                                                                               ║
+║  Status Code Distribution                                                     ║
+║  ┌──────────────────────────────────────────────────────────────────────┐    ║
+║  │ 200: ████████████████████████████████████████████░░░░░░░░  1,482    │    ║
+║  │ 404: ████░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░    150    │    ║
+║  │ 500: █░░░░░░░░���░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░      7    │    ║
+║  └──────────────────────────────────────────────────────────────────────┘    ║
+║                                                                               ║
+║  Current Operation: GET /api/users/{id}                                       ║
+║                                                                               ║
+║  [COST] Total LLM usage: $0.11 USD                                           ║
+╚══════════════════════════════════════════════════════════════════════════════╝
+```
+
+Features include:
+- **Real-time progress tracking** with elapsed and remaining time
+- **Color-coded status codes** (green for 2xx, orange for 4xx, red for 5xx)
+- **Visual progress bars** for status code distribution
+- **Live cost estimation** based on token usage
+- **Current operation indicator** showing what's being tested
+- **Mutation counter** tracking the number of fuzzing mutations applied
+
+### Q-Table Initialization Progress
+
+During the Q-table initialization phase, the Value Agent and Header Agent (if enabled) perform LLM calls to generate test values for each API operation. A live progress display shows:
+
+```
+╭──── ⚙ Value Agent Q-Table Generation ────╮
+│                                           │
+│   ━━━━━━━━━━━━━━━━━━━━━━━───────  67.5%  │
+│                                           │
+│   Operations: 27/40  │  Elapsed: 03:45   │
+│                                           │
+│   ▶ POST /api/users                       │
+│                                           │
+╰───────────────────────────────────────────╯
+```
+
+This progress display appears for both Value Agent and Header Agent initialization, showing:
+- Visual progress bar with percentage complete
+- Operation count (completed/total)
+- Elapsed time
+- Current operation being processed
+
+### TUI Command Line Options
+
+| Option | Description |
+|--------|-------------|
+| `--skip-wizard` | Skip configuration wizard, use `configurations.toml` directly |
+| `--quick` | Quick setup wizard (essential settings only) |
+| `-s, --spec PATH` | Override specification path |
+| `-t, --time SECONDS` | Override test duration |
+| `--width N` | Set TUI display width (default: 100) |
+
+**Examples:**
+
+```bash
+# Full interactive mode (default)
+poetry run autoresttest
+
+# Quick setup - only essential settings
+poetry run autoresttest --quick
+
+# Skip wizard entirely, use config file
+poetry run autoresttest --skip-wizard
+
+# Override spec and duration via CLI
+poetry run autoresttest -s specs/original/oas/spotify.yaml -t 600
+```
+
+## Installation
+
+We recommend using Poetry with `pyproject.toml` for dependency management and scripts. A `poetry.lock` file pins exact versions.
+
+Steps:
+1. Clone the repository.
+2. Ensure Python 3.10.x is available (project targets `>=3.10,<3.11`).
+3. Install dependencies with Poetry (uses `poetry.lock` if present):
+   - `poetry install`
+4. Create a `.env` file in the project root and add:
+   - `API_KEY='<YOUR_API_KEY>'`
+
+Alternatives (provided but not recommended):
+- `pip install -r requirements.txt`
+- `conda env create -f autoresttest.yaml`
+
+Optionally, if the user wants to test specific APIs, they can install their OpenAPI Specification files within a folder
+in the root directory. For convenience, we have provided a large array of OpenAPI Specifications for popular and 
+widely-used APIs. These Specifications can be seen in the `aratrl-openapi` and `specs` directories.
+
+### Running Local Services
+
+AutoRestTest includes support for running local REST API services for testing. Some services require building before use:
+
+#### JDK 8_1 Services (features-service, ncs, scs)
+
+These services must be built before first use:
+
+```bash
+# Make the build script executable
+chmod +x services/build_jdk8_1_services.sh
+
+# Build all JDK 8_1 services
+bash services/build_jdk8_1_services.sh
+```
+
+After building, start a service:
+```bash
+cd services
+python3 run_service_mac.py features-service no_token
+```
+
+For detailed instructions, see `FEATURES_SERVICE_SETUP.md`.
+
+#### Other Supported Services
+
+Other services like genome-nexus, language-tool, youtube, etc. can be run without building:
+```bash
+cd services
+python3 run_service_mac.py <service-name> <token>
+```
+
+See `services/README.md` for the full list of supported services.
+
+At this point, the installation step is complete and the software can be executed. However, it is important that the
+following configuration steps are completed for purposeful execution.
+
+## Configuration
+
+There is a wide array of configuration options available within the codebase. All configuration options are easily accessible via a single TOML file at the project root: `configurations.toml`.
+
+Below are the relevant settings and where to find them in `configurations.toml`.
+
+#### 1. Specifying the API Specification
+
+If you intend to use your own OpenAPI Specification file as described in the Installation section, set the relative path (from the project root) to that file in `configurations.toml` under `[spec].location`.
+
+Only `.yaml` and `.json` files are supported (OpenAPI 3.0). Example: `aratrl-openapi/market2.yaml`.
+
+Specification parsing is handled by [Prance](https://github.com/jfinkhaeuser/prance). If your spec has circular/self-referencing `$ref` chains, you can tune the resolver behavior with:
+- `[spec].recursion_limit` (default: `1`) — the maximum number of times a circular reference may appear in the resolution stack before a placeholder schema is substituted; a value of 1 means a self-referencing element is resolved once before being replaced.
+- `[spec].strict_validation` (default: `true`) — when `true`, the OpenAPI spec is strictly validated and parsing stops on errors; when `false`, invalid sections are skipped where possible so execution can continue.
+
+#### 2. Configuring Reinforcement Learning Parameters
+
+Configure Q-learning parameters in `configurations.toml`:
+- `[q_learning].learning_rate` (default: `0.1`)
+- `[q_learning].discount_factor` (default: `0.9`)
+- `[q_learning].max_exploration` (epsilon; default: `1`, decays over time to `0.1`)
+
+Instead of limiting episodes, the program limits RL iterations using a time budget. Set the duration (in seconds) under:
+- `[request_generation].time_duration` (default: `1200`)
+
+> [!NOTE]
+> This time budget applies only to the MARL (Q-learning) phase. The initial value table generation phase, which runs before Q-learning begins, is not time-limited and will process all operations in the specification.
+
+#### Parameter Combination Sampling
+
+For APIs with many parameters, generating all possible combinations would cause memory exhaustion. AutoRestTest uses depth-weighted stratified sampling to bound combinations while prioritizing smaller (more diagnostic) combinations. Configure under `[agent]`:
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `max_combinations` | `12` | Maximum optional parameters per combination. Required parameters are always included. |
+| `max_total_combinations` | `3000` | Hard cap on combinations per operation. Smaller combinations are kept when truncating. |
+| `base_samples_per_size` | `200` | Sample count at size=1; decays for larger sizes (e.g., size=5 gets ~60 samples). |
+| `combination_seed` | `42` | Seed for reproducible random sampling. Change for different samples. |
+
+Example distribution for an operation with 30 parameters:
+- Size 1-2: All combinations enumerated (30 + 435 = 465)
+- Size 3-12: Random samples (~700 total)
+- Total: ~1,200 unique combinations (well under 3K cap)
+
+> [!TIP]
+> The above steps alter the variables across all agents used within the software. If the user desires to change
+> the individual agent parameters, they can navigate to the `src/autoresttest/agents` files and change the parameters.
+
+#### 3. Parallel Value Table Generation
+
+The Value Agent's Q-table initialization can be parallelized using a thread pool, which significantly speeds up startup for APIs with many operations. Configure this under `[agent.value]`:
+- `[agent.value].parallelize` (default: `true`) — when `true`, operations are processed concurrently using a thread pool; when `false`, the original sequential depth-first traversal is used.
+- `[agent.value].max_workers` (default: `4`) — number of worker threads for parallel generation (ignored if `parallelize` is `false`). Set to match your CPU core count for optimal performance.
+
+> [!NOTE]
+> Rate-limited responses (HTTP 429) are automatically retried with exponential backoff.
+
+#### 4. Configuring the LLM
+
+AutoRestTest supports any LLM from an OpenAI-API compatible provider. Configure the model and provider in `configurations.toml`:
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `[llm].engine` | `gpt-4o-mini` | Model identifier. Format depends on provider (e.g., `gpt-4o-mini`, `google/gemini-2.0-flash-001`, `anthropic/claude-3-haiku`). |
+| `[llm].api_base` | `https://api.openai.com/v1` | API endpoint URL. Change for alternative providers. |
+| `[llm].creative_temperature` | `1` | Temperature for creative parameter generation. |
+| `[llm].strict_temperature` | `1` | Temperature for repair or deterministic flows. |
+| `[llm].max_tokens` | `30000` | Maximum tokens for LLM response. Set to `-1` to omit and use provider default. |
+
+**Example configurations:**
+
+```toml
+# OpenAI (default)
+[llm]
+engine = "gpt-4o-mini"
+api_base = "https://api.openai.com/v1"
+
+# OpenRouter (access to many models)
+[llm]
+engine = "google/gemini-2.0-flash-001"
+api_base = "https://openrouter.ai/api/v1"
+
+# Local model (LM Studio, Ollama, etc.)
+[llm]
+engine = "local-model"
+api_base = "http://localhost:1234/v1"
+```
+
+> [!WARNING]
+> The model must support **JSON mode**. Most recent models from major providers support this feature.
+> The console output will list token usage for analyzing costs, if supplied by the provider.
+
+#### 5. Use of Cached Graphs and Reinforcement Learning Tables
+
+The software can cache the graph and Q-tables to reduce cost and speed up repeated runs. Configure this behavior under:
+- `[cache].use_cached_graph` (default: `true`)
+- `[cache].use_cached_table` (default: `true`)
+
+> [!IMPORTANT]
+> The cache parameter structure changed on Dec. 10, 2025. Recreate caches (clear `cache/` contents) so they remain compatible with newer runs.
+
+> [!NOTE]
+> When enabled, these options store and read cached data under the `cache/` directory at the project root (for example, `cache/graphs/` and `cache/q_tables/`).
+> If disk usage becomes a concern, you can delete the cached project information in `cache/` after use; the data will be regenerated on the next run when needed.
+
+#### 6. Optional Header Agent
+
+AutoRestTest contains an optional Header agent responsible for testing the API with different authentication headers. Due to difficulties 
+of different authentication flows, the Header agent is only able to use Basic Authentication. By default, the agent is disabled.
+
+Toggle via `configurations.toml`:
+- `[agents.header].enabled` (default: `false`)
+
+> [!CAUTION]
+> The Header agent Q-table should be rerun when executing services with local databases that refresh, as the user
+> credentials may become invalid.
+
+#### 7. Custom Static Headers
+
+For APIs that require custom headers (such as API keys or Bearer tokens), you can configure static headers in the `[custom_headers]` section. These headers are included with every request.
+
+```toml
+[custom_headers]
+X-API-Key = "your-static-key"
+Authorization = "Bearer ${ACCESS_TOKEN}"
+```
+
+Environment variable interpolation is supported using the `${VAR_NAME}` syntax. Store sensitive values in your `.env` file:
+```
+ACCESS_TOKEN=your_bearer_token
+```
+
+> [!CAUTION]
+> If you enable the Header Agent (`[agents.header].enabled = true`) alongside custom headers, be aware that the Header Agent may override your `Authorization` header during testing. The Header Agent uses Basic Authentication tokens and has higher priority than custom static headers. For Bearer token or API key authentication, keep the Header Agent disabled.
+
+#### 8. Custom API URL Override
+
+By default, AutoRestTest extracts the API base URL from the `servers` field in your OpenAPI specification. If you need to target a different host (e.g., a local development server or staging environment), you can override this behavior in the `[api]` section:
+
+```toml
+[api]
+override_url = true
+host = "localhost"
+port = 8080
+```
+
+When `override_url` is set to `true`, the tool constructs the API URL as `http://{host}:{port}/` instead of using the specification's server URL.
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `override_url` | `false` | When `false`, uses the URL from the OpenAPI spec. When `true`, uses the custom host and port. |
+| `host` | `localhost` | The hostname for the custom API URL. |
+| `port` | `8080` | The port number for the custom API URL. |
+
+> [!TIP]
+> This is useful when testing local services that run on a different port than specified in the OpenAPI spec, or when the spec contains a production URL but you want to test against a local or staging environment.
+
+## Execution
+
+Run the script using Poetry, after following the installation instructions:
+```
+poetry run autoresttest
+```
+
+To indicate the specification for execution, set `[spec].location` in `configurations.toml`. This path must be relative to the project root.
+
+### Docker Execution
+
+For ease of use, the software can be executed using Docker. The user can apply the following commands from the 
+root directory sequentially to execute AutoRestTest using the pre-built Docker image:
+
+```
+docker build -t autoresttest .
+docker run -it autoresttest
+```
+
+Ensure that `configurations.toml` is configured correctly before executing the software.
+
+## Results
+
+Throughout AutoRestTest's execution, the TUI provides real-time visual feedback including:
+- **Phase indicators** showing current execution stage (Graph Construction, Q-Table Initialization, Request Generation)
+- **Live dashboard** during request generation with time tracking, status code distribution, and cost estimation
+- **Final report** with summary statistics, success rates, and token usage
+- **Smart status code grouping** - automatically groups by category (2xx, 4xx, 5xx) when there are many different codes
+- **Color-coded time indicators** - remaining time changes color based on percentage remaining (red < 5%, yellow < 20%) 
+
+#### Report Generation and Data Files
+
+AutoRestTest will generate a series of files in the `data` directory within the root folder for easy access to execution results. 
+The following are the files generated:
+- `report.json`: Contains the compiled report of the API testing process, including key summary statistics and information.
+- `operation_status_codes.json`: Contains the distribution of status codes for each operation.
+- `q_tables.json`: Contains the completed Q-tables for each agent.
+- `server_errors.json`: Contains the unique server errors encountered during the testing process. Only JSON-seriable errors are stored.
+- `successful_parameters.json`: Contains the successful parameters for each operation.
+- `successful_responses.json`: Contains the successful responses for each operation.
+- `successful_bodies.json`: Contains the successful object request bodies for each operation.
+- `successful_primitives.json`: Contains the successful primitive request bodies for each operation.
+
+These files contain the necessary information for analysis into the success of AutoRestTest. 
+
+> [!NOTE]
+> The output files can grow in size according to the number of operations and the duration of execution. 
+> For example, the file containing successful responses can grow to be several **gigabytes** when executing for a long duration. 
+> It is recommended to clear the `data` directory when the files are no longer needed.

arat.py

@@ -0,0 +1,745 @@
+import re
+import os
+import sys
+import copy
+import json
+import time
+import math
+import rstr
+import base64
+import random
+import string
+import prance
+import difflib
+import requests
+import datetime
+import functools
+from collections import defaultdict
+
+
+def generate_object(object_definition, operation):
+    random_object = {}
+    properties = list(object_definition.items())
+    num_fields = random.randint(0, len(properties))
+    selected_properties = random.sample(properties, num_fields)
+    for prop_element in selected_properties:
+        prop, prop_def = prop_element
+        random_object[prop] = get_next_parameter_value(operation, prop_def)
+    return random_object
+
+
+def generate_random_string_from_pattern(pattern, min_length=0, max_length=None):
+    try:
+        generated_str = rstr.xeger(pattern)
+        if max_length:
+            generated_str = generated_str[min_length:max_length-1]
+        return generated_str
+    except Exception:
+        pass
+    return None
+
+
+def get_value(param_type, operation=None, parameter=None, object_definition=None, param_format=None, array_item_type=None, response_values=None):
+
+    if random.random() < 0.1:
+        param_type = random.choice(['string', 'integer', 'number', 'boolean'])
+    min = 0
+    max = None
+    pattern = None
+    if parameter:
+        if "minLength" in parameter:
+            min = parameter["minLength"]
+        if "maxLength" in parameter:
+            max = parameter["maxLength"]
+        if "pattern" in parameter:
+            pattern = parameter["pattern"]
+    if param_type == 'string':
+        if param_format is None:
+            param_format = random.choice(['date', 'date-time', 'password', 'byte', 'binary'])
+        value = None
+
+        if pattern and random.random() < 0.9:
+            value = generate_random_string_from_pattern(pattern, min, max)
+        if value:
+            return value
+        else:
+            if param_format == 'date':
+                random_date = datetime.date.fromtimestamp(random.randint(0, int(datetime.datetime.now().timestamp())))
+                return random_date.strftime('%Y-%m-%d')
+            elif param_format == 'date-time':
+                random_datetime = datetime.datetime.fromtimestamp(
+                    random.randint(0, int(datetime.datetime.now().timestamp())))
+                return random_datetime.strftime('%Y-%m-%dT%H:%M:%SZ')
+            elif param_format == 'password':
+                random_password_length = random.randint(5, 10)
+                characters = string.ascii_letters + string.digits + string.punctuation
+                return ''.join(random.choice(characters) for _ in range(random_password_length))
+            elif param_format == 'byte':
+                random_byte_length = random.randint(1, 10)
+                return base64.b64encode(os.urandom(random_byte_length)).decode('utf-8')
+            elif param_format == 'binary':
+                random_binary_length = random.randint(1, 10)
+                return ''.join(random.choice(['0', '1']) for _ in range(random_binary_length))
+    elif param_type == 'integer':
+        return random.randint(-10000, 10000)
+    elif param_type == 'number':
+        return random.uniform(-10000, 10000)
+    elif param_type == 'boolean':
+        return random.choice([True, False])
+    elif param_type == 'object':
+        if object_definition:
+            nested_object = {}
+            num_properties_to_select = random.randint(1, len(object_definition))
+            selected_properties = random.sample(list(object_definition.items()), num_properties_to_select)
+
+            for prop, prop_def in selected_properties:
+                nested_prop_type = prop_def.get('type', None)
+                nested_object[prop] = get_value(nested_prop_type, operation=operation, parameter=prop_def,
+                                                object_definition=prop_def.get('properties', None),
+                                                response_values=response_values)
+
+            return nested_object
+        else:
+            return {}
+    elif param_type == 'array':
+        array_length = 1
+        if array_item_type == 'object' and object_definition:
+            return [generate_object(object_definition, operation=operation)]
+        else:
+            return [get_value(array_item_type, operation=operation) for _ in range(array_length)]
+    else:
+        return None
+
+@functools.lru_cache(maxsize=1024)
+def get_random_values_from_description(description):
+    all_values = list(set(re.findall(r"[\w,]+", description) + re.findall(r"'([^']+)'", description) + re.findall(r"`([^`]+)`", description)+ re.findall(r'"([^"]+)"', description)))
+
+    if all_values:
+        return random.choice(all_values)
+    else:
+        return [None]
+
+def is_value_of_type(value, param_type):
+    if param_type == 'integer' and isinstance(value, int):
+        return True
+    elif param_type == 'number' and isinstance(value, float):
+        return True
+    elif param_type == 'string' and isinstance(value, str):
+        return True
+    elif param_type == 'boolean' and isinstance(value, bool):
+        return True
+    elif param_type == "array" and isinstance(value, list):
+        return True
+    elif param_type == "object" and isinstance(value, dict):
+        return True
+    else:
+        return False
+
+def extract_response_values(response, op):
+    try:
+        if isinstance(response, list):
+            val = random.choice(response)
+            extract_response_values(val, op)
+        elif isinstance(response, dict):
+            key, value = random.choice(list(response.items()))
+            if key in response_values:
+                if value not in response_values[key]:
+                    response_values[key].append(value)
+            if isinstance(value, dict) or isinstance(value, list):
+                extract_response_values(value, op)
+            else:
+                if key not in response_values:
+                    response_values[key] = []
+                if value not in response_values[key]:
+                    if key not in producer:
+                        producer[key] = []
+                    if op["operation_id"] not in producer[key]:
+                        if op["method"] == "get" and len(producer[key]) > 0:
+                            pass
+                        else:
+                            producer[key].append(op["operation_id"])
+                    response_values[key].append(value)
+    except Exception as e:
+        pass
+
+def generate_parameter_values(operations):
+    generated_values = {}
+
+    for operation in operations:
+        operation_id = operation['operation_id']
+        generated_values[operation_id] = []
+
+        for parameter in operation['parameters']:
+            param_name = parameter['name']
+
+            value = get_next_parameter_value(operation, parameter)
+
+            if value is not None:
+                generated_values[operation_id].append({param_name: value})
+
+    return generated_values
+
+def execute_operations(base_url, selected_operation, selected_parameters):
+    method, path = selected_operation['method'], selected_operation['path']
+    query_params, body_params = {}, {}
+    media_types = selected_operation.get('consumes', [
+        'application/json', 'application/x-www-form-urlencoded'
+    ])
+
+    def send_request(content_type):
+        headers = {"Content-Type": content_type}
+
+        try:
+            if content_type == 'application/x-www-form-urlencoded':
+                try:
+                    if method == 'get':
+                        return requests.get(url, params=query_params, headers=headers, data=body_params)
+                    elif method == 'post':
+                        return requests.post(url, params=query_params, headers=headers, data=body_params)
+                    elif method == 'put':
+                        return requests.put(url, params=query_params, headers=headers, data=body_params)
+                    elif method == 'delete':
+                        return requests.delete(url, params=query_params, headers=headers, data=body_params)
+                    elif method == 'patch':
+                        return requests.patch(url, params=query_params, headers=headers, data=body_params)
+                    elif method == 'head':
+                        return requests.head(url, headers=headers, params=query_params)
+                except Exception:
+                    if method == 'get':
+                        return requests.get(url, params=query_params, headers=headers, json=body_params)
+                    elif method == 'post':
+                        return requests.post(url, params=query_params, headers=headers, json=body_params)
+                    elif method == 'put':
+                        return requests.put(url, params=query_params, headers=headers, json=body_params)
+                    elif method == 'delete':
+                        return requests.delete(url, params=query_params, headers=headers, json=body_params)
+                    elif method == 'patch':
+                        return requests.patch(url, params=query_params, headers=headers, json=body_params)
+                    elif method == 'head':
+                        return requests.head(url, headers=headers, params=query_params)
+            else:
+                if method == 'get':
+                    return requests.get(url, params=query_params, headers=headers, json=body_params)
+                elif method == 'post':
+                    return requests.post(url, params=query_params, headers=headers, json=body_params)
+                elif method == 'put':
+                    return requests.put(url, params=query_params, headers=headers, json=body_params)
+                elif method == 'delete':
+                    return requests.delete(url, params=query_params, headers=headers, json=body_params)
+                elif method == 'patch':
+                    return requests.patch(url, params=query_params, headers=headers, json=body_params)
+                elif method == 'head':
+                    return requests.head(url, headers=headers, params=query_params)
+        except requests.exceptions.RequestException as e:
+            print(f"Request error: {e}")
+            return None
+
+    for param_value_dict in selected_parameters:
+        for param_name, param_value in param_value_dict.items():
+            param = next((p for p in selected_operation['parameters'] if p['name'] == param_name), None)
+            if param is None: continue
+            if "schema" in param:
+                param_location, param_type = param['in'], param["schema"].get('type')
+            else:
+                param_location, param_type = param['in'], param.get('type')
+            if param_location == 'path':
+                path = path.replace(f'{{{param_name}}}', str(param_value))
+            elif param_location == 'query':
+                query_params[param_name] = param_value
+            elif isinstance(param_value, list):
+                body_params = param_value
+            elif isinstance(param_value, dict):
+                for tt in param_value:
+                    body_params[tt] = param_value[tt]
+            else:
+                if isinstance(body_params, dict):
+                    body_params[param_name] = param_value if param_type != 'array' else (param_value if isinstance(param_value, list) else [param_value])
+    url = base_url + path
+    if selected_operation['operation_id'] in cached_media_type:
+        response = send_request(cached_media_type[selected_operation['operation_id']])
+    else:
+        for media_type in media_types:
+            response = send_request(media_type)
+            if response and 200 <= response.status_code < 300:
+                cached_media_type[selected_operation['operation_id']] = media_type
+                break
+
+    return response, path, query_params, body_params
+
+
+def get_mutated_value(param_type):
+    # Get a list of all possible types
+    all_types = ['string', 'integer', 'number', 'boolean', 'object', 'array']
+
+    # Remove the original param_type from the list
+    all_types.remove(param_type)
+
+    # Randomly choose a new type different from the original param_type
+    mutated_type = random.choice(all_types)
+
+    # Generate a value with the new mutated type
+    return get_value(mutated_type)
+
+def perform_parameter_mutation(selected_parameters, selected_operation):
+    mutated_parameters = []
+
+    # Mutate media type
+    if random.uniform(0, 1) < MUTATION_RATE:
+        media_types = selected_operation.get('consumes', [
+            'application/json', 'application/xml', 'application/x-www-form-urlencoded',
+            'multipart/form-data', 'text/plain; charset=utf-8', 'text/html',
+            'application/pdf', 'image/png'
+        ])
+        new_media_type = random.choice(media_types)
+        selected_operation['consumes'] = [new_media_type]
+    elif selected_operation['operation_id'] in cached_media_type:
+        selected_operation['consumes'] = cached_media_type[selected_operation['operation_id']]
+
+    def mutate_http_method(method):
+        all_methods = ['get', 'post', 'put', 'delete', 'patch']
+        allowed_methods = [m for m in all_methods if m != method]
+        return random.choice(allowed_methods)
+
+    method = selected_operation['method']
+
+    if random.uniform(0, 1) < MUTATION_RATE:
+        selected_operation['method'] = mutate_http_method(method)
+
+
+    for param_value_dict in selected_parameters:
+        for param_name, param_value in param_value_dict.items():
+            param = None
+
+            # Find the parameter
+            for parameter in selected_operation['parameters']:
+                if parameter['name'] == param_name:
+                    param = parameter
+                    break
+
+            # Mutate "parameter type" randomly
+            if random.uniform(0, 1) < MUTATION_RATE:
+                if "schema" in param:
+                    mutated_value = get_mutated_value(param["schema"]['type'])
+                else:
+                    mutated_value = get_mutated_value(param['type'])
+                if mutated_value is not None:
+                    mutated_parameters.append({param_name: mutated_value})
+                else:
+                    mutated_parameters.append(param_value_dict)
+            else:
+                mutated_parameters.append(param_value_dict)
+
+    return mutated_parameters, selected_operation
+
+def analyze_information(spec):
+    operations = []
+    parameters_frequency = defaultdict(int)
+
+    for path, path_data in spec['paths'].items():
+        for method, operation_data in path_data.items():
+            if method in ['get', 'post', 'put', 'delete', 'patch']:
+                operation_id = operation_data['operationId']
+                operations.append({
+                    'operation_id': operation_id,
+                    'method': method,
+                    'path': path,
+                    'parameters': operation_data.get('parameters', []),
+                    'responses': operation_data.get('responses', {})
+                })
+
+                for parameter in operation_data.get('parameters', []):
+                    param_name = parameter['name']
+                    parameters_frequency[param_name] += 1
+
+                for response_code, response_data in operation_data.get('responses', {}).items():
+                    schema = response_data.get('schema', {}).get('properties', {})
+                    for response_property in schema.keys():
+                        if response_property in parameters_frequency:
+                            parameters_frequency[response_property] += 1
+
+    return operations, parameters_frequency
+
+
+def initialize_q_learning(operations, parameters_frequency):
+    alpha = 0.1  # Learning rate
+    gamma = 0.99  # Discount factor
+      # Exploration rate
+
+    # Initialize Q-value using parameter frequency
+    q_table = {}
+    for operation in operations:
+        operation_id = operation['operation_id']
+        q_table[operation_id] = {}
+        q_value[operation_id] = {}
+        q_value[operation_id]["response"] = 0
+        q_value[operation_id]["request"] = 0
+        q_value[operation_id]["random"] = 0
+        q_value[operation_id]["specification"] = 0
+        q_value[operation_id]["default"] = 0
+        for parameter in operation['parameters']:
+            param_name = parameter['name']
+            q_table[operation_id][param_name] = parameters_frequency[param_name]
+
+    return alpha, gamma, q_table
+
+
+import json
+
+
+def report_http_500_errors():
+    # Prepare the report content
+    report_content = "Total number of Found 500 Errors: " + str(total_n[0]) + "\n"
+    report_content += "This report all errors that has different set of parameters, so we recommend to further explore them.\n"
+    report_content += "HTTP 500 Error Report:\n"
+    json_report = json.dumps(http_500_details, indent=4)
+    report_content += json_report
+
+    # Specify the filename
+    filename = 'http_500_error_report.txt'
+
+    # Open the file in write mode and write the report content
+    with open(filename, 'w') as file:
+        file.write(report_content)
+
+    print(f"Report saved to {filename}")
+
+
+def update_q_table(q_table, alpha, gamma, selected_operation, selected_parameters, response, path, query_params, body_params):
+    operation_id = selected_operation['operation_id']
+    if response is None:
+        reward = -10
+        q_value[operation_id][ss[0]] = q_value[operation_id][ss[0]] - 1
+    if response.status_code == 401:
+        reward = -1
+    elif 200 <= response.status_code < 300:
+        q_value[operation_id][ss[0]] = q_value[operation_id][ss[0]] + 1
+        reward = -1
+    elif 400 <= response.status_code:
+        q_value[operation_id][ss[0]] = q_value[operation_id][ss[0]] - 1
+        reward = 1
+    else:
+        q_value[operation_id][ss[0]] = q_value[operation_id][ss[0]] - 1
+        reward = -5
+
+    if response.status_code == 500:
+        if operation_id not in http_500_details:
+            http_500_details[operation_id] = {}
+        if selected_operation['path'] not in http_500_details[operation_id]:
+            http_500_details[operation_id][selected_operation['path']] = {}
+        keys_list = list(selected_parameters.keys())
+        sorted_keys_list = sorted(keys_list.keys())
+        concatenated_keys = '_'.join(sorted_keys_list)
+        if concatenated_keys not in http_500_details[operation_id][selected_operation['path']]:
+            http_500_details[operation_id][selected_operation['path']][concatenated_keys] = []
+            error_details = {
+                "path": path,
+                "query_parameters": query_params,
+                "body_parameters": body_params,
+                "response": response
+            }
+            http_500_details[operation_id].append(error_details)
+            total_n[0] = total_n[0] + 1
+
+    for param_value_dict in selected_parameters:
+        for param_name, param_value in param_value_dict.items():
+            if reward == -1:
+                if param_name not in previous_request:
+                    previous_request[param_name] = []
+                if selected_operation['method'] == "post" or selected_operation['method'] == "get":
+                    if param_value not in previous_request[param_name]:
+                        previous_request[param_name].append(param_value)
+                    if param_name not in producer:
+                        producer[param_name] = []
+                    if operation_id not in producer[param_name]:
+                        if (selected_operation['method'] == "get" and len(producer[param_name]) > 0):
+                            pass
+                        else:
+                            producer[param_name].append(operation_id)
+                    if param_name not in consumer:
+                        consumer[param_name] = []
+                    if operation_id not in consumer[param_name]:
+                        consumer[param_name].append(operation_id)
+
+                else:
+                    if operation_id not in consumer:
+                        consumer[operation_id] = []
+                    if param_name not in consumer[operation_id]:
+                        consumer[operation_id].append(param_name)
+                    for k in range(len(previous_request[param_name])):
+                        if previous_request[param_name][k] == param_value:
+                            del(previous_request[param_name][k])
+                            break
+
+            old_q_value = q_table[operation_id][param_name]
+            max_q_value_next_state = max(q_table[operation_id].values())
+            new_q_value = old_q_value + alpha * (reward + gamma * max_q_value_next_state - old_q_value)
+            q_table[operation_id][param_name] = new_q_value
+
+def adapt_testing_strategy(iteration, max_iterations_without_improvement):
+    if iteration % max_iterations_without_improvement == 0:
+        EPSILON[0] = min(1, EPSILON[0] * 1.1)
+
+def select_operations_and_parameters(operations, parameter_values, q_table):
+    method_priority = {'post': 5}
+
+    sorted_operations = sorted(operations, key=lambda op: (
+        (sum(q_table[op['operation_id']].values()) / len(q_table[op['operation_id']])) if len(
+            q_table[op['operation_id']]) > 0 else 0,
+        method_priority.get(op['method'], 0)), reverse=True)
+
+    if random.uniform(0, 1) < EPSILON[0]:
+        # Exploration: Choose a random operation
+        selected_operation = random.choice(sorted_operations)
+    else:
+        # Exploitation: Choose the operation with the best Q-value
+        selected_operation = sorted_operations[0]
+
+    operation_id = selected_operation['operation_id']
+    all_parameters = parameter_values[operation_id]
+    required_parameters = [param for param in all_parameters if any(param_name in param for param_name in [param_data['name'] for param_data in selected_operation['parameters'] if param_data.get('required', False)])]
+    optional_parameters = [param for param in all_parameters if param not in required_parameters]
+
+    if random.uniform(0, 1) < EPSILON[0]:
+        num_random_parameters = random.randint(0, len(optional_parameters))
+        selected_parameters = required_parameters + random.sample(optional_parameters, num_random_parameters)
+    else:
+        selected_parameters = required_parameters
+        sorted_optional_parameters = sorted(
+            optional_parameters,
+            key=lambda param: max(q_table[operation_id][param_name] for param_name in param),
+            reverse=True
+        )
+
+        num_optional_parameters = random.randint(0, len(sorted_optional_parameters))
+        selected_parameters += sorted_optional_parameters[:num_optional_parameters]
+
+    return selected_operation, selected_parameters
+
+def get_next_parameter_value(operation, parameter):
+    if "name" not in parameter:
+        param_name="MKobject"
+    else:
+        param_name = parameter['name']
+
+    param_format = None
+    object_schema = None
+    array_item_type = None
+    if "schema" in parameter:
+        param_type = parameter["schema"]['type']
+        if "format" in parameter["schema"]:
+            param_format = parameter["schema"]['format']
+        if "properties" in parameter["schema"]:
+            object_schema = parameter["schema"]["properties"]
+        if param_type == 'array' and "items" in parameter["schema"]:
+            array_item_type = parameter["schema"]["items"]["type"]
+            if "properties" in parameter["schema"]["items"]:
+                object_schema = parameter["schema"]["items"]["properties"]
+    else:
+        param_type = parameter['type']
+        if param_type == 'array' and "items" in parameter:
+            array_item_type = parameter["items"]["type"]
+            if "properties" in parameter["items"]:
+                object_schema = parameter["items"]["properties"]
+        if "format" in parameter:
+            param_format = parameter['format']
+
+    def random_value_from_dict(data_dict):
+        if data_dict:
+            key, value = random.choice(list(data_dict.items()))
+            if value:
+                return random.choice(value)
+
+        return None
+
+    def default_values(p):
+        default_values = {
+            'string': 'string',
+            'integer': 1,
+            'number': 1.1,
+            'boolean': True,
+            'array': [],
+            'object': {}
+        }
+        default_values_formats = {
+            'string': {
+                'date-time': '1970-01-01T00:00:00Z'
+            }
+        }
+
+        if param_type in default_values:
+            if param_format and param_type in default_values_formats and param_format in default_values_formats[
+                param_type]:
+                return default_values_formats[param_type][param_format]
+            else:
+                return default_values[param_type]
+
+        return None
+
+    def response(p):
+        max_similarity = -1
+        most_similar_key = None
+
+        for key in response_values:
+            similarity = difflib.SequenceMatcher(None, param_name, key).ratio()
+            if similarity > max_similarity:
+                max_similarity = similarity
+                most_similar_key = key
+
+        if most_similar_key is not None and response_values[most_similar_key]:
+            return random.choice(response_values[most_similar_key])
+        else:
+            return None
+
+    def request(p):
+        max_similarity = -1
+        most_similar_key = None
+
+        for key in previous_request:
+            similarity = difflib.SequenceMatcher(None, param_name, key).ratio()
+            if similarity > max_similarity:
+                max_similarity = similarity
+                most_similar_key = key
+        if most_similar_key is not None and previous_request[most_similar_key]:
+            return random.choice(previous_request[most_similar_key])
+        else:
+            return None
+
+    def spec(p):
+        value_candidates = []
+        if 'enum' in p:
+            value_candidates.extend(p['enum'])
+        if 'example' in p:
+            value_candidates.append(p['example'])
+        if 'description' in p:
+            value_candidates.append(get_random_values_from_description(p['description']))
+
+        if value_candidates:
+            return random.choice(value_candidates)
+        else:
+            return None
+
+    sources = [
+        ('specification', spec),
+        ('request', lambda p: random_value_from_dict(previous_request) if random.random() < 0.1 else request(p)),
+        ('response', lambda p: random_value_from_dict(response_values) if random.random() < 0.1 else response(p)),
+        ('random', lambda p: get_value(param_type, param_format=param_format, object_definition=object_schema,
+                                       array_item_type=array_item_type, operation=operation)),
+        ('default', default_values)
+    ]
+
+    def q_value_based_choice(p):
+
+        source_weights = {
+            'specification': q_value[operation['operation_id']].get('specification'),
+            'request': q_value[operation['operation_id']].get('request'),
+            'response': q_value[operation['operation_id']].get('response'),
+            'random': q_value[operation['operation_id']].get('random'),
+            'default': q_value[operation['operation_id']].get('default')
+        }
+
+        selected_source = max(source_weights, key=source_weights.get)
+
+        source_func = {
+            'specification': spec,
+            'request': lambda p: random_value_from_dict(previous_request) if random.random() < 0.1 else request(p),
+            'response': lambda p: random_value_from_dict(response_values) if random.random() < 0.1 else response(p),
+            'random': lambda p: get_value(param_type, param_format=param_format, object_definition=object_schema,
+                                          array_item_type=array_item_type, operation=operation),
+            'default': default_values
+        }
+        ss[0] = selected_source
+        return source_func[selected_source](p)
+
+    if random.uniform(0, 1) < EPSILON[0]:
+        random.shuffle(sources)  # Randomi`ze the order of the sources
+        value = None
+        if random.uniform(0, 1) < EPSILON[0]:
+            # Exploration: Choose a random source
+            random_source = random.choice(sources)
+            value = random_source[1](parameter)
+        else:
+            # Exploitation: Use the sources in the shuffled order
+            for source_name, source_func in sources:
+                value = source_func(parameter)
+                if array_item_type and value and not isinstance(value, list):
+                    value = [value]
+                if value is not None and is_value_of_type(value, param_type):
+                    break
+    else:
+        # Exploitation: Choose the source based on Q-value
+        value = q_value_based_choice(parameter)
+    # If no value is found from the sources above, return the default value
+    return value if value is not None and is_value_of_type(value, param_type) else get_value(param_type, param_format=param_format, object_definition=object_schema, array_item_type=array_item_type, operation=operation)
+
+
+def main():
+    # Read Specification
+    openapi_spec_file = sys.argv[1]
+    openapi_spec = prance.ResolvingParser(openapi_spec_file).specification
+    operations, parameters_frequency = analyze_information(openapi_spec)
+    alpha, gamma, q_table = initialize_q_learning(operations, parameters_frequency)
+
+    start_time = time.time()
+    time_limit = sys.argv[3]
+    iteration = 0
+    max_iterations_without_improvement = 10
+
+    while True:
+        elapsed_time = time.time() - start_time
+        if elapsed_time >= time_limit:
+            break
+        parameter_values = generate_parameter_values(operations)
+        selected_operation, selected_parameters = select_operations_and_parameters(operations, parameter_values,
+                                                                                   q_table)
+
+        # Run all producer operations if the selected_operation is a consumer operation
+        if selected_operation['operation_id'] in consumer:
+            for pname in consumer[selected_operation['operation_id']]:
+                if pname in producer:
+                    for producer_operation_id in producer[pname]:
+                        producer_operation = next(op for op in operations if op['operation_id'] == producer_operation_id)
+                        producer_parameters = generate_parameter_values([producer_operation])[
+                            producer_operation_id]
+
+                        response, path, query_params, body_params = execute_operations(base_url, producer_operation, producer_parameters)
+                        if (selected_operation['method'] in ["post", "get"]) and 200 <= response.status_code < 300:
+                            try:
+                                extract_response_values(response.json(), producer_operation)
+                            except Exception:
+                                pass
+
+        response, path, query_params, body_params = execute_operations(base_url, selected_operation, selected_parameters)
+        if (selected_operation['method'] in ["post", "get"]) and 200 <= response.status_code < 300:
+            try:
+                extract_response_values(response.json(), selected_operation)
+            except Exception:
+                pass
+        update_q_table(q_table, alpha, gamma, selected_operation, selected_parameters, response, path, query_params, body_params)
+
+        copied_operation = copy.deepcopy(selected_operation)
+        copied_parameters = copy.deepcopy(selected_parameters)
+        mutated_params, mutated_ops= perform_parameter_mutation(copied_parameters, copied_operation)
+        execute_operations(base_url, mutated_ops, mutated_params)
+
+
+        adapt_testing_strategy(iteration, max_iterations_without_improvement)
+        iteration += 1
+
+if __name__ == "__main__":
+    base_url = sys.argv[2]
+    EPSILON = [0.1]
+    ss = [None]
+    total_n = [0]
+    key_matched = {}
+    post_produced = {}
+    previous_request = {}
+    response_values = {}
+    cached_media_type = {}
+    q_table_param_values = {}
+    http_500_details = {}
+    producer = {}
+    consumer = {}
+    q_value = {}
+    MUTATION_RATE = 0.1
+    main()
+    report_http_500_errors()

aratrl-openapi/features.yaml

@@ -0,0 +1,408 @@
+openapi: 3.0.1
+info:
+  title: Features service
+  version: "1.0"
+servers:
+- url: http://localhost:30100
+paths:
+  /products/{productName}/features:
+    get:
+      operationId: getFeaturesForProduct
+      parameters:
+      - name: productName
+        in: path
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                uniqueItems: true
+                type: array
+                items:
+                  $ref: '#/components/schemas/Feature'
+  /products/{productName}/features/{featureName}:
+    put:
+      operationId: updateFeatureOfProduct
+      parameters:
+      - name: productName
+        in: path
+        required: true
+        schema:
+          type: string
+      - name: featureName
+        in: path
+        required: true
+        schema:
+          type: string
+      requestBody:
+        content:
+          application/x-www-form-urlencoded:
+            schema:
+              type: object
+              properties:
+                description:
+                  type: string
+      responses:
+        "200":
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Feature'
+    post:
+      operationId: addFeatureToProduct
+      parameters:
+      - name: productName
+        in: path
+        required: true
+        schema:
+          type: string
+      - name: featureName
+        in: path
+        required: true
+        schema:
+          type: string
+      requestBody:
+        content:
+          application/x-www-form-urlencoded:
+            schema:
+              type: object
+              properties:
+                description:
+                  type: string
+      responses:
+        default:
+          description: successful operation
+          content: {}
+    delete:
+      operationId: deleteFeatureOfProduct
+      parameters:
+      - name: productName
+        in: path
+        required: true
+        schema:
+          type: string
+      - name: featureName
+        in: path
+        required: true
+        schema:
+          type: string
+      responses:
+        default:
+          description: successful operation
+          content: {}
+  /products:
+    get:
+      operationId: getAllProducts
+      responses:
+        "200":
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: string
+  /products/{productName}:
+    get:
+      operationId: getProductByName
+      parameters:
+      - name: productName
+        in: path
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Product'
+    post:
+      operationId: addProduct
+      parameters:
+      - name: productName
+        in: path
+        required: true
+        schema:
+          type: string
+      responses:
+        default:
+          description: successful operation
+          content: {}
+    delete:
+      operationId: deleteProductByName
+      parameters:
+      - name: productName
+        in: path
+        required: true
+        schema:
+          type: string
+      responses:
+        default:
+          description: successful operation
+          content: {}
+  /products/{productName}/configurations/{configurationName}:
+    get:
+      operationId: getConfigurationWithNameForProduct
+      parameters:
+      - name: productName
+        in: path
+        required: true
+        schema:
+          type: string
+      - name: configurationName
+        in: path
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ProductConfiguration'
+    post:
+      operationId: addConfiguration
+      parameters:
+      - name: productName
+        in: path
+        required: true
+        schema:
+          type: string
+      - name: configurationName
+        in: path
+        required: true
+        schema:
+          type: string
+      responses:
+        default:
+          description: successful operation
+          content: {}
+    delete:
+      operationId: deleteConfiguration
+      parameters:
+      - name: productName
+        in: path
+        required: true
+        schema:
+          type: string
+      - name: configurationName
+        in: path
+        required: true
+        schema:
+          type: string
+      responses:
+        default:
+          description: successful operation
+          content: {}
+  /products/{productName}/configurations:
+    get:
+      operationId: getConfigurationsForProduct
+      parameters:
+      - name: productName
+        in: path
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: string
+  /products/{productName}/configurations/{configurationName}/features/{featureName}:
+    post:
+      operationId: addFeatureToConfiguration
+      parameters:
+      - name: productName
+        in: path
+        required: true
+        schema:
+          type: string
+      - name: configurationName
+        in: path
+        required: true
+        schema:
+          type: string
+      - name: featureName
+        in: path
+        required: true
+        schema:
+          type: string
+      responses:
+        default:
+          description: successful operation
+          content: {}
+    delete:
+      operationId: deleteFeature
+      parameters:
+      - name: productName
+        in: path
+        required: true
+        schema:
+          type: string
+      - name: configurationName
+        in: path
+        required: true
+        schema:
+          type: string
+      - name: featureName
+        in: path
+        required: true
+        schema:
+          type: string
+      responses:
+        default:
+          description: successful operation
+          content: {}
+  /products/{productName}/configurations/{configurationName}/features:
+    get:
+      operationId: getConfigurationActivedFeatures
+      parameters:
+      - name: productName
+        in: path
+        required: true
+        schema:
+          type: string
+      - name: configurationName
+        in: path
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: string
+  /products/{productName}/constraints/{constraintId}:
+    delete:
+      operationId: deleteConstraint
+      parameters:
+      - name: productName
+        in: path
+        required: true
+        schema:
+          type: string
+      - name: constraintId
+        in: path
+        required: true
+        schema:
+          type: integer
+          format: int64
+      responses:
+        default:
+          description: successful operation
+          content: {}
+  /products/{productName}/constraints/requires:
+    post:
+      operationId: addRequiresConstraintToProduct
+      parameters:
+      - name: productName
+        in: path
+        required: true
+        schema:
+          type: string
+      requestBody:
+        content:
+          application/x-www-form-urlencoded:
+            schema:
+              type: object
+              properties:
+                sourceFeature:
+                  type: string
+                requiredFeature:
+                  type: string
+      responses:
+        default:
+          description: successful operation
+          content: {}
+  /products/{productName}/constraints/excludes:
+    post:
+      operationId: addExcludesConstraintToProduct
+      parameters:
+      - name: productName
+        in: path
+        required: true
+        schema:
+          type: string
+      requestBody:
+        content:
+          application/x-www-form-urlencoded:
+            schema:
+              type: object
+              properties:
+                sourceFeature:
+                  type: string
+                excludedFeature:
+                  type: string
+      responses:
+        default:
+          description: successful operation
+          content: {}
+components:
+  schemas:
+    Feature:
+      type: object
+      properties:
+        id:
+          type: integer
+          format: int64
+        name:
+          type: string
+        description:
+          type: string
+    FeatureConstraint:
+      type: object
+      properties:
+        id:
+          type: integer
+          format: int64
+        type:
+          type: string
+    Product:
+      type: object
+      properties:
+        id:
+          type: integer
+          format: int64
+        name:
+          type: string
+        features:
+          uniqueItems: true
+          type: array
+          readOnly: true
+          items:
+            $ref: '#/components/schemas/Feature'
+        constraints:
+          uniqueItems: true
+          type: array
+          readOnly: true
+          items:
+            $ref: '#/components/schemas/FeatureConstraint'
+    ProductConfiguration:
+      type: object
+      properties:
+        name:
+          type: string
+        valid:
+          type: boolean
+        activedFeatures:
+          uniqueItems: true
+          type: array
+          items:
+            $ref: '#/components/schemas/Feature'
+x-original-swagger-version: "2.0"

aratrl-openapi/genome.yaml

@@ -0,0 +1,2535 @@
+openapi: 3.0.1
+info:
+  title: Genome Nexus API
+  description: |-
+    This page shows how to use HTTP requests to access the Genome Nexus API. There are more high level clients available in Python, R, JavaScript, TypeScript and various other languages as well as a command line client to annotate MAF and VCF. See https://docs.genomenexus.org/api.
+
+    Aside from programmatic clients there are web based tools to annotate variants, see https://docs.genomenexus.org/tools.
+
+     We currently only provide long-term support for the '/annotation' endpoint. The other endpoints might change.
+  license:
+    name: MIT License
+    url: https://github.com/genome-nexus/genome-nexus/blob/master/LICENSE
+  version: "2.0"
+servers:
+- url: http://localhost:30110
+- url: https://localhost:30110/
+tags:
+- name: info-controller
+  description: Info Controller
+- name: pdb-controller
+  description: PDB Controller
+- name: annotation-controller
+  description: Annotation Controller
+- name: ptm-controller
+  description: PTM Controller
+- name: pfam-controller
+  description: PFAM Controller
+- name: ensembl-controller
+  description: Ensembl Controller
+paths:
+  /annotation:
+    post:
+      tags:
+      - annotation-controller
+      summary: Retrieves VEP annotation for the provided list of variants
+      operationId: fetchVariantAnnotationPOST
+      parameters:
+      - name: isoformOverrideSource
+        in: query
+        description: Isoform override source. For example uniprot
+        schema:
+          type: string
+      - name: token
+        in: query
+        description: "Map of tokens. For example {\"source1\":\"put-your-token1-here\"\
+          ,\"source2\":\"put-your-token2-here\"}"
+        schema:
+          type: string
+      - name: fields
+        in: query
+        description: "Comma separated list of fields to include (case-sensitive!).\
+          \ For example: hotspots"
+        style: form
+        explode: true
+        schema:
+          type: array
+          items:
+            type: string
+            default: hotspots
+      requestBody:
+        description: "List of variants. For example [\"X:g.66937331T>A\",\"17:g.41242962_41242963insGA\"\
+          ] (GRCh37) or [\"1:g.182712A>C\", \"2:g.265023C>T\", \"3:g.319781del\",\
+          \ \"19:g.110753dup\", \"1:g.1385015_1387562del\"] (GRCh38)"
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                type: string
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/VariantAnnotation'
+      x-codegen-request-body-name: variants
+  /annotation/dbsnp/:
+    post:
+      tags:
+      - annotation-controller
+      summary: Retrieves VEP annotation for the provided list of dbSNP ids
+      operationId: fetchVariantAnnotationByIdPOST
+      parameters:
+      - name: isoformOverrideSource
+        in: query
+        description: Isoform override source. For example uniprot
+        schema:
+          type: string
+      - name: token
+        in: query
+        description: "Map of tokens. For example {\"source1\":\"put-your-token1-here\"\
+          ,\"source2\":\"put-your-token2-here\"}"
+        schema:
+          type: string
+      - name: fields
+        in: query
+        description: "Comma separated list of fields to include (case-sensitive!).\
+          \ For example: annotation_summary"
+        style: form
+        explode: true
+        schema:
+          type: array
+          items:
+            type: string
+            default: annotation_summary
+      requestBody:
+        description: "List of variant IDs. For example [\"rs116035550\"]"
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                type: string
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/VariantAnnotation'
+      x-codegen-request-body-name: variantIds
+  /annotation/dbsnp/{variantId}:
+    get:
+      tags:
+      - annotation-controller
+      summary: Retrieves VEP annotation for the give dbSNP id
+      operationId: fetchVariantAnnotationByIdGET
+      parameters:
+      - name: variantId
+        in: path
+        description: dbSNP id. For example rs116035550.
+        required: true
+        schema:
+          type: string
+      - name: isoformOverrideSource
+        in: query
+        description: Isoform override source. For example uniprot
+        schema:
+          type: string
+      - name: token
+        in: query
+        description: "Map of tokens. For example {\"source1\":\"put-your-token1-here\"\
+          ,\"source2\":\"put-your-token2-here\"}"
+        schema:
+          type: string
+      - name: fields
+        in: query
+        description: "Comma separated list of fields to include (case-sensitive!).\
+          \ For example: annotation_summary"
+        style: form
+        explode: true
+        schema:
+          type: array
+          items:
+            type: string
+            default: annotation_summary
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/VariantAnnotation'
+  /annotation/genomic:
+    post:
+      tags:
+      - annotation-controller
+      summary: Retrieves VEP annotation for the provided list of genomic locations
+      operationId: fetchVariantAnnotationByGenomicLocationPOST
+      parameters:
+      - name: isoformOverrideSource
+        in: query
+        description: Isoform override source. For example uniprot
+        schema:
+          type: string
+      - name: token
+        in: query
+        description: "Map of tokens. For example {\"source1\":\"put-your-token1-here\"\
+          ,\"source2\":\"put-your-token2-here\"}"
+        schema:
+          type: string
+      - name: fields
+        in: query
+        description: "Comma separated list of fields to include (case-sensitive!).\
+          \ For example: hotspots"
+        style: form
+        explode: true
+        schema:
+          type: array
+          items:
+            type: string
+            default: hotspots
+      requestBody:
+        description: List of Genomic Locations
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                $ref: '#/components/schemas/GenomicLocation'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/VariantAnnotation'
+      x-codegen-request-body-name: genomicLocations
+  /annotation/genomic/{genomicLocation}:
+    get:
+      tags:
+      - annotation-controller
+      summary: Retrieves VEP annotation for the provided genomic location
+      operationId: fetchVariantAnnotationByGenomicLocationGET
+      parameters:
+      - name: genomicLocation
+        in: path
+        description: "A genomic location. For example 7,140453136,140453136,A,T"
+        required: true
+        schema:
+          type: string
+      - name: isoformOverrideSource
+        in: query
+        description: Isoform override source. For example uniprot
+        schema:
+          type: string
+      - name: token
+        in: query
+        description: "Map of tokens. For example {\"source1\":\"put-your-token1-here\"\
+          ,\"source2\":\"put-your-token2-here\"}"
+        schema:
+          type: string
+      - name: fields
+        in: query
+        description: "Comma separated list of fields to include (case-sensitive!).\
+          \ For example: hotspots"
+        style: form
+        explode: true
+        schema:
+          type: array
+          items:
+            type: string
+            default: hotspots
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/VariantAnnotation'
+  /annotation/{variant}:
+    get:
+      tags:
+      - annotation-controller
+      summary: Retrieves VEP annotation for the provided variant
+      operationId: fetchVariantAnnotationGET
+      parameters:
+      - name: variant
+        in: path
+        description: Variant. For example 17:g.41242962_41242963insGA
+        required: true
+        schema:
+          type: string
+      - name: isoformOverrideSource
+        in: query
+        description: Isoform override source. For example uniprot
+        schema:
+          type: string
+      - name: token
+        in: query
+        description: "Map of tokens. For example {\"source1\":\"put-your-token1-here\"\
+          ,\"source2\":\"put-your-token2-here\"}"
+        schema:
+          type: string
+      - name: fields
+        in: query
+        description: "Comma separated list of fields to include (case-sensitive!).\
+          \ For example: hotspots"
+        style: form
+        explode: true
+        schema:
+          type: array
+          items:
+            type: string
+            default: hotspots
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/VariantAnnotation'
+  /ensembl/canonical-gene/entrez:
+    post:
+      tags:
+      - ensembl-controller
+      summary: Retrieves canonical Ensembl Gene ID by Entrez Gene Ids
+      operationId: fetchCanonicalEnsemblGeneIdByEntrezGeneIdsPOST
+      requestBody:
+        description: "List of Entrez Gene Ids. For example [\"23140\",\"26009\",\"\
+          100131879\"]"
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                type: string
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/EnsemblGene'
+      x-codegen-request-body-name: entrezGeneIds
+  /ensembl/canonical-gene/entrez/{entrezGeneId}:
+    get:
+      tags:
+      - ensembl-controller
+      summary: Retrieves Ensembl canonical gene id by Entrez Gene Id
+      operationId: fetchCanonicalEnsemblGeneIdByEntrezGeneIdGET
+      parameters:
+      - name: entrezGeneId
+        in: path
+        description: An Entrez Gene Id. For example 23140
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/EnsemblGene'
+  /ensembl/canonical-gene/hgnc:
+    post:
+      tags:
+      - ensembl-controller
+      summary: Retrieves canonical Ensembl Gene ID by Hugo Symbols
+      operationId: fetchCanonicalEnsemblGeneIdByHugoSymbolsPOST
+      requestBody:
+        description: "List of Hugo Symbols. For example [\"TP53\",\"PIK3CA\",\"BRCA1\"\
+          ]"
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                type: string
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/EnsemblGene'
+      x-codegen-request-body-name: hugoSymbols
+  /ensembl/canonical-gene/hgnc/{hugoSymbol}:
+    get:
+      tags:
+      - ensembl-controller
+      summary: Retrieves Ensembl canonical gene id by Hugo Symbol
+      operationId: fetchCanonicalEnsemblGeneIdByHugoSymbolGET
+      parameters:
+      - name: hugoSymbol
+        in: path
+        description: A Hugo Symbol. For example TP53
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/EnsemblGene'
+  /ensembl/canonical-transcript/hgnc:
+    post:
+      tags:
+      - ensembl-controller
+      summary: Retrieves Ensembl canonical transcripts by Hugo Symbols
+      operationId: fetchCanonicalEnsemblTranscriptsByHugoSymbolsPOST
+      parameters:
+      - name: isoformOverrideSource
+        in: query
+        description: Isoform override source. For example uniprot
+        schema:
+          type: string
+          default: uniprot
+      requestBody:
+        description: "List of Hugo Symbols. For example [\"TP53\",\"PIK3CA\",\"BRCA1\"\
+          ]"
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                type: string
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/EnsemblTranscript'
+      x-codegen-request-body-name: hugoSymbols
+  /ensembl/canonical-transcript/hgnc/{hugoSymbol}:
+    get:
+      tags:
+      - ensembl-controller
+      summary: Retrieves Ensembl canonical transcript by Hugo Symbol
+      operationId: fetchCanonicalEnsemblTranscriptByHugoSymbolGET
+      parameters:
+      - name: hugoSymbol
+        in: path
+        description: A Hugo Symbol. For example TP53
+        required: true
+        schema:
+          type: string
+      - name: isoformOverrideSource
+        in: query
+        description: Isoform override source. For example uniprot
+        schema:
+          type: string
+          default: uniprot
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/EnsemblTranscript'
+  /ensembl/transcript:
+    get:
+      tags:
+      - ensembl-controller
+      summary: "Retrieves Ensembl Transcripts by protein ID, and gene ID. Retrieves\
+        \ all transcripts in case no query parameter provided"
+      operationId: fetchEnsemblTranscriptsGET
+      parameters:
+      - name: geneId
+        in: query
+        description: An Ensembl gene ID. For example ENSG00000136999
+        schema:
+          type: string
+      - name: proteinId
+        in: query
+        description: An Ensembl protein ID. For example ENSP00000439985
+        schema:
+          type: string
+      - name: hugoSymbol
+        in: query
+        description: A Hugo Symbol For example ARF5
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/EnsemblTranscript'
+    post:
+      tags:
+      - ensembl-controller
+      summary: "Retrieves Ensembl Transcripts by Ensembl transcript IDs, hugo Symbols,\
+        \ protein IDs, or gene IDs"
+      operationId: fetchEnsemblTranscriptsByEnsemblFilterPOST
+      requestBody:
+        description: "List of Ensembl transcript IDs. For example [\"ENST00000361390\"\
+          , \"ENST00000361453\", \"ENST00000361624\"]<br>OR<br>List of Hugo Symbols.\
+          \ For example [\"TP53\", \"PIK3CA\", \"BRCA1\"]<br>OR<br>List of Ensembl\
+          \ protein IDs. For example [\"ENSP00000439985\", \"ENSP00000478460\", \"\
+          ENSP00000346196\"]<br>OR<br>List of Ensembl gene IDs. For example [\"ENSG00000136999\"\
+          , \"ENSG00000272398\", \"ENSG00000198695\"]"
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/EnsemblFilter'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/EnsemblTranscript'
+      x-codegen-request-body-name: ensemblFilter
+  /ensembl/transcript/{transcriptId}:
+    get:
+      tags:
+      - ensembl-controller
+      summary: Retrieves the transcript by an Ensembl transcript ID
+      operationId: fetchEnsemblTranscriptByTranscriptIdGET
+      parameters:
+      - name: transcriptId
+        in: path
+        description: An Ensembl transcript ID. For example ENST00000361390
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/EnsemblTranscript'
+  /ensembl/xrefs:
+    get:
+      tags:
+      - ensembl-controller
+      summary: Perform lookups of Ensembl identifiers and retrieve their external
+        references in other databases
+      operationId: fetchGeneXrefsGET
+      parameters:
+      - name: accession
+        in: query
+        description: Ensembl gene accession. For example ENSG00000169083
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/GeneXref'
+  /pdb/header:
+    post:
+      tags:
+      - pdb-controller
+      summary: Retrieves PDB header info by a PDB id
+      operationId: fetchPdbHeaderPOST
+      requestBody:
+        description: "List of pdb ids, for example [\"1a37\",\"1a4o\"]"
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                type: string
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/PdbHeader'
+      x-codegen-request-body-name: pdbIds
+  /pdb/header/{pdbId}:
+    get:
+      tags:
+      - pdb-controller
+      summary: Retrieves PDB header info by a PDB id
+      operationId: fetchPdbHeaderGET
+      parameters:
+      - name: pdbId
+        in: path
+        description: "PDB id, for example 1a37"
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PdbHeader'
+  /pfam/domain:
+    post:
+      tags:
+      - pfam-controller
+      summary: Retrieves PFAM domains by PFAM domain accession IDs
+      operationId: fetchPfamDomainsByPfamAccessionPOST
+      requestBody:
+        description: "List of PFAM domain accession IDs. For example [\"PF02827\"\
+          ,\"PF00093\",\"PF15276\"]"
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                type: string
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/PfamDomain'
+      x-codegen-request-body-name: pfamAccessions
+  /pfam/domain/{pfamAccession}:
+    get:
+      tags:
+      - pfam-controller
+      summary: Retrieves a PFAM domain by a PFAM domain ID
+      operationId: fetchPfamDomainsByAccessionGET
+      parameters:
+      - name: pfamAccession
+        in: path
+        description: A PFAM domain accession ID. For example PF02827
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PfamDomain'
+  /ptm/experimental:
+    get:
+      tags:
+      - ptm-controller
+      summary: Retrieves PTM entries by Ensembl Transcript ID
+      operationId: fetchPostTranslationalModificationsGET
+      parameters:
+      - name: ensemblTranscriptId
+        in: query
+        description: Ensembl Transcript ID. For example ENST00000646891
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/PostTranslationalModification'
+    post:
+      tags:
+      - ptm-controller
+      summary: Retrieves PTM entries by Ensembl Transcript IDs
+      operationId: fetchPostTranslationalModificationsByPtmFilterPOST
+      requestBody:
+        description: "List of Ensembl transcript IDs. For example [\"ENST00000420316\"\
+          , \"ENST00000646891\", \"ENST00000371953\"]"
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PtmFilter'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/PostTranslationalModification'
+      x-codegen-request-body-name: ptmFilter
+  /version:
+    get:
+      tags:
+      - info-controller
+      summary: Retrieve Genome Nexus Version
+      operationId: fetchVersionGET
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Version'
+components:
+  schemas:
+    AlleleCount:
+      required:
+      - ac
+      - ac_afr
+      - ac_amr
+      - ac_asj
+      - ac_eas
+      - ac_fin
+      - ac_nfe
+      - ac_oth
+      - ac_sas
+      type: object
+      properties:
+        ac:
+          type: integer
+          format: int32
+        ac_afr:
+          type: integer
+          format: int32
+        ac_amr:
+          type: integer
+          format: int32
+        ac_asj:
+          type: integer
+          format: int32
+        ac_eas:
+          type: integer
+          format: int32
+        ac_fin:
+          type: integer
+          format: int32
+        ac_nfe:
+          type: integer
+          format: int32
+        ac_oth:
+          type: integer
+          format: int32
+        ac_sas:
+          type: integer
+          format: int32
+    AlleleFrequency:
+      required:
+      - af
+      - af_afr
+      - af_amr
+      - af_asj
+      - af_eas
+      - af_fin
+      - af_nfe
+      - af_oth
+      - af_sas
+      type: object
+      properties:
+        af:
+          type: number
+          format: double
+        af_afr:
+          type: number
+          format: double
+        af_amr:
+          type: number
+          format: double
+        af_asj:
+          type: number
+          format: double
+        af_eas:
+          type: number
+          format: double
+        af_fin:
+          type: number
+          format: double
+        af_nfe:
+          type: number
+          format: double
+        af_oth:
+          type: number
+          format: double
+        af_sas:
+          type: number
+          format: double
+    AlleleNumber:
+      required:
+      - an
+      - an_afr
+      - an_amr
+      - an_asj
+      - an_eas
+      - an_fin
+      - an_nfe
+      - an_oth
+      - an_sas
+      type: object
+      properties:
+        an:
+          type: integer
+          format: int32
+        an_afr:
+          type: integer
+          format: int32
+        an_amr:
+          type: integer
+          format: int32
+        an_asj:
+          type: integer
+          format: int32
+        an_eas:
+          type: integer
+          format: int32
+        an_fin:
+          type: integer
+          format: int32
+        an_nfe:
+          type: integer
+          format: int32
+        an_oth:
+          type: integer
+          format: int32
+        an_sas:
+          type: integer
+          format: int32
+    Alleles:
+      type: object
+      properties:
+        allele:
+          type: string
+          description: allele
+    ArticleAbstract:
+      type: object
+      properties:
+        abstract:
+          type: string
+        link:
+          type: string
+    Citations:
+      type: object
+      properties:
+        abstracts:
+          type: array
+          items:
+            $ref: '#/components/schemas/ArticleAbstract'
+        pmids:
+          type: array
+          items:
+            type: string
+    ClinVar:
+      type: object
+      properties:
+        alleleId:
+          type: integer
+          description: allele_id
+          format: int32
+        alt:
+          type: string
+          description: alt
+        chrom:
+          type: string
+          description: chrom
+        cytogenic:
+          type: string
+          description: cytogenic
+        gene:
+          $ref: '#/components/schemas/Gene'
+        hg19:
+          $ref: '#/components/schemas/Hg19'
+        hg38:
+          $ref: '#/components/schemas/Hg38'
+        hgvs:
+          $ref: '#/components/schemas/Hgvs'
+        license:
+          type: string
+          description: license
+        rcv:
+          type: array
+          items:
+            $ref: '#/components/schemas/Rcv'
+        variantId:
+          type: integer
+          description: variant_id
+          format: int32
+    Clinvar:
+      type: object
+      properties:
+        alternateAllele:
+          type: string
+        chromosome:
+          type: string
+        clinicalSignificance:
+          type: string
+        clinvarId:
+          type: integer
+          format: int32
+        conflictingClinicalSignificance:
+          type: string
+        endPosition:
+          type: integer
+          format: int32
+        referenceAllele:
+          type: string
+        startPosition:
+          type: integer
+          format: int32
+    ClinvarAnnotation:
+      type: object
+      properties:
+        annotation:
+          $ref: '#/components/schemas/Clinvar'
+    ColocatedVariant:
+      required:
+      - gnomad_afr_allele
+      - gnomad_afr_maf
+      - gnomad_eas_allele
+      - gnomad_eas_maf
+      - gnomad_nfe_allele
+      - gnomad_nfe_maf
+      type: object
+      properties:
+        dbSnpId:
+          type: string
+        gnomad_nfe_allele:
+          type: string
+          description: GnomAD Non-Finnish European Allele
+        gnomad_nfe_maf:
+          type: string
+          description: GnomAD Non-Finnish European MAF
+        gnomad_afr_allele:
+          type: string
+          description: GnomAD African/African American Allele
+        gnomad_afr_maf:
+          type: string
+          description: GnomAD African/African American MAF
+        gnomad_eas_allele:
+          type: string
+          description: GnomAD East Asian Allele
+        gnomad_eas_maf:
+          type: string
+          description: GnomAD East Asian MAF
+    Cosmic:
+      type: object
+      properties:
+        alt:
+          type: string
+          description: alt
+        chrom:
+          type: string
+          description: chrom
+        cosmicId:
+          type: string
+          description: cosmic_id
+        hg19:
+          $ref: '#/components/schemas/Hg19'
+        license:
+          type: string
+          description: _license
+        mutFreq:
+          type: number
+          description: mut_freq
+          format: double
+        mutNt:
+          type: string
+          description: mut_nt
+        ref:
+          type: string
+          description: ref
+        tumorSite:
+          type: string
+          description: tumor_site
+    CountByTumorType:
+      type: object
+      properties:
+        tumorType:
+          type: string
+          description: Tumor Type
+        tumorTypeCount:
+          type: integer
+          description: Sample count for Tumor Type
+          format: int32
+        variantCount:
+          type: integer
+          description: Variant count for Tumor Type
+          format: int32
+    Dbsnp:
+      type: object
+      properties:
+        _class:
+          type: string
+          description: class
+        alleleOrigin:
+          type: string
+          description: allele_origin
+        alleles:
+          type: array
+          description: alleles
+          items:
+            $ref: '#/components/schemas/Alleles'
+        alt:
+          type: string
+          description: alt
+        chrom:
+          type: string
+          description: chrom
+        dbsnpBuild:
+          type: integer
+          description: dbsnp_build
+          format: int32
+        flags:
+          type: array
+          description: flags
+          items:
+            type: string
+        hg19:
+          $ref: '#/components/schemas/Hg19'
+        license:
+          type: string
+          description: _license
+        ref:
+          type: string
+          description: ref
+        rsid:
+          type: string
+          description: rsid
+        validated:
+          type: boolean
+          description: validated
+          example: false
+        varSubtype:
+          type: string
+          description: var_subtype
+        vartype:
+          type: string
+          description: vartype
+    Drug:
+      type: object
+      properties:
+        drugName:
+          type: string
+        ncitCode:
+          type: string
+        synonyms:
+          type: array
+          items:
+            type: string
+        uuid:
+          type: string
+    EnsemblFilter:
+      type: object
+      properties:
+        geneIds:
+          type: array
+          description: "List of Ensembl gene IDs. For example [\"ENSG00000136999\"\
+            , \"ENSG00000272398\", \"ENSG00000198695\"]"
+          items:
+            type: string
+        hugoSymbols:
+          type: array
+          description: "List of Hugo Symbols. For example [\"TP53\", \"PIK3CA\", \"\
+            BRCA1\"]"
+          items:
+            type: string
+        proteinIds:
+          type: array
+          description: "List of Ensembl protein IDs. For example [\"ENSP00000439985\"\
+            , \"ENSP00000478460\", \"ENSP00000346196\"]"
+          items:
+            type: string
+        transcriptIds:
+          type: array
+          description: "List of Ensembl transcript IDs. For example [\"ENST00000361390\"\
+            , \"ENST00000361453\", \"ENST00000361624\"]"
+          items:
+            type: string
+    EnsemblGene:
+      required:
+      - geneId
+      - hugoSymbol
+      type: object
+      properties:
+        geneId:
+          type: string
+          description: Ensembl gene id
+        hugoSymbol:
+          type: string
+          description: Approved Hugo symbol
+        synonyms:
+          type: array
+          description: Hugo symbol synonyms
+          items:
+            type: string
+        previousSymbols:
+          type: array
+          description: Previous Hugo symbols
+          items:
+            type: string
+        entrezGeneId:
+          type: string
+          description: Entrez Gene Id
+    EnsemblTranscript:
+      required:
+      - geneId
+      - proteinId
+      - transcriptId
+      type: object
+      properties:
+        uniprotId:
+          type: string
+        transcriptId:
+          type: string
+          description: Ensembl transcript id
+        geneId:
+          type: string
+          description: Ensembl gene id
+        proteinId:
+          type: string
+          description: Ensembl protein id
+        proteinLength:
+          type: integer
+          description: Length of protein
+          format: int32
+        pfamDomains:
+          type: array
+          description: Pfam domains
+          items:
+            $ref: '#/components/schemas/PfamDomainRange'
+        hugoSymbols:
+          type: array
+          description: Hugo symbols
+          items:
+            type: string
+        refseqMrnaId:
+          type: string
+          description: RefSeq mRNA ID
+        ccdsId:
+          type: string
+          description: Consensus CDS (CCDS) ID
+        exons:
+          type: array
+          description: Exon information
+          items:
+            $ref: '#/components/schemas/Exon'
+        utrs:
+          type: array
+          description: UTR information
+          items:
+            $ref: '#/components/schemas/UntranslatedRegion'
+    Exon:
+      required:
+      - exonEnd
+      - exonId
+      - exonStart
+      - rank
+      - strand
+      - version
+      type: object
+      properties:
+        exonId:
+          type: string
+          description: Exon id
+        exonStart:
+          type: integer
+          description: Start position of exon
+          format: int32
+        exonEnd:
+          type: integer
+          description: End position of exon
+          format: int32
+        rank:
+          type: integer
+          description: Number of exon in transcript
+          format: int32
+        strand:
+          type: integer
+          description: "Strand exon is on, -1 for - and 1 for +"
+          format: int32
+        version:
+          type: integer
+          description: Exon version
+          format: int32
+    Gene:
+      type: object
+      properties:
+        geneId:
+          type: string
+          description: geneid
+        symbol:
+          type: string
+          description: symbol
+    GeneXref:
+      required:
+      - db_display_name
+      - dbname
+      - description
+      - display_id
+      - primary_id
+      - version
+      type: object
+      properties:
+        db_display_name:
+          type: string
+          description: Database display name
+        dbname:
+          type: string
+          description: Database name
+        description:
+          type: string
+          description: Description
+        display_id:
+          type: string
+          description: Display id
+        ensemblGeneId:
+          type: string
+        info_text:
+          type: string
+          description: Database info text
+        info_types:
+          type: string
+          description: Database info type
+        primary_id:
+          type: string
+          description: Primary id
+        synonyms:
+          type: array
+          description: Synonyms
+          items:
+            type: string
+        version:
+          type: string
+          description: Version
+    GeneralPopulationStats:
+      type: object
+      properties:
+        counts:
+          $ref: '#/components/schemas/SignalPopulationStats'
+        frequencies:
+          $ref: '#/components/schemas/SignalPopulationStats'
+    GenomicLocation:
+      required:
+      - chromosome
+      - end
+      - referenceAllele
+      - start
+      - variantAllele
+      type: object
+      properties:
+        chromosome:
+          type: string
+          description: Chromosome
+        start:
+          type: integer
+          description: Start Position
+          format: int32
+        end:
+          type: integer
+          description: End Position
+          format: int32
+        referenceAllele:
+          type: string
+          description: Reference Allele
+        variantAllele:
+          type: string
+          description: Variant Allele
+    Gnomad:
+      type: object
+      properties:
+        alleleCount:
+          $ref: '#/components/schemas/AlleleCount'
+        alleleFrequency:
+          $ref: '#/components/schemas/AlleleFrequency'
+        alleleNumber:
+          $ref: '#/components/schemas/AlleleNumber'
+        homozygotes:
+          $ref: '#/components/schemas/Homozygotes'
+    Hg19:
+      type: object
+      properties:
+        end:
+          type: integer
+          description: end
+          format: int32
+        start:
+          type: integer
+          description: start
+          format: int32
+    Hg38:
+      type: object
+      properties:
+        end:
+          type: string
+          description: end
+        start:
+          type: string
+          description: start
+    Hgvs:
+      type: object
+      properties:
+        coding:
+          type: array
+          items:
+            type: string
+        genomic:
+          type: array
+          items:
+            type: string
+    Homozygotes:
+      required:
+      - hom
+      - hom_afr
+      - hom_amr
+      - hom_asj
+      - hom_eas
+      - hom_fin
+      - hom_nfe
+      - hom_oth
+      - hom_sas
+      type: object
+      properties:
+        hom:
+          type: integer
+          format: int32
+        hom_afr:
+          type: integer
+          format: int32
+        hom_amr:
+          type: integer
+          format: int32
+        hom_asj:
+          type: integer
+          format: int32
+        hom_eas:
+          type: integer
+          format: int32
+        hom_fin:
+          type: integer
+          format: int32
+        hom_nfe:
+          type: integer
+          format: int32
+        hom_oth:
+          type: integer
+          format: int32
+        hom_sas:
+          type: integer
+          format: int32
+    Hotspot:
+      type: object
+      properties:
+        hugoSymbol:
+          type: string
+          description: Hugo gene symbol
+        inframeCount:
+          type: integer
+          description: Inframe mutation count
+          format: int32
+        missenseCount:
+          type: integer
+          description: Missense mutation count
+          format: int32
+        residue:
+          type: string
+          description: Hotspot residue
+        spliceCount:
+          type: integer
+          description: Splice mutation count
+          format: int32
+        transcriptId:
+          type: string
+          description: Ensembl Transcript Id
+        truncatingCount:
+          type: integer
+          description: Truncation mutation count
+          format: int32
+        tumorCount:
+          type: integer
+          description: Tumor count
+          format: int32
+        type:
+          type: string
+          description: Hotspot type
+    HotspotAnnotation:
+      type: object
+      properties:
+        annotation:
+          type: array
+          items:
+            type: array
+            items:
+              $ref: '#/components/schemas/Hotspot'
+        license:
+          type: string
+    HrdScore:
+      type: object
+      properties:
+        fractionLoh:
+          type: number
+          description: Median HRD Fraction LOH
+          format: double
+        lst:
+          type: number
+          description: Median HRD LST
+          format: double
+        ntelomericAi:
+          type: number
+          description: Median HRD ntelomeric AI
+          format: double
+    Implication:
+      type: object
+      properties:
+        alterations:
+          type: array
+          items:
+            type: string
+        description:
+          type: string
+        levelOfEvidence:
+          type: string
+          enum:
+          - LEVEL_0
+          - LEVEL_1
+          - LEVEL_2
+          - LEVEL_2A
+          - LEVEL_2B
+          - LEVEL_3A
+          - LEVEL_3B
+          - LEVEL_4
+          - LEVEL_R1
+          - LEVEL_R2
+          - LEVEL_R3
+          - LEVEL_Px1
+          - LEVEL_Px2
+          - LEVEL_Px3
+          - LEVEL_Dx1
+          - LEVEL_Dx2
+          - LEVEL_Dx3
+          - "NO"
+        tumorType:
+          $ref: '#/components/schemas/TumorType'
+    IndicatorQueryResp:
+      type: object
+      properties:
+        alleleExist:
+          type: boolean
+          example: false
+        dataVersion:
+          type: string
+        diagnosticImplications:
+          type: array
+          items:
+            $ref: '#/components/schemas/Implication'
+        diagnosticSummary:
+          type: string
+        geneExist:
+          type: boolean
+          example: false
+        geneSummary:
+          type: string
+        highestDiagnosticImplicationLevel:
+          type: string
+          enum:
+          - LEVEL_0
+          - LEVEL_1
+          - LEVEL_2
+          - LEVEL_2A
+          - LEVEL_2B
+          - LEVEL_3A
+          - LEVEL_3B
+          - LEVEL_4
+          - LEVEL_R1
+          - LEVEL_R2
+          - LEVEL_R3
+          - LEVEL_Px1
+          - LEVEL_Px2
+          - LEVEL_Px3
+          - LEVEL_Dx1
+          - LEVEL_Dx2
+          - LEVEL_Dx3
+          - "NO"
+        highestPrognosticImplicationLevel:
+          type: string
+          enum:
+          - LEVEL_0
+          - LEVEL_1
+          - LEVEL_2
+          - LEVEL_2A
+          - LEVEL_2B
+          - LEVEL_3A
+          - LEVEL_3B
+          - LEVEL_4
+          - LEVEL_R1
+          - LEVEL_R2
+          - LEVEL_R3
+          - LEVEL_Px1
+          - LEVEL_Px2
+          - LEVEL_Px3
+          - LEVEL_Dx1
+          - LEVEL_Dx2
+          - LEVEL_Dx3
+          - "NO"
+        highestResistanceLevel:
+          type: string
+          enum:
+          - LEVEL_0
+          - LEVEL_1
+          - LEVEL_2
+          - LEVEL_2A
+          - LEVEL_2B
+          - LEVEL_3A
+          - LEVEL_3B
+          - LEVEL_4
+          - LEVEL_R1
+          - LEVEL_R2
+          - LEVEL_R3
+          - LEVEL_Px1
+          - LEVEL_Px2
+          - LEVEL_Px3
+          - LEVEL_Dx1
+          - LEVEL_Dx2
+          - LEVEL_Dx3
+          - "NO"
+        highestSensitiveLevel:
+          type: string
+          enum:
+          - LEVEL_0
+          - LEVEL_1
+          - LEVEL_2
+          - LEVEL_2A
+          - LEVEL_2B
+          - LEVEL_3A
+          - LEVEL_3B
+          - LEVEL_4
+          - LEVEL_R1
+          - LEVEL_R2
+          - LEVEL_R3
+          - LEVEL_Px1
+          - LEVEL_Px2
+          - LEVEL_Px3
+          - LEVEL_Dx1
+          - LEVEL_Dx2
+          - LEVEL_Dx3
+          - "NO"
+        hotspot:
+          type: boolean
+          example: false
+        lastUpdate:
+          type: string
+        mutationEffect:
+          $ref: '#/components/schemas/MutationEffectResp'
+        oncogenic:
+          type: string
+        otherSignificantResistanceLevels:
+          type: array
+          items:
+            type: string
+            enum:
+            - LEVEL_0
+            - LEVEL_1
+            - LEVEL_2
+            - LEVEL_2A
+            - LEVEL_2B
+            - LEVEL_3A
+            - LEVEL_3B
+            - LEVEL_4
+            - LEVEL_R1
+            - LEVEL_R2
+            - LEVEL_R3
+            - LEVEL_Px1
+            - LEVEL_Px2
+            - LEVEL_Px3
+            - LEVEL_Dx1
+            - LEVEL_Dx2
+            - LEVEL_Dx3
+            - "NO"
+        otherSignificantSensitiveLevels:
+          type: array
+          items:
+            type: string
+            enum:
+            - LEVEL_0
+            - LEVEL_1
+            - LEVEL_2
+            - LEVEL_2A
+            - LEVEL_2B
+            - LEVEL_3A
+            - LEVEL_3B
+            - LEVEL_4
+            - LEVEL_R1
+            - LEVEL_R2
+            - LEVEL_R3
+            - LEVEL_Px1
+            - LEVEL_Px2
+            - LEVEL_Px3
+            - LEVEL_Dx1
+            - LEVEL_Dx2
+            - LEVEL_Dx3
+            - "NO"
+        prognosticImplications:
+          type: array
+          items:
+            $ref: '#/components/schemas/Implication'
+        prognosticSummary:
+          type: string
+        query:
+          $ref: '#/components/schemas/Query'
+        treatments:
+          type: array
+          items:
+            $ref: '#/components/schemas/IndicatorQueryTreatment'
+        tumorTypeSummary:
+          type: string
+        variantExist:
+          type: boolean
+          example: false
+        variantSummary:
+          type: string
+        vus:
+          type: boolean
+          example: false
+    IndicatorQueryTreatment:
+      type: object
+      properties:
+        abstracts:
+          type: array
+          items:
+            $ref: '#/components/schemas/ArticleAbstract'
+        alterations:
+          type: array
+          items:
+            type: string
+        approvedIndications:
+          type: array
+          items:
+            type: string
+        description:
+          type: string
+        drugs:
+          type: array
+          items:
+            $ref: '#/components/schemas/Drug'
+        fdaApproved:
+          type: boolean
+          example: false
+        level:
+          type: string
+          enum:
+          - LEVEL_0
+          - LEVEL_1
+          - LEVEL_2
+          - LEVEL_2A
+          - LEVEL_2B
+          - LEVEL_3A
+          - LEVEL_3B
+          - LEVEL_4
+          - LEVEL_R1
+          - LEVEL_R2
+          - LEVEL_R3
+          - LEVEL_Px1
+          - LEVEL_Px2
+          - LEVEL_Px3
+          - LEVEL_Dx1
+          - LEVEL_Dx2
+          - LEVEL_Dx3
+          - "NO"
+        levelAssociatedCancerType:
+          $ref: '#/components/schemas/TumorType'
+        pmids:
+          type: array
+          items:
+            type: string
+    IntegerRange:
+      type: object
+      properties:
+        end:
+          type: integer
+          format: int32
+        start:
+          type: integer
+          format: int32
+    IntergenicConsequences:
+      required:
+      - consequenceTerms
+      - impact
+      - variantAllele
+      type: object
+      properties:
+        impact:
+          type: string
+          description: impact
+        variantAllele:
+          type: string
+          description: variant_allele
+        consequenceTerms:
+          type: array
+          description: consequence_terms
+          items:
+            type: string
+    MainType:
+      type: object
+      properties:
+        id:
+          type: integer
+          format: int32
+        name:
+          type: string
+        tumorForm:
+          type: string
+          enum:
+          - SOLID
+          - LIQUID
+      description: OncoTree Cancer Type
+    MutationAssessor:
+      required:
+      - input
+      type: object
+      properties:
+        codonStartPosition:
+          type: string
+          description: Codon start position
+        cosmicCount:
+          type: integer
+          description: Number of mutations in COSMIC for this protein
+          format: int32
+        functionalImpact:
+          type: string
+          description: Functional impact
+        functionalImpactScore:
+          type: number
+          description: Functional impact score
+          format: double
+        hgvs:
+          type: string
+        hugoSymbol:
+          type: string
+          description: Hugo gene symbol
+        input:
+          type: string
+          description: User-input variants
+        mappingIssue:
+          type: string
+          description: Mapping issue info
+        msaGaps:
+          type: number
+          description: Portion of gaps in variant position in multiple sequence alignment
+          format: double
+        msaHeight:
+          type: integer
+          description: Number of diverse sequences in multiple sequence alignment
+            (identical or highly similar sequences filtered out)
+          format: int32
+        msaLink:
+          type: string
+          description: Link to multiple sequence alignment
+        pdbLink:
+          type: string
+          description: Link to 3d structure browser
+        referenceGenomeVariant:
+          type: string
+          description: Reference genome variant
+        referenceGenomeVariantType:
+          type: string
+          description: Reference genome variant type
+        refseqId:
+          type: string
+          description: Refseq protein ID
+        refseqPosition:
+          type: integer
+          description: "Variant position in Refseq protein, can be different from\
+            \ the one in Uniprot"
+          format: int32
+        refseqResidue:
+          type: string
+          description: "Reference residue in Refseq protein, can be different from\
+            \ the one in Uniprot"
+        snpCount:
+          type: integer
+          description: Number of SNPs in dbSNP for this protein
+          format: int32
+        uniprotId:
+          type: string
+          description: Uniprot protein accession ID
+        uniprotPosition:
+          type: integer
+          description: "Variant position in Uniprot protein, can be different from\
+            \ the one in Refseq"
+          format: int32
+        uniprotResidue:
+          type: string
+          description: "Reference residue in Uniprot protein, can be different from\
+            \ the one in Refseq"
+        variant:
+          type: string
+          description: Amino acid substitution
+        variantConservationScore:
+          type: number
+          description: Variant conservation score
+          format: double
+        variantSpecificityScore:
+          type: number
+          description: Variant specificity score
+          format: double
+    MutationAssessorAnnotation:
+      type: object
+      properties:
+        annotation:
+          $ref: '#/components/schemas/MutationAssessor'
+        license:
+          type: string
+    MutationEffectResp:
+      type: object
+      properties:
+        citations:
+          $ref: '#/components/schemas/Citations'
+        description:
+          type: string
+        knownEffect:
+          type: string
+    Mutdb:
+      type: object
+      properties:
+        alt:
+          type: string
+          description: alt
+        chrom:
+          type: string
+          description: chrom
+        cosmicId:
+          type: string
+          description: cosmic_id
+        hg19:
+          $ref: '#/components/schemas/Hg19'
+        mutpredScore:
+          type: number
+          description: mutpred_score
+          format: double
+        ref:
+          type: string
+          description: ref
+        rsid:
+          type: string
+          description: rsid
+        uniprotId:
+          type: string
+          description: uniprot_id
+    MyVariantInfo:
+      type: object
+      properties:
+        clinVar:
+          $ref: '#/components/schemas/ClinVar'
+        cosmic:
+          $ref: '#/components/schemas/Cosmic'
+        dbsnp:
+          $ref: '#/components/schemas/Dbsnp'
+        gnomadExome:
+          $ref: '#/components/schemas/Gnomad'
+        gnomadGenome:
+          $ref: '#/components/schemas/Gnomad'
+        hgvs:
+          type: string
+          description: hgvs
+        mutdb:
+          $ref: '#/components/schemas/Mutdb'
+        query:
+          type: string
+        snpeff:
+          $ref: '#/components/schemas/Snpeff'
+        variant:
+          type: string
+          description: variant
+        vcf:
+          $ref: '#/components/schemas/Vcf'
+        version:
+          type: integer
+          description: version
+          format: int32
+    MyVariantInfoAnnotation:
+      type: object
+      properties:
+        annotation:
+          $ref: '#/components/schemas/MyVariantInfo'
+        license:
+          type: string
+    NucleotideContext:
+      required:
+      - seq
+      type: object
+      properties:
+        hgvs:
+          type: string
+        id:
+          type: string
+        molecule:
+          type: string
+        query:
+          type: string
+        seq:
+          type: string
+          description: Nucleotide context sequence
+    NucleotideContextAnnotation:
+      type: object
+      properties:
+        annotation:
+          $ref: '#/components/schemas/NucleotideContext'
+        license:
+          type: string
+    OncokbAnnotation:
+      type: object
+      properties:
+        annotation:
+          $ref: '#/components/schemas/IndicatorQueryResp'
+        license:
+          type: string
+    PdbHeader:
+      required:
+      - pdbId
+      - title
+      type: object
+      properties:
+        compound:
+          type: object
+          properties: {}
+        pdbId:
+          type: string
+          description: PDB id
+        source:
+          type: object
+          properties: {}
+        title:
+          type: string
+          description: PDB description
+    PfamDomain:
+      required:
+      - name
+      - pfamAccession
+      type: object
+      properties:
+        description:
+          type: string
+          description: PFAM domain description
+        name:
+          type: string
+          description: PFAM domain name
+        pfamAccession:
+          type: string
+          description: PFAM domain accession
+    PfamDomainRange:
+      required:
+      - pfamDomainEnd
+      - pfamDomainId
+      - pfamDomainStart
+      type: object
+      properties:
+        pfamDomainId:
+          type: string
+          description: Pfam domain id
+        pfamDomainStart:
+          type: integer
+          description: Pfam domain start amino acid
+          format: int32
+        pfamDomainEnd:
+          type: integer
+          description: Pfam domain end amino acid
+          format: int32
+    PostTranslationalModification:
+      type: object
+      properties:
+        ensemblTranscriptIds:
+          type: array
+          items:
+            type: string
+        position:
+          type: integer
+          format: int32
+        pubmedIds:
+          type: array
+          items:
+            type: string
+        sequence:
+          type: string
+        type:
+          type: string
+        uniprotAccession:
+          type: string
+        uniprotEntry:
+          type: string
+    PtmAnnotation:
+      type: object
+      properties:
+        annotation:
+          type: array
+          items:
+            type: array
+            items:
+              $ref: '#/components/schemas/PostTranslationalModification'
+        license:
+          type: string
+    PtmFilter:
+      type: object
+      properties:
+        transcriptIds:
+          type: array
+          description: "List of Ensembl transcript IDs. For example [\"ENST00000361390\"\
+            , \"ENST00000361453\", \"ENST00000361624\"]"
+          items:
+            type: string
+    Query:
+      type: object
+      properties:
+        alteration:
+          type: string
+        alterationType:
+          type: string
+        consequence:
+          type: string
+        entrezGeneId:
+          type: integer
+          format: int32
+        hgvs:
+          type: string
+        hugoSymbol:
+          type: string
+        id:
+          type: string
+        proteinEnd:
+          type: integer
+          format: int32
+        proteinStart:
+          type: integer
+          format: int32
+        svType:
+          type: string
+          enum:
+          - DELETION
+          - TRANSLOCATION
+          - DUPLICATION
+          - INSERTION
+          - INVERSION
+          - FUSION
+          - UNKNOWN
+        tumorType:
+          type: string
+        type:
+          type: string
+    Rcv:
+      type: object
+      properties:
+        accession:
+          type: string
+          description: accession
+        clinicalSignificance:
+          type: string
+          description: clinical_significance
+        origin:
+          type: string
+          description: origin
+        preferredName:
+          type: string
+          description: preferred_name
+    SignalAnnotation:
+      type: object
+      properties:
+        annotation:
+          type: array
+          items:
+            $ref: '#/components/schemas/SignalMutation'
+        license:
+          type: string
+    SignalMutation:
+      type: object
+      properties:
+        biallelicCountsByTumorType:
+          type: array
+          description: Biallelic Counts by Tumor Type
+          items:
+            $ref: '#/components/schemas/CountByTumorType'
+        chromosome:
+          type: string
+          description: Chromosome
+        countsByTumorType:
+          type: array
+          description: Counts by Tumor Type
+          items:
+            $ref: '#/components/schemas/CountByTumorType'
+        endPosition:
+          type: integer
+          description: End Position
+          format: int64
+        generalPopulationStats:
+          $ref: '#/components/schemas/GeneralPopulationStats'
+        hugoGeneSymbol:
+          type: string
+          description: Hugo Gene Symbol
+        mskExperReview:
+          type: boolean
+          description: Msk Expert Review
+          example: false
+        mutationStatus:
+          type: string
+          description: Mutation Status
+        overallNumberOfGermlineHomozygous:
+          type: integer
+          format: int32
+        pathogenic:
+          type: string
+          description: Pathogenic
+        penetrance:
+          type: string
+          description: Penetrance
+        qcPassCountsByTumorType:
+          type: array
+          description: QC Pass Counts by Tumor Type
+          items:
+            $ref: '#/components/schemas/CountByTumorType'
+        referenceAllele:
+          type: string
+          description: Reference Allele
+        startPosition:
+          type: integer
+          description: Start Position
+          format: int64
+        statsByTumorType:
+          type: array
+          description: Stats By Tumor Type
+          items:
+            $ref: '#/components/schemas/StatsByTumorType'
+        variantAllele:
+          type: string
+          description: Variant Allele
+    SignalPopulationStats:
+      type: object
+      properties:
+        afr:
+          type: number
+          description: African/African American
+          format: double
+        asj:
+          type: number
+          description: Ashkenazi Jewish
+          format: double
+        asn:
+          type: number
+          description: Asian
+          format: double
+        eur:
+          type: number
+          description: European
+          format: double
+        impact:
+          type: number
+          description: Impact
+          format: double
+        oth:
+          type: number
+          description: Other
+          format: double
+    Snpeff:
+      type: object
+      properties:
+        license:
+          type: string
+          description: license
+    StatsByTumorType:
+      type: object
+      properties:
+        ageAtDx:
+          type: integer
+          description: Median Age at Dx
+          format: int32
+        fBiallelic:
+          type: number
+          description: Frequency Of Biallelic
+          format: double
+        fCancerTypeCount:
+          type: number
+          description: Frequency Of Cancer Type Count
+          format: double
+        hrdScore:
+          $ref: '#/components/schemas/HrdScore'
+        msiScore:
+          type: number
+          description: Msi Score
+          format: double
+        nCancerTypeCount:
+          type: integer
+          description: Number Of Cancer Type Count
+          format: int32
+        numberOfGermlineHomozygous:
+          type: integer
+          description: Number Of Germline Homozygous Per Tumor Type
+          format: int32
+        numberWithSig:
+          type: integer
+          description: Number of Variants with Signature
+          format: int32
+        tmb:
+          type: number
+          description: Median TMB
+          format: double
+        tumorType:
+          type: string
+          description: Tumor Type
+    TranscriptConsequence:
+      required:
+      - transcript_id
+      type: object
+      properties:
+        amino_acids:
+          type: string
+          description: Amino acids
+        canonical:
+          type: string
+          description: Canonical transcript indicator
+        codons:
+          type: string
+          description: Codons
+        consequence_terms:
+          type: array
+          description: List of consequence terms
+          items:
+            type: string
+        exon:
+          type: string
+        gene_id:
+          type: string
+          description: Ensembl gene id
+        gene_symbol:
+          type: string
+          description: Hugo gene symbol
+        hgnc_id:
+          type: string
+          description: HGNC id
+        hgvsc:
+          type: string
+          description: HGVSc
+        hgvsg:
+          type: string
+          description: HGVSg
+        hgvsp:
+          type: string
+          description: HGVSp
+        polyphen_prediction:
+          type: string
+          description: Polyphen Prediction
+        polyphen_score:
+          type: number
+          description: Polyphen Score
+          format: double
+        protein_end:
+          type: integer
+          description: Protein end position
+          format: int32
+        protein_id:
+          type: string
+          description: Ensembl protein id
+        protein_start:
+          type: integer
+          description: Protein start position
+          format: int32
+        refseq_transcript_ids:
+          type: array
+          description: List of RefSeq transcript ids
+          items:
+            type: string
+        sift_prediction:
+          type: string
+          description: Sift Prediction
+        sift_score:
+          type: number
+          description: Sift Score
+          format: double
+        transcript_id:
+          type: string
+          description: Ensembl transcript id
+        uniprotId:
+          type: string
+        variant_allele:
+          type: string
+          description: Variant allele
+    TranscriptConsequenceSummary:
+      required:
+      - transcriptId
+      type: object
+      properties:
+        aminoAcidAlt:
+          type: string
+          description: Alt Amino Acid
+        aminoAcidRef:
+          type: string
+          description: Reference Amino Acid
+        aminoAcids:
+          type: string
+          description: Amino acids change
+        codonChange:
+          type: string
+          description: Codon change
+        consequenceTerms:
+          type: string
+          description: Consequence terms (comma separated)
+        entrezGeneId:
+          type: string
+          description: Entrez gene id
+        exon:
+          type: string
+        hgvsc:
+          type: string
+          description: HGVSc
+        hgvsp:
+          type: string
+          description: HGVSp
+        hgvspShort:
+          type: string
+          description: HGVSp short
+        hugoGeneSymbol:
+          type: string
+          description: Hugo gene symbol
+        polyphenPrediction:
+          type: string
+          description: Polyphen Prediction
+        polyphenScore:
+          type: number
+          description: Polyphen Score
+          format: double
+        proteinPosition:
+          $ref: '#/components/schemas/IntegerRange'
+        refSeq:
+          type: string
+          description: RefSeq id
+        siftPrediction:
+          type: string
+          description: Sift Prediction
+        siftScore:
+          type: number
+          description: Sift Score
+          format: double
+        transcriptId:
+          type: string
+          description: Transcript id
+        uniprotId:
+          type: string
+          description: Uniprot ID
+        variantClassification:
+          type: string
+          description: Variant classification
+    TumorType:
+      type: object
+      properties:
+        children:
+          type: object
+          properties: {}
+        code:
+          type: string
+        color:
+          type: string
+        id:
+          type: integer
+          format: int32
+        level:
+          type: integer
+          format: int32
+        mainType:
+          $ref: '#/components/schemas/MainType'
+        name:
+          type: string
+        parent:
+          type: string
+        tissue:
+          type: string
+        tumorForm:
+          type: string
+          enum:
+          - SOLID
+          - LIQUID
+      description: OncoTree Detailed Cancer Type
+    UntranslatedRegion:
+      required:
+      - end
+      - start
+      - strand
+      - type
+      type: object
+      properties:
+        type:
+          type: string
+          description: UTR Type
+        start:
+          type: integer
+          description: Start position of UTR
+          format: int32
+        end:
+          type: integer
+          description: End position of UTR
+          format: int32
+        strand:
+          type: integer
+          description: "Strand UTR is on, -1 for - and 1 for +"
+          format: int32
+    VariantAnnotation:
+      required:
+      - id
+      - intergenic_consequences
+      - originalVariantQuery
+      - variant
+      type: object
+      properties:
+        allele_string:
+          type: string
+          description: "Allele string (e.g: A/T)"
+        annotationJSON:
+          type: string
+          description: Annotation data as JSON string
+        annotation_summary:
+          $ref: '#/components/schemas/VariantAnnotationSummary'
+        assembly_name:
+          type: string
+          description: NCBI build number
+        clinvar:
+          $ref: '#/components/schemas/ClinvarAnnotation'
+        colocatedVariants:
+          type: array
+          items:
+            $ref: '#/components/schemas/ColocatedVariant'
+        end:
+          type: integer
+          description: End position
+          format: int32
+        hgvsg:
+          type: string
+        hotspots:
+          $ref: '#/components/schemas/HotspotAnnotation'
+        id:
+          type: string
+          description: Variant id
+        intergenic_consequences:
+          type: array
+          description: intergenicConsequences
+          items:
+            $ref: '#/components/schemas/IntergenicConsequences'
+        most_severe_consequence:
+          type: string
+          description: Most severe consequence
+        mutation_assessor:
+          $ref: '#/components/schemas/MutationAssessorAnnotation'
+        my_variant_info:
+          $ref: '#/components/schemas/MyVariantInfoAnnotation'
+        nucleotide_context:
+          $ref: '#/components/schemas/NucleotideContextAnnotation'
+        oncokb:
+          $ref: '#/components/schemas/OncokbAnnotation'
+        originalVariantQuery:
+          type: string
+          description: Original variant query
+        ptms:
+          $ref: '#/components/schemas/PtmAnnotation'
+        seq_region_name:
+          type: string
+          description: Chromosome
+        signalAnnotation:
+          $ref: '#/components/schemas/SignalAnnotation'
+        start:
+          type: integer
+          description: Start position
+          format: int32
+        strand:
+          type: integer
+          description: Strand (negative or positive)
+          format: int32
+        successfully_annotated:
+          type: boolean
+          description: Status flag indicating whether variant was succesfully annotated
+          example: false
+        transcript_consequences:
+          type: array
+          description: List of transcripts
+          items:
+            $ref: '#/components/schemas/TranscriptConsequence'
+        variant:
+          type: string
+          description: Variant key
+    VariantAnnotationSummary:
+      required:
+      - transcriptConsequenceSummaries
+      - transcriptConsequenceSummary
+      - transcriptConsequences
+      - variant
+      type: object
+      properties:
+        assemblyName:
+          type: string
+          description: Assembly name
+        canonicalTranscriptId:
+          type: string
+          description: Canonical transcript id
+        genomicLocation:
+          $ref: '#/components/schemas/GenomicLocation'
+        strandSign:
+          type: string
+          description: Strand (- or +)
+        transcriptConsequenceSummaries:
+          type: array
+          description: All transcript consequence summaries
+          items:
+            $ref: '#/components/schemas/TranscriptConsequenceSummary'
+        transcriptConsequenceSummary:
+          $ref: '#/components/schemas/TranscriptConsequenceSummary'
+        transcriptConsequences:
+          type: array
+          description: "(Deprecated) Transcript consequence summaries (list of one\
+            \ when using annotation/, multiple when using annotation/summary/"
+          items:
+            $ref: '#/components/schemas/TranscriptConsequenceSummary'
+        variant:
+          type: string
+          description: Variant key
+        variantType:
+          type: string
+          description: Variant type
+    Vcf:
+      type: object
+      properties:
+        alt:
+          type: string
+          description: alt
+        position:
+          type: string
+          description: position
+        ref:
+          type: string
+          description: ref
+    Version:
+      type: object
+      properties:
+        version:
+          type: string
+x-original-swagger-version: "2.0"

aratrl-openapi/languagetool.yaml

@@ -0,0 +1,282 @@
+openapi: 3.0.1
+info:
+  title: LanguageTool API
+  description: Check texts for style and grammar issues with LanguageTool. See <a
+    href='http://wiki.languagetool.org/public-http-api'>our wiki</a> for access limitations.
+  version: 1.0.2
+servers:
+- url: http://localhost:30101/v2
+paths:
+  /check:
+    post:
+      summary: Check a text
+      description: The main feature - check a text with LanguageTool for possible
+        style and grammar issues.
+      operationId: check
+      requestBody:
+        content:
+          application/x-www-form-urlencoded:
+            schema:
+              required:
+              - language
+              type: object
+              properties:
+                text:
+                  type: string
+                  description: The text to be checked. This or 'data' is required.
+                data:
+                  type: string
+                  description: |-
+                    The text to be checked, given as a JSON document that specifies what's text and what's markup. This or 'text' is required. Markup will be ignored when looking for errors. Example text: <pre>A &lt;b>test&lt;/b></pre>JSON for the example text: <pre>{"annotation":[
+                     {"text": "A "},
+                     {"markup": "&lt;b>"},
+                     {"text": "test"},
+                     {"markup": "&lt;/b>"}
+                    ]}</pre> <p>If you have markup that should be interpreted as whitespace, like <tt>&lt;p&gt;</tt> in HTML, you can have it interpreted like this: <pre>{"markup": "&lt;p&gt;", "interpretAs": "\n\n"}</pre><p>The 'data' feature is not limited to HTML or XML, it can be used for any kind of markup.
+                language:
+                  type: string
+                  description: "A language code like `en-US`, `de-DE`, `fr`, or `auto`\
+                    \ to guess the language automatically (see `preferredVariants`\
+                    \ below). For languages with variants (English, German, Portuguese)\
+                    \ spell checking will only be activated when you specify the variant,\
+                    \ e.g. `en-GB` instead of just `en`."
+                altLanguages:
+                  type: string
+                  description: "EXPERIMENTAL: Comma-separated list of language codes\
+                    \ to check if a word is not similar to one of the main language\
+                    \ (parameter `language`). Unknown words that are similar to a\
+                    \ word from the main language will still be considered errors\
+                    \ but with type `Hint`. For languages with variants (English,\
+                    \ German, Portuguese) you need to specify the variant, e.g. `en-GB`\
+                    \ instead of just `en`."
+                motherTongue:
+                  type: string
+                  description: "A language code of the user's native language, enabling\
+                    \ false friends checks for some language pairs."
+                preferredVariants:
+                  type: string
+                  description: "Comma-separated list of preferred language variants.\
+                    \ The language detector used with `language=auto` can detect e.g.\
+                    \ English, but it cannot decide whether British English or American\
+                    \ English is used. Thus this parameter can be used to specify\
+                    \ the preferred variants like `en-GB` and `de-AT`. Only available\
+                    \ with `language=auto`."
+                enabledRules:
+                  type: string
+                  description: "IDs of rules to be enabled, comma-separated"
+                disabledRules:
+                  type: string
+                  description: "IDs of rules to be disabled, comma-separated"
+                enabledCategories:
+                  type: string
+                  description: "IDs of categories to be enabled, comma-separated"
+                disabledCategories:
+                  type: string
+                  description: "IDs of categories to be disabled, comma-separated"
+                enabledOnly:
+                  type: boolean
+                  description: "If true, only the rules and categories whose IDs are\
+                    \ specified with `enabledRules` or `enabledCategories` are enabled."
+                  default: false
+        required: true
+      responses:
+        "200":
+          description: the result of checking the text
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  software:
+                    required:
+                    - apiVersion
+                    - buildDate
+                    - name
+                    - version
+                    type: object
+                    properties:
+                      name:
+                        type: string
+                        description: Usually 'LanguageTool'.
+                      version:
+                        type: string
+                        description: A version string like '3.3' or '3.4-SNAPSHOT'.
+                      buildDate:
+                        type: string
+                        description: "Date when the software was built, e.g. '2016-05-25'."
+                      apiVersion:
+                        type: integer
+                        description: "Version of this API response. We don't expect\
+                          \ to make incompatible changes, so this can also be increased\
+                          \ for newly added fields."
+                      status:
+                        type: string
+                        description: "An optional warning, e.g. when the API format\
+                          \ is not stable."
+                      premium:
+                        type: boolean
+                        description: true if you're using a Premium account with all
+                          the premium text checks (since LanguageTool 4.2)
+                  language:
+                    required:
+                    - code
+                    - detectedLanguage
+                    - name
+                    type: object
+                    properties:
+                      name:
+                        type: string
+                        description: Language name like 'French' or 'English (US)'.
+                      code:
+                        type: string
+                        description: "ISO 639-1 code like 'en', 'en-US', or 'ca-ES-valencia'."
+                      detectedLanguage:
+                        required:
+                        - code
+                        - name
+                        type: object
+                        properties:
+                          name:
+                            type: string
+                            description: Language name like 'French' or 'English (US)'.
+                          code:
+                            type: string
+                            description: "ISO 639-1 code like 'en', 'en-US', or 'ca-ES-valencia'."
+                          confidence:
+                            type: number
+                            description: Estimate of the probability of the submitted
+                              text being in the detected language. Between 0 and 1.
+                        description: The automatically detected text language (might
+                          be different from the language actually used for checking).
+                    description: The language used for checking the text.
+                  matches:
+                    type: array
+                    items:
+                      required:
+                      - context
+                      - length
+                      - message
+                      - offset
+                      - replacements
+                      - sentence
+                      type: object
+                      properties:
+                        message:
+                          type: string
+                          description: Message about the error displayed to the user.
+                        shortMessage:
+                          type: string
+                          description: An optional shorter version of 'message'.
+                        offset:
+                          type: integer
+                          description: The 0-based character offset of the error in
+                            the text.
+                        length:
+                          type: integer
+                          description: The length of the error in characters.
+                        replacements:
+                          type: array
+                          description: "Replacements that might correct the error.\
+                            \ The array can be empty, in this case there is no suggested\
+                            \ replacement."
+                          items:
+                            type: object
+                            properties:
+                              value:
+                                type: string
+                                description: the replacement string
+                        context:
+                          required:
+                          - length
+                          - offset
+                          - text
+                          type: object
+                          properties:
+                            text:
+                              type: string
+                              description: "Context of the error, i.e. the error and\
+                                \ some text to the left and to the left."
+                            offset:
+                              type: integer
+                              description: The 0-based character offset of the error
+                                in the context text.
+                            length:
+                              type: integer
+                              description: The length of the error in characters in
+                                the context.
+                        sentence:
+                          type: string
+                          description: The sentence the error occurred in (since LanguageTool
+                            4.0 or later)
+                        rule:
+                          required:
+                          - category
+                          - description
+                          - id
+                          type: object
+                          properties:
+                            id:
+                              type: string
+                              description: An rule's identifier that's unique for
+                                this language.
+                            subId:
+                              type: string
+                              description: "An optional sub identifier of the rule,\
+                                \ used when several rules are grouped."
+                            description:
+                              type: string
+                            urls:
+                              type: array
+                              description: An optional array of URLs with a more detailed
+                                description of the error.
+                              items:
+                                type: object
+                                properties:
+                                  value:
+                                    type: string
+                                    description: the URL
+                            issueType:
+                              type: string
+                              description: "The <a href=\"http://www.w3.org/International/multilingualweb/lt/drafts/its20/its20.html#lqissue-typevalues\"\
+                                >Localization Quality Issue Type</a>. This is not\
+                                \ defined for all languages, in which case it will\
+                                \ always be 'Uncategorized'."
+                            category:
+                              type: object
+                              properties:
+                                id:
+                                  type: string
+                                  description: A category's identifier that's unique
+                                    for this language.
+                                name:
+                                  type: string
+                                  description: A short description of the category.
+  /languages:
+    get:
+      summary: Get a list of supported languages.
+      operationId: languages
+      responses:
+        "200":
+          description: An array of language objects.
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  required:
+                  - code
+                  - longCode
+                  - name
+                  type: object
+                  properties:
+                    name:
+                      type: string
+                      description: a language name like 'French' or 'English (Australia)'
+                    code:
+                      type: string
+                      description: a language code like 'en'
+                    longCode:
+                      type: string
+                      description: a language code like 'en-US' or 'ca-ES-valencia'
+components: {}
+x-original-swagger-version: "2.0"

aratrl-openapi/market.yaml

@@ -0,0 +1,2276 @@
+openapi: 3.0.3
+info:
+  title: Api Documentation
+  description: Api Documentation
+  termsOfService: urn:tos
+  contact: {}
+  license:
+    name: Apache 2.0
+    url: http://www.apache.org/licenses/LICENSE-2.0
+  version: '1.0'
+servers:
+  #- url: http://localhost:8081/products
+  #- url: http://localhost:8080
+  - url: http://localhost:30117
+    description: Inferred Url
+tags:
+  - name: backend-controller
+    description: Backend Controller
+  - name: basic-error-controller
+    description: Basic Error Controller
+  - name: cart-controller
+    description: Cart Controller
+  - name: checkout-controller
+    description: Checkout Controller
+  - name: customer-controller
+    description: Customer Controller
+  - name: distillery-controller
+    description: Distillery Controller
+  - name: frontend-controller
+    description: Frontend Controller
+  - name: orders-controller
+    description: Orders Controller
+  - name: product-controller
+    description: Product Controller
+  - name: region-controller
+    description: Region Controller
+  - name: showcase-controller
+    description: Showcase Controller
+  - name: storage-controller
+    description: Storage Controller
+paths:
+  /admin:
+    get:
+      tags:
+        - backend-controller
+      summary: index
+      operationId: indexUsingGET
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+  /admin/:
+    get:
+      tags:
+        - backend-controller
+      summary: index
+      operationId: indexUsingGET_1
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+  /admin/index:
+    get:
+      tags:
+        - backend-controller
+      summary: index
+      operationId: indexUsingGET_2
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+  /error:
+    get:
+      tags:
+        - basic-error-controller
+      summary: error
+      operationId: errorUsingGET
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: object
+                additionalProperties:
+                  type: object
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+    put:
+      tags:
+        - basic-error-controller
+      summary: error
+      operationId: errorUsingPUT
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: object
+                additionalProperties:
+                  type: object
+        '201':
+          description: Created
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+    post:
+      tags:
+        - basic-error-controller
+      summary: error
+      operationId: errorUsingPOST
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: object
+                additionalProperties:
+                  type: object
+        '201':
+          description: Created
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+    delete:
+      tags:
+        - basic-error-controller
+      summary: error
+      operationId: errorUsingDELETE
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: object
+                additionalProperties:
+                  type: object
+        '204':
+          description: No Content
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+    options:
+      tags:
+        - basic-error-controller
+      summary: error
+      operationId: errorUsingOPTIONS
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: object
+                additionalProperties:
+                  type: object
+        '204':
+          description: No Content
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+    head:
+      tags:
+        - basic-error-controller
+      summary: error
+      operationId: errorUsingHEAD
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: object
+                additionalProperties:
+                  type: object
+        '204':
+          description: No Content
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+    patch:
+      tags:
+        - basic-error-controller
+      summary: error
+      operationId: errorUsingPATCH
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: object
+                additionalProperties:
+                  type: object
+        '204':
+          description: No Content
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+    trace:
+      tags:
+        - basic-error-controller
+      summary: error
+      operationId: errorUsingTRACE
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: object
+                additionalProperties:
+                  type: object
+        '204':
+          description: No Content
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+  /cart:
+    get:
+      tags:
+        - cart-controller
+      summary: getCart
+      operationId: getCartUsingGET
+      parameters:
+        - name: cartItems[0].productId
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int64
+        - name: cartItems[0].quantity
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int32
+        - name: deliveryCost
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int32
+        - name: deliveryIncluded
+          in: query
+          required: false
+          style: form
+          schema:
+            type: boolean
+        - name: name
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+        - name: productsCost
+          in: query
+          required: false
+          style: form
+          schema:
+            type: number
+            format: double
+        - name: totalCost
+          in: query
+          required: false
+          style: form
+          schema:
+            type: number
+            format: double
+        - name: totalItems
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int32
+        - name: user
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+    put:
+      tags:
+        - cart-controller
+      summary: updateCartByAjax
+      operationId: updateCartByAjaxUsingPUT
+      parameters:
+        - name: cartItems[0].productId
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int64
+        - name: cartItems[0].quantity
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int32
+        - name: deliveryCost
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int32
+        - name: deliveryIncluded
+          in: query
+          required: false
+          style: form
+          schema:
+            type: boolean
+        - name: name
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+        - name: productsCost
+          in: query
+          required: false
+          style: form
+          schema:
+            type: number
+            format: double
+        - name: totalCost
+          in: query
+          required: false
+          style: form
+          schema:
+            type: number
+            format: double
+        - name: totalItems
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int32
+        - name: user
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CartItemDTOReq'
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/CartDTO'
+        '201':
+          description: Created
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+    post:
+      tags:
+        - cart-controller
+      summary: updateCartByForm
+      operationId: updateCartByFormUsingPOST
+      parameters:
+        - name: cartItems[0].productId
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int64
+        - name: cartItems[0].quantity
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int32
+        - name: deliveryCost
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int32
+        - name: deliveryIncluded
+          in: query
+          required: false
+          style: form
+          schema:
+            type: boolean
+        - name: name
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+        - name: productId
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int64
+        - name: productsCost
+          in: query
+          required: false
+          style: form
+          schema:
+            type: number
+            format: double
+        - name: quantity
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int32
+        - name: totalCost
+          in: query
+          required: false
+          style: form
+          schema:
+            type: number
+            format: double
+        - name: totalItems
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int32
+        - name: user
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '201':
+          description: Created
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+  /cart/clear:
+    post:
+      tags:
+        - cart-controller
+      summary: clearCart
+      operationId: clearCartUsingPOST
+      parameters:
+        - name: cartItems[0].productId
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int64
+        - name: cartItems[0].quantity
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int32
+        - name: deliveryCost
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int32
+        - name: deliveryIncluded
+          in: query
+          required: false
+          style: form
+          schema:
+            type: boolean
+        - name: name
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+        - name: productsCost
+          in: query
+          required: false
+          style: form
+          schema:
+            type: number
+            format: double
+        - name: totalCost
+          in: query
+          required: false
+          style: form
+          schema:
+            type: number
+            format: double
+        - name: totalItems
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int32
+        - name: user
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '201':
+          description: Created
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+  /cart/delivery/{delivery}:
+    put:
+      tags:
+        - cart-controller
+      summary: setDelivery
+      operationId: setDeliveryUsingPUT
+      parameters:
+        - name: cartItems[0].productId
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int64
+        - name: cartItems[0].quantity
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int32
+        - name: deliveryCost
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int32
+        - name: deliveryIncluded
+          in: query
+          required: false
+          style: form
+          schema:
+            type: boolean
+        - name: name
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+        - name: productsCost
+          in: query
+          required: false
+          style: form
+          schema:
+            type: number
+            format: double
+        - name: totalCost
+          in: query
+          required: false
+          style: form
+          schema:
+            type: number
+            format: double
+        - name: totalItems
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int32
+        - name: user
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+        - name: delivery
+          in: path
+          description: delivery
+          required: true
+          style: simple
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/CartDTO'
+        '201':
+          description: Created
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+  /checkout/confirmation:
+    get:
+      tags:
+        - checkout-controller
+      summary: getGratitude
+      operationId: getGratitudeUsingGET
+      parameters:
+        - name: name
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+  /checkout/details:
+    get:
+      tags:
+        - checkout-controller
+      summary: details
+      operationId: detailsUsingGET
+      parameters:
+        - name: name
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+    post:
+      tags:
+        - checkout-controller
+      summary: changeContacts
+      operationId: changeContactsUsingPOST
+      parameters:
+        - name: address
+          in: query
+          required: false
+          style: form
+          schema:
+            maximum: 100
+            minimum: 0
+            maxLength: 100
+            minLength: 0
+            pattern: ^[^#$%^*()']*$
+            type: string
+        - name: name
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+        - name: phone
+          in: query
+          required: false
+          style: form
+          schema:
+            maximum: 20
+            minimum: 0
+            maxLength: 20
+            minLength: 0
+            pattern: ^\+[1-9][0-9]?[\s]*\(?\d{3}\)?[-\s]?\d{3}[-\s]?\d{2}[-\s]?\d{2}$
+            type: string
+        - name: changeContacts
+          in: query
+          description: changeContacts
+          required: true
+          style: form
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '201':
+          description: Created
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+  /checkout/payment:
+    get:
+      tags:
+        - checkout-controller
+      summary: getPayment
+      operationId: getPaymentUsingGET
+      parameters:
+        - name: name
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+    post:
+      tags:
+        - checkout-controller
+      summary: postPayment
+      operationId: postPaymentUsingPOST
+      parameters:
+        - name: ccNumber
+          in: query
+          required: false
+          style: form
+          schema:
+            pattern: \b(?:\d[ -]*?){13,16}\b
+            type: string
+        - name: name
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '201':
+          description: Created
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+  /customer/new:
+    get:
+      tags:
+        - customer-controller
+      summary: getRegistrationPage
+      operationId: getRegistrationPageUsingGET
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+    post:
+      tags:
+        - customer-controller
+      summary: postRegistrationForm
+      operationId: postRegistrationFormUsingPOST
+      parameters:
+        - name: address
+          in: query
+          required: false
+          style: form
+          schema:
+            maximum: 100
+            minimum: 0
+            maxLength: 100
+            minLength: 0
+            pattern: ^[^#$%^*()']*$
+            type: string
+        - name: cartItems[0].productId
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int64
+        - name: cartItems[0].quantity
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int32
+        - name: deliveryCost
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int32
+        - name: deliveryIncluded
+          in: query
+          required: false
+          style: form
+          schema:
+            type: boolean
+        - name: email
+          in: query
+          required: false
+          style: form
+          schema:
+            maximum: 50
+            minimum: 0
+            maxLength: 50
+            minLength: 0
+            pattern: ^[\w-]+(\.[\w-]+)*@([\w-]+\.)+[a-zA-Z]+$
+            type: string
+        - name: name
+          in: query
+          required: false
+          style: form
+          schema:
+            maximum: 50
+            minimum: 0
+            maxLength: 50
+            minLength: 0
+            pattern: ^[\pL '-]+$
+            type: string
+        - name: password
+          in: query
+          required: false
+          style: form
+          schema:
+            maximum: 50
+            minimum: 6
+            maxLength: 50
+            minLength: 6
+            pattern: ^[a-zA-Z0-9]+$
+            type: string
+        - name: phone
+          in: query
+          required: false
+          style: form
+          schema:
+            maximum: 20
+            minimum: 0
+            maxLength: 20
+            minLength: 0
+            pattern: ^\+[1-9][0-9]?[\s]*\(?\d{3}\)?[-\s]?\d{3}[-\s]?\d{2}[-\s]?\d{2}$
+            type: string
+        - name: productsCost
+          in: query
+          required: false
+          style: form
+          schema:
+            type: number
+            format: double
+        - name: totalCost
+          in: query
+          required: false
+          style: form
+          schema:
+            type: number
+            format: double
+        - name: totalItems
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int32
+        - name: user
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '201':
+          description: Created
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+  /customer/orders:
+    get:
+      tags:
+        - customer-controller
+      summary: orders
+      operationId: ordersUsingGET
+      parameters:
+        - name: name
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+  /admin/distilleries:
+    get:
+      tags:
+        - distillery-controller
+      summary: allDistilleries
+      operationId: allDistilleriesUsingGET
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+  /admin/distilleries/new:
+    get:
+      tags:
+        - distillery-controller
+      summary: newDistillery
+      operationId: newDistilleryUsingGET
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+    post:
+      tags:
+        - distillery-controller
+      summary: postDistillery
+      operationId: postDistilleryUsingPOST
+      parameters:
+        - name: description
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+        - name: id
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int64
+        - name: region
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+        - name: title
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '201':
+          description: Created
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+  /admin/distilleries/{distilleryId}/delete:
+    post:
+      tags:
+        - distillery-controller
+      summary: deleteDistillery
+      operationId: deleteDistilleryUsingPOST
+      parameters:
+        - name: distilleryId
+          in: path
+          description: distilleryId
+          required: true
+          style: simple
+          schema:
+            type: integer
+            format: int64
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '201':
+          description: Created
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+  /admin/distilleries/{distilleryId}/edit:
+    get:
+      tags:
+        - distillery-controller
+      summary: editDistillery
+      operationId: editDistilleryUsingGET
+      parameters:
+        - name: distilleryId
+          in: path
+          description: distilleryId
+          required: true
+          style: simple
+          schema:
+            type: integer
+            format: int64
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+    post:
+      tags:
+        - distillery-controller
+      summary: putDistillery
+      operationId: putDistilleryUsingPOST
+      parameters:
+        - name: description
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+        - name: distilleryId
+          in: path
+          description: distilleryId
+          required: true
+          style: simple
+          schema:
+            type: integer
+            format: int64
+        - name: id
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int64
+        - name: region
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+        - name: title
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '201':
+          description: Created
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+  /:
+    get:
+      tags:
+        - frontend-controller
+      summary: index
+      operationId: indexUsingGET_3
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+  /index:
+    get:
+      tags:
+        - frontend-controller
+      summary: index
+      operationId: indexUsingGET_4
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+  /inside:
+    get:
+      tags:
+        - frontend-controller
+      summary: whatsInside
+      operationId: whatsInsideUsingGET
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+  /login:
+    get:
+      tags:
+        - frontend-controller
+      summary: login
+      operationId: loginUsingGET
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+  /rest-api:
+    get:
+      tags:
+        - frontend-controller
+      summary: restApi
+      operationId: restApiUsingGET
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+  /admin/orders:
+    get:
+      tags:
+        - orders-controller
+      summary: getOrders
+      operationId: getOrdersUsingGET
+      parameters:
+        - name: direct
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+        - name: page
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int32
+        - name: size
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int32
+        - name: sort
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+        - name: executed
+          in: query
+          description: executed
+          required: false
+          style: form
+          schema:
+            type: string
+        - name: created
+          in: query
+          description: created
+          required: false
+          style: form
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+  /admin/orders/{orderId}:
+    post:
+      tags:
+        - orders-controller
+      summary: setExecutionStatus
+      operationId: setExecutionStatusUsingPOST
+      parameters:
+        - name: orderId
+          in: path
+          description: orderId
+          required: true
+          style: simple
+          schema:
+            type: integer
+            format: int64
+        - name: executed
+          in: query
+          description: executed
+          required: true
+          style: form
+          schema:
+            type: boolean
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '201':
+          description: Created
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+  /admin/products:
+    get:
+      tags:
+        - product-controller
+      summary: getProducts
+      operationId: getProductsUsingGET
+      parameters:
+        - name: direct
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+        - name: page
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int32
+        - name: size
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int32
+        - name: sort
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+        - name: dist
+          in: query
+          description: dist
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int64
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+  /admin/products/new:
+    get:
+      tags:
+        - product-controller
+      summary: newProduct
+      operationId: newProductUsingGET
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+    post:
+      tags:
+        - product-controller
+      summary: postProduct
+      operationId: postProductUsingPOST
+      parameters:
+        - name: age
+          in: query
+          required: false
+          style: form
+          schema:
+            maximum: 2000
+            exclusiveMaximum: false
+            type: integer
+            format: int32
+        - name: alcohol
+          in: query
+          required: true
+          style: form
+          schema:
+            maximum: 96
+            exclusiveMaximum: false
+            minimum: 1
+            exclusiveMinimum: false
+            type: number
+            format: float
+        - name: available
+          in: query
+          required: false
+          style: form
+          schema:
+            type: boolean
+        - name: description
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+        - name: distillery
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+        - name: name
+          in: query
+          required: false
+          style: form
+          schema:
+            pattern: ^[^#$%^&*()']*$
+            type: string
+        - name: price
+          in: query
+          required: true
+          style: form
+          schema:
+            type: number
+            format: double
+        - name: productId
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int64
+        - name: volume
+          in: query
+          required: true
+          style: form
+          schema:
+            type: integer
+            format: int32
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '201':
+          description: Created
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+  /admin/products/{productId}/delete:
+    post:
+      tags:
+        - product-controller
+      summary: deleteProduct
+      operationId: deleteProductUsingPOST
+      parameters:
+        - name: productId
+          in: path
+          description: productId
+          required: true
+          style: simple
+          schema:
+            type: integer
+            format: int64
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '201':
+          description: Created
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+  /admin/products/{productId}/edit:
+    get:
+      tags:
+        - product-controller
+      summary: editProduct
+      operationId: editProductUsingGET
+      parameters:
+        - name: productId
+          in: path
+          description: productId
+          required: true
+          style: simple
+          schema:
+            type: integer
+            format: int64
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+    post:
+      tags:
+        - product-controller
+      summary: putProduct
+      operationId: putProductUsingPOST
+      parameters:
+        - name: age
+          in: query
+          required: false
+          style: form
+          schema:
+            maximum: 2000
+            exclusiveMaximum: false
+            type: integer
+            format: int32
+        - name: alcohol
+          in: query
+          required: true
+          style: form
+          schema:
+            maximum: 96
+            exclusiveMaximum: false
+            minimum: 1
+            exclusiveMinimum: false
+            type: number
+            format: float
+        - name: available
+          in: query
+          required: false
+          style: form
+          schema:
+            type: boolean
+        - name: description
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+        - name: distillery
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+        - name: name
+          in: query
+          required: false
+          style: form
+          schema:
+            pattern: ^[^#$%^&*()']*$
+            type: string
+        - name: price
+          in: query
+          required: true
+          style: form
+          schema:
+            type: number
+            format: double
+        - name: productId
+          in: path
+          description: productId
+          required: true
+          style: simple
+          schema:
+            type: integer
+            format: int64
+        - name: volume
+          in: query
+          required: true
+          style: form
+          schema:
+            type: integer
+            format: int32
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '201':
+          description: Created
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+  /admin/regions:
+    get:
+      tags:
+        - region-controller
+      summary: allRegions
+      operationId: allRegionsUsingGET
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+  /admin/regions/new:
+    get:
+      tags:
+        - region-controller
+      summary: newRegion
+      operationId: newRegionUsingGET
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+    post:
+      tags:
+        - region-controller
+      summary: postRegion
+      operationId: postRegionUsingPOST
+      parameters:
+        - name: color
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+        - name: description
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+        - name: id
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int64
+        - name: name
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+        - name: subtitle
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '201':
+          description: Created
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+  /admin/regions/{regionId}/delete:
+    post:
+      tags:
+        - region-controller
+      summary: deleteRegion
+      operationId: deleteRegionUsingPOST
+      parameters:
+        - name: regionId
+          in: path
+          description: regionId
+          required: true
+          style: simple
+          schema:
+            type: integer
+            format: int64
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '201':
+          description: Created
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+  /admin/regions/{regionId}/edit:
+    get:
+      tags:
+        - region-controller
+      summary: editRegion
+      operationId: editRegionUsingGET
+      parameters:
+        - name: regionId
+          in: path
+          description: regionId
+          required: true
+          style: simple
+          schema:
+            type: integer
+            format: int64
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+    post:
+      tags:
+        - region-controller
+      summary: putRegion
+      operationId: putRegionUsingPOST
+      parameters:
+        - name: color
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+        - name: description
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+        - name: id
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int64
+        - name: name
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+        - name: regionId
+          in: path
+          description: regionId
+          required: true
+          style: simple
+          schema:
+            type: integer
+            format: int64
+        - name: subtitle
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '201':
+          description: Created
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+  /regions/{regionId}:
+    get:
+      tags:
+        - showcase-controller
+      summary: getRegionProducts
+      operationId: getRegionProductsUsingGET
+      parameters:
+        - name: direct
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+        - name: page
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int32
+        - name: regionId
+          in: path
+          description: regionId
+          required: true
+          style: simple
+          schema:
+            type: integer
+            format: int64
+        - name: size
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int32
+        - name: sort
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+        - name: dist
+          in: query
+          description: dist
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int64
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+  /admin/storage:
+    get:
+      tags:
+        - storage-controller
+      summary: getStorageUnits
+      operationId: getStorageUnitsUsingGET
+      parameters:
+        - name: direct
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+        - name: page
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int32
+        - name: size
+          in: query
+          required: false
+          style: form
+          schema:
+            type: integer
+            format: int32
+        - name: sort
+          in: query
+          required: false
+          style: form
+          schema:
+            type: string
+        - name: available
+          in: query
+          description: available
+          required: false
+          style: form
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+    post:
+      tags:
+        - storage-controller
+      summary: postStorage
+      operationId: postStorageUsingPOST
+      parameters:
+        - name: productsIds
+          in: query
+          description: productsIds
+          required: false
+          style: form
+          explode: true
+          schema:
+            type: integer
+            format: int64
+        - name: availableProductsIds
+          in: query
+          description: availableProductsIds
+          required: false
+          style: form
+          explode: true
+          schema:
+            type: integer
+            format: int64
+      responses:
+        '200':
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        '201':
+          description: Created
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+components:
+  schemas:
+    CartDTO:
+      title: CartDTO
+      type: object
+      properties:
+        _links:
+          $ref: '#/components/schemas/Links'
+        cartItems:
+          type: array
+          items:
+            $ref: '#/components/schemas/CartItemDTORes'
+        deliveryCost:
+          type: integer
+          format: int32
+        deliveryIncluded:
+          type: boolean
+        empty:
+          type: boolean
+        productsCost:
+          type: number
+          format: double
+        totalCost:
+          type: number
+          format: double
+        totalItems:
+          type: integer
+          format: int32
+        user:
+          type: string
+    CartItemDTOReq:
+      title: CartItemDTOReq
+      type: object
+      properties:
+        _links:
+          type: array
+          items:
+            $ref: '#/components/schemas/Link'
+        productId:
+          type: integer
+          format: int64
+        quantity:
+          type: integer
+          format: int32
+    CartItemDTORes:
+      title: CartItemDTORes
+      type: object
+      properties:
+        _links:
+          $ref: '#/components/schemas/Links'
+        productId:
+          type: integer
+          format: int64
+        quantity:
+          type: integer
+          format: int32
+    Link:
+      title: Link
+      type: object
+      properties:
+        deprecation:
+          type: string
+        href:
+          type: string
+        hreflang:
+          type: string
+        media:
+          type: string
+        name:
+          type: string
+        profile:
+          type: string
+        rel:
+          $ref: '#/components/schemas/LinkRelation'
+        title:
+          type: string
+        type:
+          type: string
+    LinkRelation:
+      title: LinkRelation
+      type: object
+    Links:
+      title: Links
+      type: object
+      properties:
+        empty:
+          type: boolean
+    ModelAndView:
+      title: ModelAndView
+      type: object
+      properties:
+        empty:
+          type: boolean
+        model:
+          type: object
+        modelMap:
+          type: object
+          additionalProperties:
+            type: object
+        reference:
+          type: boolean
+        status:
+          type: string
+          enum:
+            - ACCEPTED
+            - ALREADY_REPORTED
+            - BAD_GATEWAY
+            - BAD_REQUEST
+            - BANDWIDTH_LIMIT_EXCEEDED
+            - CHECKPOINT
+            - CONFLICT
+            - CONTINUE
+            - CREATED
+            - DESTINATION_LOCKED
+            - EXPECTATION_FAILED
+            - FAILED_DEPENDENCY
+            - FORBIDDEN
+            - FOUND
+            - GATEWAY_TIMEOUT
+            - GONE
+            - HTTP_VERSION_NOT_SUPPORTED
+            - IM_USED
+            - INSUFFICIENT_SPACE_ON_RESOURCE
+            - INSUFFICIENT_STORAGE
+            - INTERNAL_SERVER_ERROR
+            - I_AM_A_TEAPOT
+            - LENGTH_REQUIRED
+            - LOCKED
+            - LOOP_DETECTED
+            - METHOD_FAILURE
+            - METHOD_NOT_ALLOWED
+            - MOVED_PERMANENTLY
+            - MOVED_TEMPORARILY
+            - MULTIPLE_CHOICES
+            - MULTI_STATUS
+            - NETWORK_AUTHENTICATION_REQUIRED
+            - NON_AUTHORITATIVE_INFORMATION
+            - NOT_ACCEPTABLE
+            - NOT_EXTENDED
+            - NOT_FOUND
+            - NOT_IMPLEMENTED
+            - NOT_MODIFIED
+            - NO_CONTENT
+            - OK
+            - PARTIAL_CONTENT
+            - PAYLOAD_TOO_LARGE
+            - PAYMENT_REQUIRED
+            - PERMANENT_REDIRECT
+            - PRECONDITION_FAILED
+            - PRECONDITION_REQUIRED
+            - PROCESSING
+            - PROXY_AUTHENTICATION_REQUIRED
+            - REQUESTED_RANGE_NOT_SATISFIABLE
+            - REQUEST_ENTITY_TOO_LARGE
+            - REQUEST_HEADER_FIELDS_TOO_LARGE
+            - REQUEST_TIMEOUT
+            - REQUEST_URI_TOO_LONG
+            - RESET_CONTENT
+            - SEE_OTHER
+            - SERVICE_UNAVAILABLE
+            - SWITCHING_PROTOCOLS
+            - TEMPORARY_REDIRECT
+            - TOO_EARLY
+            - TOO_MANY_REQUESTS
+            - UNAUTHORIZED
+            - UNAVAILABLE_FOR_LEGAL_REASONS
+            - UNPROCESSABLE_ENTITY
+            - UNSUPPORTED_MEDIA_TYPE
+            - UPGRADE_REQUIRED
+            - URI_TOO_LONG
+            - USE_PROXY
+            - VARIANT_ALSO_NEGOTIATES
+        view:
+          $ref: '#/components/schemas/View'
+        viewName:
+          type: string
+    View:
+      title: View
+      type: object
+      properties:
+        contentType:
+          type: string

aratrl-openapi/market2.yaml

@@ -0,0 +1,693 @@
+openapi: 3.0.1
+info:
+  title: Api Documentation
+  description: Api Documentation
+  termsOfService: urn:tos
+  contact: {}
+  license:
+    name: Apache 2.0
+    url: http://www.apache.org/licenses/LICENSE-2.0
+  version: "1.0"
+servers:
+   #- url: http://localhost:30117
+   - url: http://localhost:50117
+tags:
+- name: cart-rest-controller
+  description: Cart Rest Controller
+- name: contacts-rest-controller
+  description: Contacts Rest Controller
+- name: customer-rest-controller
+  description: Customer Rest Controller
+- name: orders-rest-controller
+  description: Orders Rest Controller
+- name: products-rest-controller
+  description: Products Rest Controller
+paths:
+  /customer:
+    get:
+      tags:
+      - customer-rest-controller
+      summary: getCustomer
+      operationId: getCustomerUsingGET
+      parameters:
+      - name: name
+        in: query
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/UserDTORes'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+  /customer/cart:
+    get:
+      tags:
+      - cart-rest-controller
+      summary: getCart
+      operationId: getCartUsingGET
+      parameters:
+      - name: name
+        in: query
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/CartDTO'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+    put:
+      tags:
+      - cart-rest-controller
+      summary: addItem
+      operationId: addItemUsingPUT
+      parameters:
+      - name: name
+        in: query
+        schema:
+          type: string
+      requestBody:
+        description: item
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CartItemDTOReq'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/CartDTO'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      x-codegen-request-body-name: item
+    delete:
+      tags:
+      - cart-rest-controller
+      summary: clearCart
+      operationId: clearCartUsingDELETE
+      parameters:
+      - name: name
+        in: query
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/CartDTO'
+        "204":
+          description: No Content
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+  /customer/cart/delivery:
+    put:
+      tags:
+      - cart-rest-controller
+      summary: setDelivery
+      operationId: setDeliveryUsingPUT
+      parameters:
+      - name: included
+        in: query
+        description: included
+        required: true
+        schema:
+          type: boolean
+      - name: name
+        in: query
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/CartDTO'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+  /customer/cart/pay:
+    post:
+      tags:
+      - cart-rest-controller
+      summary: payByCard
+      operationId: payByCardUsingPOST
+      parameters:
+      - name: name
+        in: query
+        schema:
+          type: string
+      requestBody:
+        description: card
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CreditCardDTO'
+        required: true
+      responses:
+        "201":
+          description: Created
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/OrderDTO'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      x-codegen-request-body-name: card
+  /customer/contacts:
+    get:
+      tags:
+      - contacts-rest-controller
+      summary: getContacts
+      operationId: getContactsUsingGET
+      parameters:
+      - name: name
+        in: query
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/ContactsDTORes'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+    put:
+      tags:
+      - contacts-rest-controller
+      summary: updateContacts
+      operationId: updateContactsUsingPUT
+      parameters:
+      - name: name
+        in: query
+        schema:
+          type: string
+      requestBody:
+        description: contactsDto
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/ContactsDTOReq'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/ContactsDTORes'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      x-codegen-request-body-name: contactsDto
+  /customer/orders:
+    get:
+      tags:
+      - orders-rest-controller
+      summary: getOrders
+      operationId: getOrdersUsingGET
+      parameters:
+      - name: name
+        in: query
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/OrderDTO'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+  /customer/orders/{orderId}:
+    get:
+      tags:
+      - orders-rest-controller
+      summary: getOrder
+      operationId: getOrderUsingGET
+      parameters:
+      - name: name
+        in: query
+        schema:
+          type: string
+      - name: orderId
+        in: path
+        description: orderId
+        required: true
+        schema:
+          type: integer
+          format: int64
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/OrderDTO'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+  /products:
+    get:
+      tags:
+      - products-rest-controller
+      summary: getProducts
+      operationId: getProductsUsingGET
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/ProductDTO'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+  /products/{productId}:
+    get:
+      tags:
+      - products-rest-controller
+      summary: getProduct
+      operationId: getProductUsingGET
+      parameters:
+      - name: productId
+        in: path
+        description: productId
+        required: true
+        schema:
+          type: integer
+          format: int64
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/ProductDTO'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+  /register:
+    post:
+      tags:
+      - customer-rest-controller
+      summary: createCustomer
+      operationId: createCustomerUsingPOST
+      requestBody:
+        description: user
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/UserDTOReq'
+        required: true
+      responses:
+        "201":
+          description: Created
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/UserDTORes'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      x-codegen-request-body-name: user
+components:
+  schemas:
+    CartDTO:
+      title: CartDTO
+      type: object
+      properties:
+        _links:
+          $ref: '#/components/schemas/Links'
+        cartItems:
+          type: array
+          items:
+            $ref: '#/components/schemas/CartItemDTORes'
+        deliveryCost:
+          type: integer
+          format: int32
+        deliveryIncluded:
+          type: boolean
+        empty:
+          type: boolean
+        productsCost:
+          type: number
+          format: double
+        totalCost:
+          type: number
+          format: double
+        totalItems:
+          type: integer
+          format: int32
+        user:
+          type: string
+    CartItemDTOReq:
+      title: CartItemDTOReq
+      type: object
+      properties:
+        _links:
+          type: array
+          items:
+            $ref: '#/components/schemas/Link'
+        productId:
+          type: integer
+          format: int64
+        quantity:
+          type: integer
+          format: int32
+    CartItemDTORes:
+      title: CartItemDTORes
+      type: object
+      properties:
+        _links:
+          $ref: '#/components/schemas/Links'
+        productId:
+          type: integer
+          format: int64
+        quantity:
+          type: integer
+          format: int32
+    ContactsDTOReq:
+      title: ContactsDTOReq
+      type: object
+      properties:
+        _links:
+          type: array
+          items:
+            $ref: '#/components/schemas/Link'
+        address:
+          maxLength: 100
+          minLength: 0
+          pattern: "^[^#$%^*()']*$"
+          type: string
+        phone:
+          maxLength: 20
+          minLength: 0
+          pattern: "^\\+[1-9][0-9]?[\\s]*\\(?\\d{3}\\)?[-\\s]?\\d{3}[-\\s]?\\d{2}[-\\\
+            s]?\\d{2}$"
+          type: string
+    ContactsDTORes:
+      title: ContactsDTORes
+      type: object
+      properties:
+        _links:
+          $ref: '#/components/schemas/Links'
+        address:
+          maxLength: 100
+          minLength: 0
+          pattern: "^[^#$%^*()']*$"
+          type: string
+        phone:
+          maxLength: 20
+          minLength: 0
+          pattern: "^\\+[1-9][0-9]?[\\s]*\\(?\\d{3}\\)?[-\\s]?\\d{3}[-\\s]?\\d{2}[-\\\
+            s]?\\d{2}$"
+          type: string
+    CreditCardDTO:
+      title: CreditCardDTO
+      type: object
+      properties:
+        ccNumber:
+          pattern: "\\b(?:\\d[ -]*?){13,16}\\b"
+          type: string
+    Link:
+      title: Link
+      type: object
+      properties:
+        deprecation:
+          type: string
+        href:
+          type: string
+        hreflang:
+          type: string
+        media:
+          type: string
+        name:
+          type: string
+        profile:
+          type: string
+        rel:
+          $ref: '#/components/schemas/LinkRelation'
+        title:
+          type: string
+        type:
+          type: string
+    LinkRelation:
+      title: LinkRelation
+      type: object
+    Links:
+      title: Links
+      type: object
+      properties:
+        empty:
+          type: boolean
+    OrderDTO:
+      title: OrderDTO
+      type: object
+      properties:
+        _links:
+          $ref: '#/components/schemas/Links'
+        billNumber:
+          type: integer
+          format: int32
+        dateCreated:
+          type: string
+          format: date-time
+        deliveryCost:
+          type: integer
+          format: int32
+        deliveryIncluded:
+          type: boolean
+        executed:
+          type: boolean
+        id:
+          type: integer
+          format: int64
+        payed:
+          type: boolean
+        productsCost:
+          type: number
+          format: double
+        totalCost:
+          type: number
+          format: double
+        userAccount:
+          type: string
+    ProductDTO:
+      title: ProductDTO
+      required:
+      - alcohol
+      - price
+      - volume
+      type: object
+      properties:
+        _links:
+          $ref: '#/components/schemas/Links'
+        age:
+          maximum: 2000
+          exclusiveMaximum: false
+          type: integer
+          format: int32
+        alcohol:
+          maximum: 96
+          exclusiveMaximum: false
+          minimum: 1
+          exclusiveMinimum: false
+          type: number
+          format: float
+        available:
+          type: boolean
+        description:
+          type: string
+        distillery:
+          type: string
+        name:
+          pattern: "^[^#$%^&*()']*$"
+          type: string
+        price:
+          type: number
+          format: double
+        productId:
+          type: integer
+          format: int64
+        volume:
+          type: integer
+          format: int32
+    UserDTOReq:
+      title: UserDTOReq
+      type: object
+      properties:
+        _links:
+          type: array
+          items:
+            $ref: '#/components/schemas/Link'
+        address:
+          maxLength: 100
+          minLength: 0
+          pattern: "^[^#$%^*()']*$"
+          type: string
+        email:
+          maxLength: 50
+          minLength: 0
+          pattern: "^[\\w-]+(\\.[\\w-]+)*@([\\w-]+\\.)+[a-zA-Z]+$"
+          type: string
+        name:
+          maxLength: 50
+          minLength: 0
+          pattern: "^[\\pL '-]+$"
+          type: string
+        password:
+          maxLength: 50
+          minLength: 6
+          pattern: "^[a-zA-Z0-9]+$"
+          type: string
+        phone:
+          maxLength: 20
+          minLength: 0
+          pattern: "^\\+[1-9][0-9]?[\\s]*\\(?\\d{3}\\)?[-\\s]?\\d{3}[-\\s]?\\d{2}[-\\\
+            s]?\\d{2}$"
+          type: string
+    UserDTORes:
+      title: UserDTORes
+      type: object
+      properties:
+        _links:
+          $ref: '#/components/schemas/Links'
+        address:
+          maxLength: 100
+          minLength: 0
+          pattern: "^[^#$%^*()']*$"
+          type: string
+        email:
+          maxLength: 50
+          minLength: 0
+          pattern: "^[\\w-]+(\\.[\\w-]+)*@([\\w-]+\\.)+[a-zA-Z]+$"
+          type: string
+        name:
+          maxLength: 50
+          minLength: 0
+          pattern: "^[\\pL '-]+$"
+          type: string
+        password:
+          maxLength: 50
+          minLength: 6
+          pattern: "^[a-zA-Z0-9]+$"
+          type: string
+        phone:
+          maxLength: 20
+          minLength: 0
+          pattern: "^\\+[1-9][0-9]?[\\s]*\\(?\\d{3}\\)?[-\\s]?\\d{3}[-\\s]?\\d{2}[-\\\
+            s]?\\d{2}$"
+          type: string
+x-original-swagger-version: "2.0"

aratrl-openapi/ncs.yaml

@@ -0,0 +1,266 @@
+openapi: 3.0.1
+info:
+  title: API for Numerical Case Study (NCS)
+  description: Examples of different numerical algorithms accessible via REST
+  version: "1.0"
+servers:
+- url: http://localhost:30102
+tags:
+- name: ncs-rest
+  description: Ncs Rest
+paths:
+  /api/bessj/{n}/{x}:
+    get:
+      tags:
+      - ncs-rest
+      summary: bessj
+      operationId: bessjUsingGET
+      parameters:
+      - name: "n"
+        in: path
+        description: "n"
+        required: true
+        schema:
+          type: integer
+          format: int32
+      - name: x
+        in: path
+        description: x
+        required: true
+        schema:
+          type: number
+          format: double
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Dto'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /api/expint/{n}/{x}:
+    get:
+      tags:
+      - ncs-rest
+      summary: expint
+      operationId: expintUsingGET
+      parameters:
+      - name: "n"
+        in: path
+        description: "n"
+        required: true
+        schema:
+          type: integer
+          format: int32
+      - name: x
+        in: path
+        description: x
+        required: true
+        schema:
+          type: number
+          format: double
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Dto'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /api/fisher/{m}/{n}/{x}:
+    get:
+      tags:
+      - ncs-rest
+      summary: fisher
+      operationId: fisherUsingGET
+      parameters:
+      - name: m
+        in: path
+        description: m
+        required: true
+        schema:
+          type: integer
+          format: int32
+      - name: "n"
+        in: path
+        description: "n"
+        required: true
+        schema:
+          type: integer
+          format: int32
+      - name: x
+        in: path
+        description: x
+        required: true
+        schema:
+          type: number
+          format: double
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Dto'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /api/gammq/{a}/{x}:
+    get:
+      tags:
+      - ncs-rest
+      summary: gammq
+      operationId: gammqUsingGET
+      parameters:
+      - name: a
+        in: path
+        description: a
+        required: true
+        schema:
+          type: number
+          format: double
+      - name: x
+        in: path
+        description: x
+        required: true
+        schema:
+          type: number
+          format: double
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Dto'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /api/remainder/{a}/{b}:
+    get:
+      tags:
+      - ncs-rest
+      summary: remainder
+      operationId: remainderUsingGET
+      parameters:
+      - name: a
+        in: path
+        description: a
+        required: true
+        schema:
+          type: integer
+          format: int32
+      - name: b
+        in: path
+        description: b
+        required: true
+        schema:
+          type: integer
+          format: int32
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Dto'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /api/triangle/{a}/{b}/{c}:
+    get:
+      tags:
+      - ncs-rest
+      summary: Check the triangle type of the given three edges
+      operationId: checkTriangleUsingGET
+      parameters:
+      - name: a
+        in: path
+        description: First edge
+        required: true
+        schema:
+          type: integer
+          format: int32
+      - name: b
+        in: path
+        description: Second edge
+        required: true
+        schema:
+          type: integer
+          format: int32
+      - name: c
+        in: path
+        description: Third edge
+        required: true
+        schema:
+          type: integer
+          format: int32
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Dto'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+components:
+  schemas:
+    Dto:
+      title: Dto
+      type: object
+      properties:
+        resultAsDouble:
+          type: number
+          format: double
+        resultAsInt:
+          type: integer
+          format: int32
+x-original-swagger-version: "2.0"

aratrl-openapi/person.yaml

@@ -0,0 +1,452 @@
+openapi: 3.0.1
+info:
+  title: Quick start project
+  description: "Quick start project using Java, Spring boot and MongoDB"
+  contact:
+    name: Maxime Beugnet
+    url: https://github.com/MaBeuLux88
+    email: maxime.beugnet@gmail.com
+  license:
+    name: Apache License Version 2.0
+    url: https://www.apache.org/licenses/LICENSE-2.0
+  version: 1.0.0
+servers:
+- url: http://localhost:30111
+tags:
+- name: person-controller
+  description: Person Controller
+paths:
+  /api/person:
+    put:
+      tags:
+      - person-controller
+      summary: putPerson
+      operationId: putPersonUsingPUT
+      requestBody:
+        description: person
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PersonReq'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/PersonRes'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      x-codegen-request-body-name: person
+    post:
+      tags:
+      - person-controller
+      summary: postPerson
+      operationId: postPersonUsingPOST
+      requestBody:
+        description: person
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PersonReq'
+        required: true
+      responses:
+        "201":
+          description: Created
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/PersonRes'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      x-codegen-request-body-name: person
+  /api/person/{id}:
+    get:
+      tags:
+      - person-controller
+      summary: getPerson
+      operationId: getPersonUsingGET
+      parameters:
+      - name: id
+        in: path
+        description: id
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/PersonRes'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+    delete:
+      tags:
+      - person-controller
+      summary: deletePerson
+      operationId: deletePersonUsingDELETE
+      parameters:
+      - name: id
+        in: path
+        description: id
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: integer
+                format: int64
+        "204":
+          description: No Content
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+  /api/persons:
+    get:
+      tags:
+      - person-controller
+      summary: getPersons
+      operationId: getPersonsUsingGET
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/PersonRes'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+    put:
+      tags:
+      - person-controller
+      summary: putPerson
+      operationId: putPersonUsingPUT_1
+      requestBody:
+        description: persons
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                $ref: '#/components/schemas/PersonReq'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: integer
+                format: int64
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      x-codegen-request-body-name: persons
+    post:
+      tags:
+      - person-controller
+      summary: postPersons
+      operationId: postPersonsUsingPOST
+      requestBody:
+        description: persons
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                $ref: '#/components/schemas/PersonReq'
+        required: true
+      responses:
+        "201":
+          description: Created
+          content:
+            '*/*':
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/PersonRes'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      x-codegen-request-body-name: persons
+    delete:
+      tags:
+      - person-controller
+      summary: deletePersons
+      operationId: deletePersonsUsingDELETE
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: integer
+                format: int64
+        "204":
+          description: No Content
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+  /api/persons/averageAge:
+    get:
+      tags:
+      - person-controller
+      summary: averageAge
+      operationId: averageAgeUsingGET
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: number
+                format: double
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+  /api/persons/count:
+    get:
+      tags:
+      - person-controller
+      summary: getCount
+      operationId: getCountUsingGET
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: integer
+                format: int64
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+  /api/persons/{ids}:
+    get:
+      tags:
+      - person-controller
+      summary: getPersons
+      operationId: getPersonsUsingGET_1
+      parameters:
+      - name: ids
+        in: path
+        description: ids
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/PersonRes'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+    delete:
+      tags:
+      - person-controller
+      summary: deletePersons
+      operationId: deletePersonsUsingDELETE_1
+      parameters:
+      - name: ids
+        in: path
+        description: ids
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: integer
+                format: int64
+        "204":
+          description: No Content
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+components:
+  schemas:
+    Address:
+      title: Address
+      type: object
+      properties:
+        city:
+          type: string
+        country:
+          type: string
+        number:
+          type: integer
+          format: int32
+        postcode:
+          type: string
+        street:
+          type: string
+    Car:
+      title: Car
+      type: object
+      properties:
+        brand:
+          type: string
+        maxSpeedKmH:
+          type: number
+          format: float
+        model:
+          type: string
+    ObjectIdReq:
+      title: ObjectIdReq
+      type: object
+      properties:
+        timestamp:
+          type: integer
+          format: int32
+    ObjectIdRes:
+      title: ObjectIdRes
+      type: object
+      properties:
+        date:
+          type: string
+          format: date-time
+        timestamp:
+          type: integer
+          format: int32
+    PersonReq:
+      title: PersonReq
+      type: object
+      properties:
+        address:
+          $ref: '#/components/schemas/Address'
+        age:
+          type: integer
+          format: int32
+        cars:
+          type: array
+          items:
+            $ref: '#/components/schemas/Car'
+        createdAt:
+          type: string
+          format: date-time
+        firstName:
+          type: string
+        id:
+          $ref: '#/components/schemas/ObjectIdReq'
+        insurance:
+          type: boolean
+        lastName:
+          type: string
+    PersonRes:
+      title: PersonRes
+      type: object
+      properties:
+        address:
+          $ref: '#/components/schemas/Address'
+        age:
+          type: integer
+          format: int32
+        cars:
+          type: array
+          items:
+            $ref: '#/components/schemas/Car'
+        createdAt:
+          type: string
+          format: date-time
+        firstName:
+          type: string
+        id:
+          $ref: '#/components/schemas/ObjectIdRes'
+        insurance:
+          type: boolean
+        lastName:
+          type: string
+x-original-swagger-version: "2.0"

aratrl-openapi/project.yaml

@@ -0,0 +1,2333 @@
+openapi: 3.0.1
+info:
+  title: Project-Tracker-System
+  description: "Manage and track commits transactions by Employees and their Managers\
+    \ on a specific project.\n- Employees can be assigned to projects created and\
+    \ managed by their managers, can add a new commits to a specific project so manager\
+    \ can track its progression\n- Managers can create, edit & delete projects, also\
+    \ assign them to their employees and track them efficiently & easily\n- Admin\
+    \ manages all Employees as well as their credentials & departments\nFor more,\
+    \ you can check more on our GitHub repositories : \n- Selim Horri : https://github.com/SelimHorri?tab=repositories\
+    \ \n- Imen Toukebri : https://github.com/imen1012?tab=repositories \n- Bader Idoudi\
+    \ : https://github.com/Bader1996?tab=repositories\n"
+  contact:
+    name: "Selim Horri, Imen Touk, Badr Idoudi"
+    url: https://github.com/SelimHorri/Project-Tracking-System
+    email: springabcxyz@gmail.com
+  license:
+    name: Apache Licence version 2.0
+    url: https://apache.org/license.html
+  version: "1.0"
+servers:
+  #- url: http://localhost:50118
+  - url: http://localhost:30118
+tags:
+- name: assignment-resource
+  description: Assignment Resource
+- name: authentication-resource
+  description: Authentication Resource
+- name: credential-resource
+  description: Credential Resource
+- name: department-resource
+  description: Department Resource
+- name: employee-resource
+  description: Employee Resource
+- name: location-resource
+  description: Location Resource
+- name: project-resource
+  description: Project Resource
+paths:
+  /app/api/assignments:
+    get:
+      tags:
+      - assignment-resource
+      summary: findAll
+      operationId: findAllUsingGET
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/DtoCollectionAssignment'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+    put:
+      tags:
+      - assignment-resource
+      summary: update
+      operationId: updateUsingPUT
+      requestBody:
+        description: assignment
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Assignment'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Assignment'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+      x-codegen-request-body-name: assignment
+    post:
+      tags:
+      - assignment-resource
+      summary: save
+      operationId: saveUsingPOST
+      requestBody:
+        description: assignment
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Assignment'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Assignment'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+      x-codegen-request-body-name: assignment
+  /app/api/assignments/:
+    get:
+      tags:
+      - assignment-resource
+      summary: findAll
+      operationId: findAllUsingGET_1
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/DtoCollectionAssignment'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /app/api/assignments/data/project-commit/{employeeId}/{projectId}:
+    get:
+      tags:
+      - assignment-resource
+      summary: findByEmployeeIdAndProjectId
+      operationId: findByEmployeeIdAndProjectIdUsingGET
+      parameters:
+      - name: employeeId
+        in: path
+        description: employeeId
+        required: true
+        schema:
+          type: string
+      - name: projectId
+        in: path
+        description: projectId
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/DtoCollectionProjectCommit'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /app/api/assignments/data/project-commit/{employeeId}/{projectId}/{commitDate}:
+    get:
+      tags:
+      - assignment-resource
+      summary: findByEmployeeIdAndProjectIdAndCommitDate
+      operationId: findByEmployeeIdAndProjectIdAndCommitDateUsingGET
+      parameters:
+      - name: commitDate
+        in: path
+        description: commitDate
+        required: true
+        schema:
+          type: string
+      - name: employeeId
+        in: path
+        description: employeeId
+        required: true
+        schema:
+          type: string
+      - name: projectId
+        in: path
+        description: projectId
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/ProjectCommit'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /app/api/assignments/data/project-commit/{projectId}:
+    get:
+      tags:
+      - assignment-resource
+      summary: findByProjectId
+      operationId: findByProjectIdUsingGET
+      parameters:
+      - name: projectId
+        in: path
+        description: projectId
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/DtoCollectionProjectCommit'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /app/api/assignments/delete/{employeeId}/{projectId}/{commitDate}:
+    delete:
+      tags:
+      - assignment-resource
+      summary: deleteById
+      operationId: deleteByIdUsingDELETE
+      parameters:
+      - name: commitDate
+        in: path
+        description: commitDate
+        required: true
+        schema:
+          type: string
+      - name: employeeId
+        in: path
+        description: employeeId
+        required: true
+        schema:
+          type: string
+      - name: projectId
+        in: path
+        description: projectId
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: object
+        "204":
+          description: No Content
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+      deprecated: false
+  /app/api/assignments/save:
+    post:
+      tags:
+      - assignment-resource
+      summary: save
+      operationId: saveUsingPOST_1
+      requestBody:
+        description: assignment
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Assignment'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Assignment'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+      x-codegen-request-body-name: assignment
+  /app/api/assignments/update:
+    put:
+      tags:
+      - assignment-resource
+      summary: update
+      operationId: updateUsingPUT_1
+      requestBody:
+        description: assignment
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Assignment'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Assignment'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+      x-codegen-request-body-name: assignment
+  /app/api/assignments/{employeeId}/{projectId}:
+    get:
+      tags:
+      - assignment-resource
+      summary: findAllByEmployeeIdAndManagerId
+      operationId: findAllByEmployeeIdAndManagerIdUsingGET
+      parameters:
+      - name: employeeId
+        in: path
+        description: employeeId
+        required: true
+        schema:
+          type: string
+      - name: projectId
+        in: path
+        description: projectId
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/DtoCollectionAssignment'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /app/api/assignments/{employeeId}/{projectId}/{commitDate}:
+    get:
+      tags:
+      - assignment-resource
+      summary: findById
+      operationId: findByIdUsingGET
+      parameters:
+      - name: commitDate
+        in: path
+        description: commitDate
+        required: true
+        schema:
+          type: string
+      - name: employeeId
+        in: path
+        description: employeeId
+        required: true
+        schema:
+          type: string
+      - name: projectId
+        in: path
+        description: projectId
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Assignment'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+    delete:
+      tags:
+      - assignment-resource
+      summary: deleteById
+      operationId: deleteByIdUsingDELETE_1
+      parameters:
+      - name: commitDate
+        in: path
+        description: commitDate
+        required: true
+        schema:
+          type: string
+      - name: employeeId
+        in: path
+        description: employeeId
+        required: true
+        schema:
+          type: string
+      - name: projectId
+        in: path
+        description: projectId
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: object
+        "204":
+          description: No Content
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+      deprecated: false
+  /app/api/authenticate:
+    post:
+      tags:
+      - authentication-resource
+      summary: authenticate
+      operationId: authenticateUsingPOST
+      requestBody:
+        description: authenticationRequest
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/AuthenticationRequest'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/AuthenticationResponse'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+      x-codegen-request-body-name: authenticationRequest
+  /app/api/authenticate/:
+    post:
+      tags:
+      - authentication-resource
+      summary: authenticate
+      operationId: authenticateUsingPOST_1
+      requestBody:
+        description: authenticationRequest
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/AuthenticationRequest'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/AuthenticationResponse'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+      x-codegen-request-body-name: authenticationRequest
+  /app/api/credentials:
+    get:
+      tags:
+      - credential-resource
+      summary: findAll
+      operationId: findAllUsingGET_2
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/DtoCollectionCredential'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+    put:
+      tags:
+      - credential-resource
+      summary: update
+      operationId: updateUsingPUT_2
+      requestBody:
+        description: credential
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Credential'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Credential'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+      x-codegen-request-body-name: credential
+    post:
+      tags:
+      - credential-resource
+      summary: save
+      operationId: saveUsingPOST_2
+      requestBody:
+        description: credential
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Credential'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Credential'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+      x-codegen-request-body-name: credential
+    delete:
+      tags:
+      - credential-resource
+      summary: deleteById
+      operationId: deleteByIdUsingDELETE_2
+      parameters:
+      - name: credentialId
+        in: query
+        description: credentialId
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: boolean
+        "204":
+          description: No Content
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+      deprecated: false
+  /app/api/credentials/:
+    get:
+      tags:
+      - credential-resource
+      summary: findAll
+      operationId: findAllUsingGET_3
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/DtoCollectionCredential'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /app/api/credentials/delete:
+    delete:
+      tags:
+      - credential-resource
+      summary: deleteById
+      operationId: deleteByIdUsingDELETE_3
+      parameters:
+      - name: credentialId
+        in: query
+        description: credentialId
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: boolean
+        "204":
+          description: No Content
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+      deprecated: false
+  /app/api/credentials/save:
+    post:
+      tags:
+      - credential-resource
+      summary: save
+      operationId: saveUsingPOST_3
+      requestBody:
+        description: credential
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Credential'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Credential'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+      x-codegen-request-body-name: credential
+  /app/api/credentials/update:
+    put:
+      tags:
+      - credential-resource
+      summary: update
+      operationId: updateUsingPUT_3
+      requestBody:
+        description: credential
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Credential'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Credential'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+      x-codegen-request-body-name: credential
+  /app/api/credentials/username/{username}:
+    get:
+      tags:
+      - credential-resource
+      summary: findByUsername
+      operationId: findByUsernameUsingGET
+      parameters:
+      - name: username
+        in: path
+        description: username
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Credential'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+    delete:
+      tags:
+      - credential-resource
+      summary: deleteByUsername
+      operationId: deleteByUsernameUsingDELETE
+      parameters:
+      - name: username
+        in: path
+        description: username
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: boolean
+        "204":
+          description: No Content
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+      deprecated: false
+  /app/api/credentials/{id}:
+    get:
+      tags:
+      - credential-resource
+      summary: findById
+      operationId: findByIdUsingGET_1
+      parameters:
+      - name: id
+        in: path
+        description: id
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Credential'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /app/api/departments:
+    get:
+      tags:
+      - department-resource
+      summary: findAll
+      operationId: findAllUsingGET_4
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/DtoCollectionDepartment'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+    put:
+      tags:
+      - department-resource
+      summary: update
+      operationId: updateUsingPUT_4
+      requestBody:
+        description: department
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Department'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Department'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+      x-codegen-request-body-name: department
+    post:
+      tags:
+      - department-resource
+      summary: save
+      operationId: saveUsingPOST_4
+      requestBody:
+        description: department
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Department'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Department'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+      x-codegen-request-body-name: department
+    delete:
+      tags:
+      - department-resource
+      summary: deleteById
+      operationId: deleteByIdUsingDELETE_4
+      parameters:
+      - name: departmentId
+        in: query
+        description: departmentId
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: boolean
+        "204":
+          description: No Content
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+      deprecated: false
+  /app/api/departments/:
+    get:
+      tags:
+      - department-resource
+      summary: findAll
+      operationId: findAllUsingGET_5
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/DtoCollectionDepartment'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /app/api/departments/delete:
+    delete:
+      tags:
+      - department-resource
+      summary: deleteById
+      operationId: deleteByIdUsingDELETE_5
+      parameters:
+      - name: departmentId
+        in: query
+        description: departmentId
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: boolean
+        "204":
+          description: No Content
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+      deprecated: false
+  /app/api/departments/save:
+    post:
+      tags:
+      - department-resource
+      summary: save
+      operationId: saveUsingPOST_5
+      requestBody:
+        description: department
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Department'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Department'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+      x-codegen-request-body-name: department
+  /app/api/departments/update:
+    put:
+      tags:
+      - department-resource
+      summary: update
+      operationId: updateUsingPUT_5
+      requestBody:
+        description: department
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Department'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Department'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+      x-codegen-request-body-name: department
+  /app/api/departments/{id}:
+    get:
+      tags:
+      - department-resource
+      summary: findById
+      operationId: findByIdUsingGET_2
+      parameters:
+      - name: id
+        in: path
+        description: id
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Department'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /app/api/employees:
+    get:
+      tags:
+      - employee-resource
+      summary: findAll
+      operationId: findAllUsingGET_6
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/DtoCollectionEmployee'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+    put:
+      tags:
+      - employee-resource
+      summary: update
+      operationId: updateUsingPUT_6
+      requestBody:
+        description: employee
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Employee'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Employee'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+      x-codegen-request-body-name: employee
+    post:
+      tags:
+      - employee-resource
+      summary: save
+      operationId: saveUsingPOST_6
+      requestBody:
+        description: employee
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Employee'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Employee'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+      x-codegen-request-body-name: employee
+    delete:
+      tags:
+      - employee-resource
+      summary: deleteById
+      operationId: deleteByIdUsingDELETE_6
+      parameters:
+      - name: employeeId
+        in: query
+        description: employeeId
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: boolean
+        "204":
+          description: No Content
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+      deprecated: false
+  /app/api/employees/:
+    get:
+      tags:
+      - employee-resource
+      summary: findAll
+      operationId: findAllUsingGET_7
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/DtoCollectionEmployee'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /app/api/employees/data/department/{departmentId}:
+    get:
+      tags:
+      - employee-resource
+      summary: findByDepartmentId
+      operationId: findByDepartmentIdUsingGET
+      parameters:
+      - name: departmentId
+        in: path
+        description: departmentId
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/DtoCollectionEmployee'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /app/api/employees/data/employee-project-data/{employeeId}:
+    get:
+      tags:
+      - employee-resource
+      summary: findByEmployeeProjectDataEmployeeId
+      operationId: findByEmployeeProjectDataEmployeeIdUsingGET
+      parameters:
+      - name: employeeId
+        in: path
+        description: employeeId
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/DtoCollectionEmployeeProjectData'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /app/api/employees/data/manager-project-data/{employeeId}:
+    get:
+      tags:
+      - employee-resource
+      summary: findManagerProjectDataByEmployeeId
+      operationId: findManagerProjectDataByEmployeeIdUsingGET
+      parameters:
+      - name: employeeId
+        in: path
+        description: employeeId
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/DtoCollectionManagerProjectData'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /app/api/employees/delete:
+    delete:
+      tags:
+      - employee-resource
+      summary: deleteById
+      operationId: deleteByIdUsingDELETE_7
+      parameters:
+      - name: employeeId
+        in: query
+        description: employeeId
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: boolean
+        "204":
+          description: No Content
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+      deprecated: false
+  /app/api/employees/save:
+    post:
+      tags:
+      - employee-resource
+      summary: save
+      operationId: saveUsingPOST_7
+      requestBody:
+        description: employee
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Employee'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Employee'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+      x-codegen-request-body-name: employee
+  /app/api/employees/update:
+    put:
+      tags:
+      - employee-resource
+      summary: update
+      operationId: updateUsingPUT_7
+      requestBody:
+        description: employee
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Employee'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Employee'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+      x-codegen-request-body-name: employee
+  /app/api/employees/username/{username}:
+    get:
+      tags:
+      - employee-resource
+      summary: findByUsername
+      operationId: findByUsernameUsingGET_1
+      parameters:
+      - name: username
+        in: path
+        description: username
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Employee'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+    delete:
+      tags:
+      - employee-resource
+      summary: deleteByUsername
+      operationId: deleteByUsernameUsingDELETE_1
+      parameters:
+      - name: username
+        in: path
+        description: username
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: boolean
+        "204":
+          description: No Content
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+      deprecated: false
+  /app/api/employees/{id}:
+    get:
+      tags:
+      - employee-resource
+      summary: findById
+      operationId: findByIdUsingGET_3
+      parameters:
+      - name: id
+        in: path
+        description: id
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Employee'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /app/api/locations:
+    get:
+      tags:
+      - location-resource
+      summary: findAll
+      operationId: findAllUsingGET_8
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/DtoCollectionLocation'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+    put:
+      tags:
+      - location-resource
+      summary: update
+      operationId: updateUsingPUT_8
+      requestBody:
+        description: location
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Location'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Location'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+      x-codegen-request-body-name: location
+    post:
+      tags:
+      - location-resource
+      summary: save
+      operationId: saveUsingPOST_8
+      requestBody:
+        description: location
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Location'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Location'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+      x-codegen-request-body-name: location
+    delete:
+      tags:
+      - location-resource
+      summary: deleteById
+      operationId: deleteByIdUsingDELETE_8
+      parameters:
+      - name: locationId
+        in: query
+        description: locationId
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content: {}
+        "204":
+          description: No Content
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+      deprecated: false
+  /app/api/locations/:
+    get:
+      tags:
+      - location-resource
+      summary: findAll
+      operationId: findAllUsingGET_9
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/DtoCollectionLocation'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /app/api/locations/delete:
+    delete:
+      tags:
+      - location-resource
+      summary: deleteById
+      operationId: deleteByIdUsingDELETE_9
+      parameters:
+      - name: locationId
+        in: query
+        description: locationId
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content: {}
+        "204":
+          description: No Content
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+      deprecated: false
+  /app/api/locations/save:
+    post:
+      tags:
+      - location-resource
+      summary: save
+      operationId: saveUsingPOST_9
+      requestBody:
+        description: location
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Location'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Location'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+      x-codegen-request-body-name: location
+  /app/api/locations/update:
+    put:
+      tags:
+      - location-resource
+      summary: update
+      operationId: updateUsingPUT_9
+      requestBody:
+        description: location
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Location'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Location'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+      x-codegen-request-body-name: location
+  /app/api/locations/{id}:
+    get:
+      tags:
+      - location-resource
+      summary: findById
+      operationId: findByIdUsingGET_4
+      parameters:
+      - name: id
+        in: path
+        description: id
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Location'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /app/api/projects:
+    get:
+      tags:
+      - project-resource
+      summary: findAll
+      operationId: findAllUsingGET_10
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/DtoCollectionProject'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+    put:
+      tags:
+      - project-resource
+      summary: update
+      operationId: updateUsingPUT_10
+      requestBody:
+        description: project
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Project'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Project'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+      x-codegen-request-body-name: project
+    post:
+      tags:
+      - project-resource
+      summary: save
+      operationId: saveUsingPOST_10
+      requestBody:
+        description: project
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Project'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Project'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+      x-codegen-request-body-name: project
+    delete:
+      tags:
+      - project-resource
+      summary: deleteById
+      operationId: deleteByIdUsingDELETE_10
+      parameters:
+      - name: projectId
+        in: query
+        description: projectId
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content: {}
+        "204":
+          description: No Content
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+      deprecated: false
+  /app/api/projects/:
+    get:
+      tags:
+      - project-resource
+      summary: findAll
+      operationId: findAllUsingGET_11
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/DtoCollectionProject'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /app/api/projects/delete:
+    delete:
+      tags:
+      - project-resource
+      summary: deleteById
+      operationId: deleteByIdUsingDELETE_11
+      parameters:
+      - name: projectId
+        in: query
+        description: projectId
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content: {}
+        "204":
+          description: No Content
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+      deprecated: false
+  /app/api/projects/save:
+    post:
+      tags:
+      - project-resource
+      summary: save
+      operationId: saveUsingPOST_11
+      requestBody:
+        description: project
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Project'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Project'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+      x-codegen-request-body-name: project
+  /app/api/projects/update:
+    put:
+      tags:
+      - project-resource
+      summary: update
+      operationId: updateUsingPUT_11
+      requestBody:
+        description: project
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Project'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Project'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+      x-codegen-request-body-name: project
+  /app/api/projects/{id}:
+    get:
+      tags:
+      - project-resource
+      summary: findById
+      operationId: findByIdUsingGET_5
+      parameters:
+      - name: id
+        in: path
+        description: id
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Project'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+components:
+  schemas:
+    Assignment:
+      title: Assignment
+      type: object
+      properties:
+        commitDate:
+          type: string
+          example: dd-MM-yyyyHH:mm:ss
+        commitEmpDesc:
+          type: string
+        commitMgrDesc:
+          type: string
+        employee:
+          $ref: '#/components/schemas/Employee'
+        employeeId:
+          type: integer
+          format: int32
+        project:
+          $ref: '#/components/schemas/Project'
+        projectId:
+          type: integer
+          format: int32
+    AuthenticationRequest:
+      title: AuthenticationRequest
+      type: object
+      properties:
+        password:
+          type: string
+        username:
+          type: string
+    AuthenticationResponse:
+      title: AuthenticationResponse
+      type: object
+      properties:
+        isEligible:
+          type: boolean
+        username:
+          type: string
+    Credential:
+      title: Credential
+      type: object
+      properties:
+        credentialId:
+          type: integer
+          format: int32
+        enabled:
+          type: boolean
+        password:
+          type: string
+        role:
+          type: string
+        username:
+          type: string
+    Department:
+      title: Department
+      type: object
+      properties:
+        departmentId:
+          type: integer
+          format: int32
+        departmentName:
+          type: string
+        location:
+          $ref: '#/components/schemas/Location'
+    DtoCollectionAssignment:
+      title: DtoCollectionAssignment
+      type: object
+      properties:
+        collection:
+          type: array
+          items:
+            $ref: '#/components/schemas/Assignment'
+    DtoCollectionCredential:
+      title: DtoCollectionCredential
+      type: object
+      properties:
+        collection:
+          type: array
+          items:
+            $ref: '#/components/schemas/Credential'
+    DtoCollectionDepartment:
+      title: DtoCollectionDepartment
+      type: object
+      properties:
+        collection:
+          type: array
+          items:
+            $ref: '#/components/schemas/Department'
+    DtoCollectionEmployeeProjectData:
+      title: DtoCollectionEmployeeProjectData
+      type: object
+      properties:
+        collection:
+          type: array
+          items:
+            $ref: '#/components/schemas/EmployeeProjectData'
+    DtoCollectionEmployee:
+      title: DtoCollectionEmployee
+      type: object
+      properties:
+        collection:
+          type: array
+          items:
+            $ref: '#/components/schemas/Employee'
+    DtoCollectionLocation:
+      title: DtoCollectionLocation
+      type: object
+      properties:
+        collection:
+          type: array
+          items:
+            $ref: '#/components/schemas/Location'
+    DtoCollectionManagerProjectData:
+      title: DtoCollectionManagerProjectData
+      type: object
+      properties:
+        collection:
+          type: array
+          items:
+            $ref: '#/components/schemas/ManagerProjectData'
+    DtoCollectionProjectCommit:
+      title: DtoCollectionProjectCommit
+      type: object
+      properties:
+        collection:
+          type: array
+          items:
+            $ref: '#/components/schemas/ProjectCommit'
+    DtoCollectionProject:
+      title: DtoCollectionProject
+      type: object
+      properties:
+        collection:
+          type: array
+          items:
+            $ref: '#/components/schemas/Project'
+    Employee:
+      title: Employee
+      type: object
+      properties:
+        credential:
+          $ref: '#/components/schemas/Credential'
+        department:
+          $ref: '#/components/schemas/Department'
+        email:
+          type: string
+        employeeId:
+          type: integer
+          format: int32
+        firstName:
+          type: string
+        hiredate:
+          type: string
+          example: dd-MM-yyyy
+        job:
+          type: string
+        lastName:
+          type: string
+        phone:
+          type: string
+        salary:
+          type: number
+          format: double
+    EmployeeProjectData:
+      title: EmployeeProjectData
+      type: object
+      properties:
+        endDate:
+          type: string
+        projectId:
+          type: integer
+          format: int32
+        startDate:
+          type: string
+        status:
+          type: string
+        title:
+          type: string
+    Location:
+      title: Location
+      type: object
+      properties:
+        adr:
+          type: string
+        city:
+          type: string
+        locationId:
+          type: integer
+          format: int32
+        postalCode:
+          type: string
+    ManagerProjectData:
+      title: ManagerProjectData
+      type: object
+      properties:
+        endDate:
+          type: string
+        projectId:
+          type: integer
+          format: int32
+        startDate:
+          type: string
+        status:
+          type: string
+        title:
+          type: string
+    Project:
+      title: Project
+      type: object
+      properties:
+        endDate:
+          type: string
+          example: dd-MM-yyyy
+        projectId:
+          type: integer
+          format: int32
+        startDate:
+          type: string
+          example: dd-MM-yyyy
+        status:
+          type: string
+        title:
+          type: string
+    ProjectCommit:
+      title: ProjectCommit
+      type: object
+      properties:
+        commitDate:
+          type: string
+          format: date-time
+        commitEmpDesc:
+          type: string
+        commitMgrDesc:
+          type: string
+        employeeId:
+          type: integer
+          format: int32
+        firstName:
+          type: string
+        lastName:
+          type: string
+        projectId:
+          type: integer
+          format: int32
+x-original-swagger-version: "2.0"

aratrl-openapi/restcountries.yaml

@@ -0,0 +1,377 @@
+openapi: 3.0.0
+servers:
+  - url: 'http://localhost:50106/rest'
+info:
+  description: 'REST countries API'
+  title: REST countries API
+  version: v2.0.5
+paths:
+  /v1/all:
+    get:
+      operationId: v1All
+      responses:
+        '200':
+          description: Successful response
+        default:
+          description: Other responses
+  /v1/alpha/{alphacode}:
+    get:
+      operationId: v1Alphacode
+      parameters:
+        - name: alphacode
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successful response
+        default:
+          description: Other responses
+  /v1/alpha:
+    get:
+      operationId: v1Alphacodes
+      parameters:
+        - name: codes
+          in: query
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successful response
+        default:
+          description: Other responses
+  /v1/currency/{currency}:
+    get:
+      operationId: v1Currency
+      parameters:
+        - name: currency
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successful response
+        default:
+          description: Other responses
+  /v1/name/{name}:
+    get:
+      operationId: v1Name
+      parameters:
+        - name: name
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: fullText
+          in: query
+          required: false
+          schema:
+            type: boolean
+      responses:
+        '200':
+          description: Successful response
+        default:
+          description: Other responses
+  /v1/callingcode/{callingcode}:
+    get:
+      operationId: v1Callingcode
+      parameters:
+        - name: callingcode
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successful response
+        default:
+          description: Other responses
+  /v1/capital/{capital}:
+    get:
+      operationId: v1Capital
+      parameters:
+        - name: capital
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successful response
+        default:
+          description: Other responses
+  /v1/region/{region}:
+    get:
+      operationId: v1Region
+      parameters:
+        - name: region
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successful response
+        default:
+          description: Other responses
+  /v1/subregion/{subregion}:
+    get:
+      operationId: v1Subregion
+      parameters:
+        - name: subregion
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successful response
+        default:
+          description: Other responses
+  /v1/lang/{lang}:
+    get:
+      operationId: v1Lang
+      parameters:
+        - name: lang
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successful response
+        default:
+          description: Other responses
+  /v2/all:
+    get:
+      operationId: v2All
+      parameters:
+        - name: fields
+          in: query
+          required: false
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successful response
+        default:
+          description: Other responses
+  /v2/alpha/{alphacode}:
+    get:
+      operationId: v2Alphacode
+      parameters:
+        - name: fields
+          in: query
+          required: false
+          schema:
+            type: string
+        - name: alphacode
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successful response
+        default:
+          description: Other responses
+  /v2/alpha:
+    get:
+      operationId: v2Alphacodes
+      parameters:
+        - name: fields
+          in: query
+          required: false
+          schema:
+            type: string
+        - name: codes
+          in: query
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successful response
+        default:
+          description: Other responses
+  /v2/currency/{currency}:
+    get:
+      operationId: v2Currency
+      parameters:
+        - name: fields
+          in: query
+          required: false
+          schema:
+            type: string
+        - name: currency
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successful response
+        default:
+          description: Other responses
+  /v2/name/{name}:
+    get:
+      operationId: v2Name
+      parameters:
+        - name: fields
+          in: query
+          required: false
+          schema:
+            type: string
+        - name: name
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: fullText
+          in: query
+          required: false
+          schema:
+            type: boolean
+      responses:
+        '200':
+          description: Successful response
+        default:
+          description: Other responses
+  /v2/callingcode/{callingcode}:
+    get:
+      operationId: v2Callingcode
+      parameters:
+        - name: fields
+          in: query
+          required: false
+          schema:
+            type: string
+        - name: callingcode
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successful response
+        default:
+          description: Other responses
+  /v2/capital/{capital}:
+    get:
+      operationId: v2Capital
+      parameters:
+        - name: fields
+          in: query
+          required: false
+          schema:
+            type: string
+        - name: capital
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successful response
+        default:
+          description: Other responses
+  /v2/region/{region}:
+    get:
+      operationId: v2Region
+      parameters:
+        - name: fields
+          in: query
+          required: false
+          schema:
+            type: string
+        - name: region
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successful response
+        default:
+          description: Other responses
+  /v2/subregion/{subregion}:
+    get:
+      operationId: v2Subregion
+      parameters:
+        - name: fields
+          in: query
+          required: false
+          schema:
+            type: string
+        - name: subregion
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successful response
+        default:
+          description: Other responses
+  /v2/lang/{lang}:
+    get:
+      operationId: v2Lang
+      parameters:
+        - name: fields
+          in: query
+          required: false
+          schema:
+            type: string
+        - name: lang
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successful response
+        default:
+          description: Other responses
+  /v2/demonym/{demonym}:
+    get:
+      operationId: v2Demonym
+      parameters:
+        - name: fields
+          in: query
+          required: false
+          schema:
+            type: string
+        - name: demonym
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successful response
+        default:
+          description: Other responses
+  /v2/regionalbloc/{regionalbloc}:
+    get:
+      operationId: v2Regionalbloc
+      parameters:
+        - name: fields
+          in: query
+          required: false
+          schema:
+            type: string
+        - name: regionalbloc
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successful response
+        default:
+          description: Other responses
+components:
+  schemas: { }

aratrl-openapi/scs.yaml

@@ -0,0 +1,437 @@
+openapi: 3.0.1
+info:
+  title: API for String Case Study (SCS)
+  description: Examples of different string algorithms accessible via REST
+  version: "1.0"
+servers:
+- url: http://localhost:50108
+tags:
+- name: scs-rest
+  description: Scs Rest
+paths:
+  /api/calc/{op}/{arg1}/{arg2}:
+    get:
+      tags:
+      - scs-rest
+      summary: calc
+      operationId: calcUsingGET
+      parameters:
+      - name: arg1
+        in: path
+        description: arg1
+        required: true
+        schema:
+          type: number
+          format: double
+      - name: arg2
+        in: path
+        description: arg2
+        required: true
+        schema:
+          type: number
+          format: double
+      - name: op
+        in: path
+        description: op
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /api/cookie/{name}/{val}/{site}:
+    get:
+      tags:
+      - scs-rest
+      summary: cookie
+      operationId: cookieUsingGET
+      parameters:
+      - name: name
+        in: path
+        description: name
+        required: true
+        schema:
+          type: string
+      - name: site
+        in: path
+        description: site
+        required: true
+        schema:
+          type: string
+      - name: val
+        in: path
+        description: val
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /api/costfuns/{i}/{s}:
+    get:
+      tags:
+      - scs-rest
+      summary: costfuns
+      operationId: costfunsUsingGET
+      parameters:
+      - name: i
+        in: path
+        description: i
+        required: true
+        schema:
+          type: integer
+          format: int32
+      - name: s
+        in: path
+        description: s
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /api/dateparse/{dayname}/{monthname}:
+    get:
+      tags:
+      - scs-rest
+      summary: dateParse
+      operationId: dateParseUsingGET
+      parameters:
+      - name: dayname
+        in: path
+        description: dayname
+        required: true
+        schema:
+          type: string
+      - name: monthname
+        in: path
+        description: monthname
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /api/filesuffix/{directory}/{file}:
+    get:
+      tags:
+      - scs-rest
+      summary: fileSuffix
+      operationId: fileSuffixUsingGET
+      parameters:
+      - name: directory
+        in: path
+        description: directory
+        required: true
+        schema:
+          type: string
+      - name: file
+        in: path
+        description: file
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /api/notypevar/{i}/{s}:
+    get:
+      tags:
+      - scs-rest
+      summary: notyPevar
+      operationId: notyPevarUsingGET
+      parameters:
+      - name: i
+        in: path
+        description: i
+        required: true
+        schema:
+          type: integer
+          format: int32
+      - name: s
+        in: path
+        description: s
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /api/ordered4/{w}/{x}/{z}/{y}:
+    get:
+      tags:
+      - scs-rest
+      summary: ordered4
+      operationId: ordered4UsingGET
+      parameters:
+      - name: w
+        in: path
+        description: w
+        required: true
+        schema:
+          type: string
+      - name: x
+        in: path
+        description: x
+        required: true
+        schema:
+          type: string
+      - name: "y"
+        in: path
+        description: "y"
+        required: true
+        schema:
+          type: string
+      - name: z
+        in: path
+        description: z
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /api/pat/{txt}:
+    get:
+      tags:
+      - scs-rest
+      summary: regex
+      operationId: regexUsingGET
+      parameters:
+      - name: txt
+        in: path
+        description: txt
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /api/pat/{txt}/{pat}:
+    get:
+      tags:
+      - scs-rest
+      summary: pat
+      operationId: patUsingGET
+      parameters:
+      - name: pat
+        in: path
+        description: pat
+        required: true
+        schema:
+          type: string
+      - name: txt
+        in: path
+        description: txt
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /api/text2txt/{word1}/{word2}/{word3}:
+    get:
+      tags:
+      - scs-rest
+      summary: text2txt
+      operationId: text2txtUsingGET
+      parameters:
+      - name: word1
+        in: path
+        description: word1
+        required: true
+        schema:
+          type: string
+      - name: word2
+        in: path
+        description: word2
+        required: true
+        schema:
+          type: string
+      - name: word3
+        in: path
+        description: word3
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /api/title/{sex}/{title}:
+    get:
+      tags:
+      - scs-rest
+      summary: title
+      operationId: titleUsingGET
+      parameters:
+      - name: sex
+        in: path
+        description: sex
+        required: true
+        schema:
+          type: string
+      - name: title
+        in: path
+        description: title
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: string
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+components: {}
+x-original-swagger-version: "2.0"

aratrl-openapi/user.yaml

@@ -0,0 +1,965 @@
+openapi: 3.0.1
+info:
+  title: Api Documentation
+  description: Api Documentation
+  termsOfService: urn:tos
+  contact: {}
+  license:
+    name: Apache 2.0
+    url: http://www.apache.org/licenses/LICENSE-2.0
+  version: "1.0"
+servers:
+- url: http://localhost:30115
+tags:
+- name: basic-error-controller
+  description: Basic Error Controller
+- name: login-rest-controller
+  description: Login Rest Controller
+- name: rbac-rest-controller
+  description: RBAC Rest Controller
+- name: register-rest-controller
+  description: Register Rest Controller
+- name: user-rest-controller
+  description: User Rest Controller
+paths:
+  /error:
+    get:
+      tags:
+      - basic-error-controller
+      summary: errorHtml
+      operationId: errorHtmlUsingGET
+      responses:
+        "200":
+          description: OK
+          content:
+            text/html:
+              schema:
+                $ref: '#/components/schemas/ModelAndView'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+    put:
+      tags:
+      - basic-error-controller
+      summary: errorHtml
+      operationId: errorHtmlUsingPUT
+      responses:
+        "200":
+          description: OK
+          content:
+            text/html:
+              schema:
+                $ref: '#/components/schemas/ModelAndView'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+    post:
+      tags:
+      - basic-error-controller
+      summary: errorHtml
+      operationId: errorHtmlUsingPOST
+      responses:
+        "200":
+          description: OK
+          content:
+            text/html:
+              schema:
+                $ref: '#/components/schemas/ModelAndView'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+    delete:
+      tags:
+      - basic-error-controller
+      summary: errorHtml
+      operationId: errorHtmlUsingDELETE
+      responses:
+        "200":
+          description: OK
+          content:
+            text/html:
+              schema:
+                $ref: '#/components/schemas/ModelAndView'
+        "204":
+          description: No Content
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+      deprecated: false
+    head:
+      tags:
+      - basic-error-controller
+      summary: errorHtml
+      operationId: errorHtmlUsingHEAD
+      responses:
+        "200":
+          description: OK
+          content:
+            text/html:
+              schema:
+                $ref: '#/components/schemas/ModelAndView'
+        "204":
+          description: No Content
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+      deprecated: false
+    patch:
+      tags:
+      - basic-error-controller
+      summary: errorHtml
+      operationId: errorHtmlUsingPATCH
+      responses:
+        "200":
+          description: OK
+          content:
+            text/html:
+              schema:
+                $ref: '#/components/schemas/ModelAndView'
+        "204":
+          description: No Content
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+      deprecated: false
+  /login:
+    post:
+      tags:
+      - login-rest-controller
+      summary: login
+      operationId: loginUsingPOST
+      requestBody:
+        description: loginRequestDTO
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/LoginRequestDTO'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/UserDTO'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+      x-codegen-request-body-name: loginRequestDTO
+  /users:
+    get:
+      tags:
+      - user-rest-controller
+      summary: getUserPresentationList
+      operationId: getUserPresentationListUsingGET
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/UserListDTO'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+    post:
+      tags:
+      - user-rest-controller
+      summary: createUser
+      operationId: createUserUsingPOST
+      requestBody:
+        description: createOrUpdateUserDTO
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CreateOrUpdateUserDTO'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/UserDTO'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+      x-codegen-request-body-name: createOrUpdateUserDTO
+  /users/rbac/permissions:
+    get:
+      tags:
+      - rbac-rest-controller
+      summary: getPermissionPresentationList
+      operationId: getPermissionPresentationListUsingGET
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/PermissionDTO'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+  /users/rbac/roles:
+    get:
+      tags:
+      - rbac-rest-controller
+      summary: getRolePresentationList
+      operationId: getRolePresentationListUsingGET
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/RoleDTO'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+    post:
+      tags:
+      - rbac-rest-controller
+      summary: createRole
+      operationId: createRoleUsingPOST
+      requestBody:
+        description: role
+        content:
+          application/json:
+            schema:
+              type: string
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/RoleDTO'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+      x-codegen-request-body-name: role
+  /users/rbac/roles/{roleId}:
+    get:
+      tags:
+      - rbac-rest-controller
+      summary: getRoleById
+      operationId: getRoleByIdUsingGET
+      parameters:
+      - name: roleId
+        in: path
+        description: roleId
+        required: true
+        schema:
+          type: integer
+          format: int64
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/RoleDTO'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+    delete:
+      tags:
+      - rbac-rest-controller
+      summary: deleteRoleById
+      operationId: deleteRoleByIdUsingDELETE
+      parameters:
+      - name: roleId
+        in: path
+        description: roleId
+        required: true
+        schema:
+          type: integer
+          format: int64
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: object
+        "204":
+          description: No Content
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+      deprecated: false
+  /users/rbac/roles/{roleId}/permissions/{permissionKey}:
+    post:
+      tags:
+      - rbac-rest-controller
+      summary: addPermissionOnRole
+      operationId: addPermissionOnRoleUsingPOST
+      parameters:
+      - name: permissionKey
+        in: path
+        description: permissionKey
+        required: true
+        schema:
+          type: string
+      - name: roleId
+        in: path
+        description: roleId
+        required: true
+        schema:
+          type: integer
+          format: int64
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/RoleDTO'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+    delete:
+      tags:
+      - rbac-rest-controller
+      summary: removePermissionOnRole
+      operationId: removePermissionOnRoleUsingDELETE
+      parameters:
+      - name: permissionKey
+        in: path
+        description: permissionKey
+        required: true
+        schema:
+          type: string
+      - name: roleId
+        in: path
+        description: roleId
+        required: true
+        schema:
+          type: integer
+          format: int64
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/RoleDTO'
+        "204":
+          description: No Content
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+      deprecated: false
+  /users/register:
+    post:
+      tags:
+      - register-rest-controller
+      summary: registerNewUserAccount
+      operationId: registerNewUserAccountUsingPOST
+      requestBody:
+        description: registerUserAccountDTO
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/RegisterUserAccountDTO'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/UserDTO'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+      x-codegen-request-body-name: registerUserAccountDTO
+  /users/{id}:
+    get:
+      tags:
+      - user-rest-controller
+      summary: getUserById
+      operationId: getUserByIdUsingGET
+      parameters:
+      - name: id
+        in: path
+        description: id
+        required: true
+        schema:
+          type: integer
+          format: int64
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/UserDTO'
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+    put:
+      tags:
+      - user-rest-controller
+      summary: updateUser
+      operationId: updateUserUsingPUT
+      parameters:
+      - name: id
+        in: path
+        description: id
+        required: true
+        schema:
+          type: integer
+          format: int64
+      requestBody:
+        description: updateUserDTO
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CreateOrUpdateUserDTO'
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/UserDTO'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+      x-codegen-request-body-name: updateUserDTO
+    delete:
+      tags:
+      - user-rest-controller
+      summary: deleteById
+      operationId: deleteByIdUsingDELETE
+      parameters:
+      - name: id
+        in: path
+        description: id
+        required: true
+        schema:
+          type: integer
+          format: int64
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: object
+        "204":
+          description: No Content
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+      deprecated: false
+  /users/{id}/roles/{roleId}:
+    post:
+      tags:
+      - user-rest-controller
+      summary: addRole
+      operationId: addRoleUsingPOST
+      parameters:
+      - name: id
+        in: path
+        description: id
+        required: true
+        schema:
+          type: integer
+          format: int64
+      - name: roleId
+        in: path
+        description: roleId
+        required: true
+        schema:
+          type: integer
+          format: int64
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/UserDTO'
+        "201":
+          description: Created
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+        "404":
+          description: Not Found
+          content: {}
+      deprecated: false
+    delete:
+      tags:
+      - user-rest-controller
+      summary: removeRole
+      operationId: removeRoleUsingDELETE
+      parameters:
+      - name: id
+        in: path
+        description: id
+        required: true
+        schema:
+          type: integer
+          format: int64
+      - name: roleId
+        in: path
+        description: roleId
+        required: true
+        schema:
+          type: integer
+          format: int64
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/UserDTO'
+        "204":
+          description: No Content
+          content: {}
+        "401":
+          description: Unauthorized
+          content: {}
+        "403":
+          description: Forbidden
+          content: {}
+      deprecated: false
+components:
+  schemas:
+    AddressDTO:
+      title: AddressDTO
+      type: object
+      properties:
+        address:
+          type: string
+        address2:
+          type: string
+        city:
+          type: string
+        country:
+          type: string
+        zipCode:
+          type: string
+    ContactDTO:
+      title: ContactDTO
+      type: object
+      properties:
+        contactNote:
+          type: string
+        email:
+          type: string
+        facebook:
+          type: string
+        linkedin:
+          type: string
+        phone:
+          type: string
+        skype:
+          type: string
+        website:
+          type: string
+    CreateOrUpdateUserDTO:
+      title: CreateOrUpdateUserDTO
+      type: object
+      properties:
+        address:
+          type: string
+        address2:
+          type: string
+        birthDate:
+          type: string
+          format: date
+        city:
+          type: string
+        contactNote:
+          type: string
+        country:
+          type: string
+        email:
+          type: string
+        enabled:
+          type: boolean
+        facebook:
+          type: string
+        gender:
+          type: string
+        linkedin:
+          type: string
+        mobile:
+          type: string
+        name:
+          type: string
+        note:
+          type: string
+        password:
+          type: string
+        secured:
+          type: boolean
+        skype:
+          type: string
+        surname:
+          type: string
+        username:
+          type: string
+        website:
+          type: string
+        zipCode:
+          type: string
+    LoginRequestDTO:
+      title: LoginRequestDTO
+      type: object
+      properties:
+        password:
+          type: string
+        username:
+          type: string
+    ModelAndView:
+      title: ModelAndView
+      type: object
+      properties:
+        empty:
+          type: boolean
+        model:
+          type: object
+          properties: {}
+        modelMap:
+          type: object
+          additionalProperties:
+            type: object
+            properties: {}
+        reference:
+          type: boolean
+        status:
+          type: string
+          enum:
+          - 100 CONTINUE
+          - 101 SWITCHING_PROTOCOLS
+          - 102 PROCESSING
+          - 103 CHECKPOINT
+          - 200 OK
+          - 201 CREATED
+          - 202 ACCEPTED
+          - 203 NON_AUTHORITATIVE_INFORMATION
+          - 204 NO_CONTENT
+          - 205 RESET_CONTENT
+          - 206 PARTIAL_CONTENT
+          - 207 MULTI_STATUS
+          - 208 ALREADY_REPORTED
+          - 226 IM_USED
+          - 300 MULTIPLE_CHOICES
+          - 301 MOVED_PERMANENTLY
+          - 302 FOUND
+          - 302 MOVED_TEMPORARILY
+          - 303 SEE_OTHER
+          - 304 NOT_MODIFIED
+          - 305 USE_PROXY
+          - 307 TEMPORARY_REDIRECT
+          - 308 PERMANENT_REDIRECT
+          - 400 BAD_REQUEST
+          - 401 UNAUTHORIZED
+          - 402 PAYMENT_REQUIRED
+          - 403 FORBIDDEN
+          - 404 NOT_FOUND
+          - 405 METHOD_NOT_ALLOWED
+          - 406 NOT_ACCEPTABLE
+          - 407 PROXY_AUTHENTICATION_REQUIRED
+          - 408 REQUEST_TIMEOUT
+          - 409 CONFLICT
+          - 410 GONE
+          - 411 LENGTH_REQUIRED
+          - 412 PRECONDITION_FAILED
+          - 413 PAYLOAD_TOO_LARGE
+          - 413 REQUEST_ENTITY_TOO_LARGE
+          - 414 URI_TOO_LONG
+          - 414 REQUEST_URI_TOO_LONG
+          - 415 UNSUPPORTED_MEDIA_TYPE
+          - 416 REQUESTED_RANGE_NOT_SATISFIABLE
+          - 417 EXPECTATION_FAILED
+          - 418 I_AM_A_TEAPOT
+          - 419 INSUFFICIENT_SPACE_ON_RESOURCE
+          - 420 METHOD_FAILURE
+          - 421 DESTINATION_LOCKED
+          - 422 UNPROCESSABLE_ENTITY
+          - 423 LOCKED
+          - 424 FAILED_DEPENDENCY
+          - 425 TOO_EARLY
+          - 426 UPGRADE_REQUIRED
+          - 428 PRECONDITION_REQUIRED
+          - 429 TOO_MANY_REQUESTS
+          - 431 REQUEST_HEADER_FIELDS_TOO_LARGE
+          - 451 UNAVAILABLE_FOR_LEGAL_REASONS
+          - 500 INTERNAL_SERVER_ERROR
+          - 501 NOT_IMPLEMENTED
+          - 502 BAD_GATEWAY
+          - 503 SERVICE_UNAVAILABLE
+          - 504 GATEWAY_TIMEOUT
+          - 505 HTTP_VERSION_NOT_SUPPORTED
+          - 506 VARIANT_ALSO_NEGOTIATES
+          - 507 INSUFFICIENT_STORAGE
+          - 508 LOOP_DETECTED
+          - 509 BANDWIDTH_LIMIT_EXCEEDED
+          - 510 NOT_EXTENDED
+          - 511 NETWORK_AUTHENTICATION_REQUIRED
+        view:
+          $ref: '#/components/schemas/View'
+        viewName:
+          type: string
+    PermissionDTO:
+      title: PermissionDTO
+      type: object
+      properties:
+        id:
+          type: integer
+          format: int64
+        permission:
+          type: string
+    RegisterUserAccountDTO:
+      title: RegisterUserAccountDTO
+      type: object
+      properties:
+        email:
+          type: string
+        gender:
+          type: string
+        name:
+          type: string
+        password:
+          type: string
+        surname:
+          type: string
+        username:
+          type: string
+    RoleDTO:
+      title: RoleDTO
+      type: object
+      properties:
+        id:
+          type: integer
+          format: int64
+        permissions:
+          type: array
+          items:
+            $ref: '#/components/schemas/PermissionDTO'
+        role:
+          type: string
+    UserDTO:
+      title: UserDTO
+      type: object
+      properties:
+        addressDTO:
+          $ref: '#/components/schemas/AddressDTO'
+        birthDate:
+          type: string
+          format: date
+        contactDTO:
+          $ref: '#/components/schemas/ContactDTO'
+        creationDt:
+          type: string
+          format: date-time
+        enabled:
+          type: boolean
+        gender:
+          type: string
+        id:
+          type: integer
+          format: int64
+        loginDt:
+          type: string
+          format: date-time
+        name:
+          type: string
+        note:
+          type: string
+        permissions:
+          type: array
+          items:
+            type: string
+        roles:
+          type: array
+          items:
+            type: string
+        secured:
+          type: boolean
+        surname:
+          type: string
+        updatedDt:
+          type: string
+          format: date-time
+        username:
+          type: string
+    UserListDTO:
+      title: UserListDTO
+      type: object
+      properties:
+        userList:
+          type: array
+          items:
+            $ref: '#/components/schemas/UserDTO'
+    View:
+      title: View
+      type: object
+      properties:
+        contentType:
+          type: string
+x-original-swagger-version: "2.0"

aratrl-service/jdk11/market/.gitignore

@@ -0,0 +1,17 @@
+!.idea
+.idea/*
+!.idea/codeStyles
+*.iml
+.gradle
+build
+classes
+*/out
+.classpath
+.project
+.settings
+*/bin
+*.orig
+.attach_pid*
+java_pid*.hprof
+.DS_Store
+!.mvn/wrapper/maven-wrapper.jar

aratrl-service/jdk11/market/.idea/codeStyles/Project.xml

@@ -0,0 +1,31 @@
+<component name="ProjectCodeStyleConfiguration">
+  <code_scheme name="Project" version="173">
+    <HTMLCodeStyleSettings>
+      <option name="HTML_TEXT_WRAP" value="0" />
+      <option name="HTML_ALIGN_TEXT" value="true" />
+      <option name="HTML_KEEP_WHITESPACES_INSIDE" value="span,pre,textarea,script" />
+    </HTMLCodeStyleSettings>
+    <JavaCodeStyleSettings>
+      <option name="CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND" value="10" />
+      <option name="NAMES_COUNT_TO_USE_IMPORT_ON_DEMAND" value="10" />
+    </JavaCodeStyleSettings>
+    <codeStyleSettings language="HTML">
+      <indentOptions>
+        <option name="USE_TAB_CHARACTER" value="true" />
+      </indentOptions>
+    </codeStyleSettings>
+    <codeStyleSettings language="JAVA">
+      <option name="ALIGN_MULTILINE_PARAMETERS" value="false" />
+      <indentOptions>
+        <option name="CONTINUATION_INDENT_SIZE" value="4" />
+        <option name="USE_TAB_CHARACTER" value="true" />
+        <option name="SMART_TABS" value="true" />
+      </indentOptions>
+    </codeStyleSettings>
+    <codeStyleSettings language="XML">
+      <indentOptions>
+        <option name="USE_TAB_CHARACTER" value="true" />
+      </indentOptions>
+    </codeStyleSettings>
+  </code_scheme>
+</component>

aratrl-service/jdk11/market/.idea/codeStyles/codeStyleConfig.xml

@@ -0,0 +1,5 @@
+<component name="ProjectCodeStyleConfiguration">
+  <state>
+    <option name="USE_PER_PROJECT_SETTINGS" value="true" />
+  </state>
+</component>

aratrl-service/jdk11/market/.mvn/wrapper/MavenWrapperDownloader.java

@@ -0,0 +1,117 @@
+/*
+ * Copyright 2007-present the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import java.net.*;
+import java.io.*;
+import java.nio.channels.*;
+import java.util.Properties;
+
+public class MavenWrapperDownloader {
+
+    private static final String WRAPPER_VERSION = "0.5.6";
+    /**
+     * Default URL to download the maven-wrapper.jar from, if no 'downloadUrl' is provided.
+     */
+    private static final String DEFAULT_DOWNLOAD_URL = "https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/"
+        + WRAPPER_VERSION + "/maven-wrapper-" + WRAPPER_VERSION + ".jar";
+
+    /**
+     * Path to the maven-wrapper.properties file, which might contain a downloadUrl property to
+     * use instead of the default one.
+     */
+    private static final String MAVEN_WRAPPER_PROPERTIES_PATH =
+            ".mvn/wrapper/maven-wrapper.properties";
+
+    /**
+     * Path where the maven-wrapper.jar will be saved to.
+     */
+    private static final String MAVEN_WRAPPER_JAR_PATH =
+            ".mvn/wrapper/maven-wrapper.jar";
+
+    /**
+     * Name of the property which should be used to override the default download url for the wrapper.
+     */
+    private static final String PROPERTY_NAME_WRAPPER_URL = "wrapperUrl";
+
+    public static void main(String args[]) {
+        System.out.println("- Downloader started");
+        File baseDirectory = new File(args[0]);
+        System.out.println("- Using base directory: " + baseDirectory.getAbsolutePath());
+
+        // If the maven-wrapper.properties exists, read it and check if it contains a custom
+        // wrapperUrl parameter.
+        File mavenWrapperPropertyFile = new File(baseDirectory, MAVEN_WRAPPER_PROPERTIES_PATH);
+        String url = DEFAULT_DOWNLOAD_URL;
+        if(mavenWrapperPropertyFile.exists()) {
+            FileInputStream mavenWrapperPropertyFileInputStream = null;
+            try {
+                mavenWrapperPropertyFileInputStream = new FileInputStream(mavenWrapperPropertyFile);
+                Properties mavenWrapperProperties = new Properties();
+                mavenWrapperProperties.load(mavenWrapperPropertyFileInputStream);
+                url = mavenWrapperProperties.getProperty(PROPERTY_NAME_WRAPPER_URL, url);
+            } catch (IOException e) {
+                System.out.println("- ERROR loading '" + MAVEN_WRAPPER_PROPERTIES_PATH + "'");
+            } finally {
+                try {
+                    if(mavenWrapperPropertyFileInputStream != null) {
+                        mavenWrapperPropertyFileInputStream.close();
+                    }
+                } catch (IOException e) {
+                    // Ignore ...
+                }
+            }
+        }
+        System.out.println("- Downloading from: " + url);
+
+        File outputFile = new File(baseDirectory.getAbsolutePath(), MAVEN_WRAPPER_JAR_PATH);
+        if(!outputFile.getParentFile().exists()) {
+            if(!outputFile.getParentFile().mkdirs()) {
+                System.out.println(
+                        "- ERROR creating output directory '" + outputFile.getParentFile().getAbsolutePath() + "'");
+            }
+        }
+        System.out.println("- Downloading to: " + outputFile.getAbsolutePath());
+        try {
+            downloadFileFromURL(url, outputFile);
+            System.out.println("Done");
+            System.exit(0);
+        } catch (Throwable e) {
+            System.out.println("- Error downloading");
+            e.printStackTrace();
+            System.exit(1);
+        }
+    }
+
+    private static void downloadFileFromURL(String urlString, File destination) throws Exception {
+        if (System.getenv("MVNW_USERNAME") != null && System.getenv("MVNW_PASSWORD") != null) {
+            String username = System.getenv("MVNW_USERNAME");
+            char[] password = System.getenv("MVNW_PASSWORD").toCharArray();
+            Authenticator.setDefault(new Authenticator() {
+                @Override
+                protected PasswordAuthentication getPasswordAuthentication() {
+                    return new PasswordAuthentication(username, password);
+                }
+            });
+        }
+        URL website = new URL(urlString);
+        ReadableByteChannel rbc;
+        rbc = Channels.newChannel(website.openStream());
+        FileOutputStream fos = new FileOutputStream(destination);
+        fos.getChannel().transferFrom(rbc, 0, Long.MAX_VALUE);
+        fos.close();
+        rbc.close();
+    }
+
+}

aratrl-service/jdk11/market/.mvn/wrapper/maven-wrapper.jar

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:0f37e00f4a503f19cfb1b8100b1f251f241cd1981524761bb9454037cb97589d
+size 50710

aratrl-service/jdk11/market/.mvn/wrapper/maven-wrapper.properties

@@ -0,0 +1,2 @@
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.6.3/apache-maven-3.6.3-bin.zip
+wrapperUrl=https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar

aratrl-service/jdk11/market/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Aleksey Lukyanets
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

aratrl-service/jdk11/market/README.adoc

@@ -0,0 +1,80 @@
+= Simple internet-market
+
+image:https://api.codacy.com/project/badge/Grade/8c0bd51bdba44e04bd2cbbfd7f643e9f[link=https://www.codacy.com/manual/aleksey-lukyanets/market?utm_source=github.com&utm_medium=referral&utm_content=aleksey-lukyanets/market&utm_campaign=Badge_Grade]
+image:https://api.codacy.com/project/badge/Coverage/8c0bd51bdba44e04bd2cbbfd7f643e9f[link=https://www.codacy.com/manual/aleksey-lukyanets/market?utm_source=github.com&utm_medium=referral&utm_content=aleksey-lukyanets/market&utm_campaign=Badge_Coverage]
+image:https://github.com/aleksey-lukyanets/market/workflows/build/badge.svg[link]
+
+This project was started in 2014 as a study for Spring and related web technologies,
+partly modernized in 2020-21. Since around 2014 professionally I am focused on backend development,
+a modernization/maintenance of this project continues occasionally.
+This is not a perfectly finished project, so it may contain bugs, imperfection and some mess.
+
+== Technologies
+
+* servlet: ``Spring MVC`` ``Thymeleaf`` ``jQuery`` ``Spring Security``
+* data: ``Spring Data JPA`` ``H2`` ``Hibernate``
+* RESTful service: ``Spring MVC`` ``Spring HATEOAS``
+* tests: ``JUnit`` ``Hamcrest`` ``Mockito`` ``JSONPath``
+
+== How to
+
+The project is divided to modules and includes two applications:
+
+* a web-application, module ``market-web``
+* a RESTful service, module ``market-rest``
+
+Each of the two could be run separately by executing the following Maven command
+against specific module from the root directory of the project:
+
+``./mvnw spring-boot:run -pl <module-name, e.g. market-web>``
+
+You may also use ``mvn`` in case you prefer standalone Maven.
+
+[%header,cols=".^2,.^3,.^3",width=90%]
+|===
+| |Web application |RESTful service
+|*module* |market-web |market-rest
+|*Java version* 2+^|11
+|*built packages* 2+^|https://github.com/aleksey-lukyanets/market/packages/
+|*main class* |``WebApplication.java`` |``RestApplication.java``
+|*default port* |8080 |8081
+|*basic URL* |``localhost:8080`` |``localhost:8081/products``
+|*user login* 2+|``admin/password`` ``ivan.petrov@yandex.ru/petrov``
+|*logs* 2+|``logs/``
+|*H2 console* |``localhost:8080/h2-console/`` |``localhost:8081/h2-console/``
+|*Swagger UI* |- |``localhost:8081/swagger-ui/#/``
+|===
+
+== Functionality
+
+* Visual representation of the product range
+* Customer's shopping cart
+** selecting a product: add, delete, change a quantity
+** viewing the contents of the cart
+** placing an order
+** storing in the database a shopping cart of a registered customer
+* Market control panel
+** products and categories: add, edit, delete
+** viewing information about placed orders
+** managing the availability of goods in stock
+** transfer orders from the "in progress" state to the "executed" state
+* Secured access to the application
+** registration and authorization of customers
+** restricted access to the control panel
+* Double check of form content: client-side and server-side
+
+== Databases
+
+By default applications use in-memory H2 database.
+Run application with Spring profile ``prod`` to connect to a standalone database (PostreSQL)
+with market/market username and password.
+
+== Legacy branches
+
+``jsp-2021`` - status with web views based on JSP and Apache Tiles, before moving to Thymeleaf
+
+``good-old-2014`` - status for 2014
+
+== Links
+
+For project description in Russian from good old 2014 refer to ``README_RU.md``

aratrl-service/jdk11/market/README_RU.md

@@ -0,0 +1,316 @@
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/8c0bd51bdba44e04bd2cbbfd7f643e9f)](https://www.codacy.com/manual/aleksey-lukyanets/market?utm_source=github.com&utm_medium=referral&utm_content=aleksey-lukyanets/market&utm_campaign=Badge_Grade)
+[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/8c0bd51bdba44e04bd2cbbfd7f643e9f)](https://www.codacy.com/manual/aleksey-lukyanets/market?utm_source=github.com&utm_medium=referral&utm_content=aleksey-lukyanets/market&utm_campaign=Badge_Coverage)
+![build](https://github.com/aleksey-lukyanets/market/workflows/build/badge.svg)
+
+<h2>Технологии</h2>
+
+<ul class="discharged">
+    <li>сервлет: Spring MVC, JavaServer Pages, Arache Tiles</li>
+    <li>авторизация пользователей: Spring Security</li>
+    <li>доступ к данным: Hibernate, Spring Data JPA</li>
+    <li>веб-служба в стиле REST</li>
+    <li>тесты: Spring Test, JUnit, Hamcrest, JSONPath;</li>
+    <li>веб-интерфейс: jQuery, jQuery Validate Plugin, Bootstrap</li>
+    <li>база данных: PostgreSQL</li>
+    <li>контейнер сервлетов: Apache Tomcat</li>
+</ul>
+
+<h2>Функционал магазина</h2>
+
+<ol class="discharged">
+    <li>Наглядное представление ассортимента товаров</li>
+    <li>Корзина покупателя
+        <ul>
+            <li>выбор товаров: добавление, удаление, изменение количества</li>
+            <li>просмотр содержимого корзины</li>
+            <li>оформление заказа</li>
+            <li>хранение корзины зарегистрированного покупателя в базе данных</li>
+        </ul>
+    </li>
+    <li>Панель управления магазином
+        <ul>
+            <li>товары и категории: добавление, редактирование, удаление</li>
+            <li>просмотр информации о размещённых заказах</li>
+            <li>управление наличием товаров на складе</li>
+            <li>перевод заказов из состояния "в исполнении" в состояние "исполнен"</li>
+        </ul>        
+    </li>
+    <li>Безопасный доступ к приложению
+        <ul>
+            <li>регистрация и авторизация пользователей</li>
+            <li>ограничение доступа к панели управления</li>
+        </ul>
+    </li>
+    <li>Двойная проверка содержимого форм: на стороне клиента и на стороне сервера</li>
+</ol>
+
+<h2>Оформление заказа</h2>
+
+<p>Ниже приведена диаграмма процесса оформления заказа, на которую нанесены
+    элементы данных и доступные покупателю действия.</p>
+<center>
+    <a href="http://46.101.111.55:8080/resources/img/checkout-flow.png">
+        <img src="http://46.101.111.55:8080/resources/img/checkout-flow.png"
+             alt="процесс оформления заказа"/>
+    </a>
+</center>
+<br>
+
+<h2>Веб-служба REST</h2>
+
+<p>Помимо гипертекстового интерфейса магазин представляет веб-службу, через которую
+    доступен функционал магазина. Описание веб-службы находится на странице
+    <a href="<c:url value='/rest-api' />">REST API</a>.</p>
+
+<h2>Сортировка, фильтрация, разбивка на страницы</h2>
+
+<p>Приложение предоставляет возможность просматривать ресурсы удобным пользователю способом.</p>
+<p>Не нарушая принципов стиля REST, критерии передаются в параметрах URI. Например,
+    в панели управления магазином так выглядит запрос отображения таблицы всех имеющихся
+    в наличии товаров, с сортировкой по возрастанию цены и 5 товаров на странице:
+    <code><b>/admin/storage</b> ? available=true &amp; direct=asc &amp; size=5</code>
+    (без пробелов).</p>
+<p>Операции сортировки, фильтрации и постраничного отображения выделены в отдельную
+    иерархию классов в пакете <code>market.sorting</code>, которая объединяет
+    методы изменения значений опций, формирования запроса к БД (<code>PageRequest</code>
+    Spring Data) и добавления всех необходимых данных к модели <code>Model</code> Spring MVC.</p>
+
+<h2>Валидация форм</h2>
+
+<p>Проверка данных всех форм пользовательского и административного интерфейса выполняется
+    дважды: на стороне пользователя и на стороне сервера.</p>
+<ul class="discharged">
+    <li>Проверка на стороне пользователя осуществляется с использованием jQuery Validate Plugin,
+        который проверяет данные в момент ввода средствами JavaSript. Для посимвольной проверки строки применены
+        регулярные выражения (regex). Визуализация дополнена классами Bootstrap.</li>
+    <li>Проверка на стороне сервера выполняется с использованием пакетов <code>javax.validation</code> и
+        <code>org.springframework.validation</code>.</li>
+</ul>
+<p>Такой подход к валидации форм делает процесс проверки данных комфортным
+    для пользователя и вместе с тем гарантирует выполнение проверки при отключённом
+    JavaScript в браузере пользователя.</p>
+
+<h2>Обработка исключений</h2>
+
+<p>В приложении реализована централизованная обработка исключений классом
+    <code>market.controller.SpringExceptionHandler</code> с аннотацией
+    <code>@ControllerAdvice</code>, предоставленной Spring.</p>
+<p>Помимо объединения обработчиков в единый класс, такой подход позволяет
+    вынести проверку авторизации клиентов веб-сервиса из реализации контроллеров:
+    права пользователя проверяются перехватчиком
+    <code>market.interceptor.RestUserCheckInterceptor</code> и в случае неудачной
+    аутентификации исключение <code>RestNotAuthenticatedException</code> передаётся
+    обработчику в обход контроллеров, с последующим возвратом клиенту HTTP-состояния
+    <code>401 Unauthorized</code> (вместо перенаправления на страницу входа, как в случае
+    гипертекстового интерфейса магазина). При удачной аутентификации запрос
+    передаётся соответствующему контроллеру.</p>
+
+<h2>Модель базы данных</h2>
+
+<p>База данных приложения состоит из 13 связанных таблиц, отображаемых средствами Hibernate в 14 классов.</p>
+
+<center>
+    <a href="http://46.101.111.55:8080/resources/img/database-model.png">
+        <img src="http://46.101.111.55:8080/resources/img/database-model.png"
+             width="500" alt="схема базы данных"/>
+    </a>
+</center>
+<br>
+<p>Слой доступа к данным на первоначальном этапе разработки был представлен классами DAO,
+    а с введением функций разбивки на страницы и сортировки реализован
+    с помощью репозитория Spring Data JPA.</p>
+
+<h2>Пользовательские классы Spring</h2>
+
+<p>Функционал фреймворков Spring MVC и Spring Security расширен следующими классами:</p>
+<ul class="discharged">
+    <li><code>UserDetailsServiceImpl</code> реализует интерфейс <code>UserDetailsService</code>
+        и обеспечивает извлечение профиля пользователя из базы данных;</li>
+    <li><code>CustomAuthenticationSuccessHandler</code> реализует интерфейс
+        <code>AuthenticationSuccessHandler</code> и обрабатывает событие успешной аутентификации пользователя;</li>
+    <li><code>SpringExceptionHandler</code> осуществляет централизованную обработку исключений;</li>
+    <li><code>SessionCartInterceptor</code> реализует интерфейс <code>HandlerInterceptorAdapter</code>
+        и проверяет до обработки запроса контроллерами, существует ли в модели атрибут корзины покупателя;
+        п��и отсутствии создатся новая корзина; такое решение позволяет централизовать создание корзины,
+        в том числе для случая, когда браузер пользователя не принимает cookies и поэтому
+        не поддерживает хранение параметров сессии;</li>
+    <li><code>RestUserCheckInterceptor</code> реализует интерфейс <code>HandlerInterceptorAdapter</code>
+        и используется для проверки прав пользователя при доступе к веб-службе.</li>
+</ul>
+
+<h1>Веб-служба REST</h1>
+
+<p>REST-интерфейс приложения предоставляет доступ к ресурсам магазина: позволяет
+    регистрировать покупателей, изменять их контактные данные, запрашивать
+    сведения о товарах, добавлять товары в корзину и оформлять заказы.</p>
+<p>Обмен данными между клиентом и веб-службой магазина осуществляется в формате JSON,
+    аутентификация выполняется средствами Basic Authentication.</p>
+<p>В соответствии со стилем REST, взаимодействие между клиентом и сервером лишено
+    сеансового состояния, поэтому веб-служба магазина не предоставляет гостевую
+    корзину: информация о товарах доступна всем клиентам, но заказ может быть
+    собран и оформлен только зарегистрированным пользователем.</p>
+<p>Ниже приводится интерфейс веб-службы и примеры взаимодействия.</p>
+
+<h2>Взаимодействие с веб-службой</h2>
+
+<p>Доступ к ресурсам магазина можно получить с использованием любого HTTP-клиента,
+    поддерживающего Basic-аутентификацию, например RESTClient для Mozilla Firefox.</p>
+<p>Так обращение к ресурсу <code>http://46.101.111.55:8080/rest/products</code>
+    возвращает список всех товаров:</p>
+<pre style="width: 95%;">[<br/>    {<br/>        "productId": 1,<br/>        "distillery": "Ardbeg",<br/>        "name": "Ten",<br/>        "price": 4030,<br/>        "links": [{<br/>                "rel": "self",<br/>                "href": "http://46.101.111.55:8080/rest/products/1"}]<br/>    },<br/>    {<br/>        "productId": 2,<br/>        "distillery": "Balvenie",<br/>        "name": "12 y.o. Doublewood",<br/>        "price": 4100,<br/>        "links": [{<br/>                "rel": "self",<br/>                "href": "http://46.101.111.55:8080/rest/products/2" }]<br/>    }<br/>    <br/>    ...<br/>]</pre>
+<p>Сведения об отдельном товаре доступны по его идентификатору.
+    Ресурс <code>/products/2</code>:</p>
+<pre style="width: 85%;">{<br/>    "id": 2,<br/>    "distillery": "Balvenie",<br/>    "name": "12 y.o. Doublewood",<br/>    "price": 4100,<br/>    "age": 12,<br/>    "volume": 700,<br/>    "alcohol": 40,<br/>    "description": "Помимо стандартных бочек выдерживается в бочках<br/>            из-под хереса. Гармоничный аромат свежего мёда, ванили,<br/>            воска, дуба и цветочной пыльцы с сухой горчинкой.",<br/>    "inStock": true<br/>}</pre>
+
+<br>
+<h5>Регистрация покупателя</h5>
+
+<p>Регистрация нового покупателя осуществляется отправкой запроса <code>POST /signup</code>:</p>
+<pre style="width: 75%;">заголовок:   Content-Type: application/json; charset=UTF-8<br>тело:        {<br>                 "email": "ivan.petrov@yandex.ru",<br>                 "name": "Иван Петров",<br>                 "password": "Иван Петров",<br>                 "phone": "+7 123 456 67 89",<br>                 "address": "ул. Итальянская, д. 7"<br>             }</pre>
+<p>Ответ приложения при успешном создании аккаунта: <code>200 Ok</code>.</p>
+<p>Если покупатель с указанным адресом электронной почты уже существует в магазине,
+    либо если возникли нарушения при валидации переданных данных, клиенту будет возвращено
+    HTTP-состояние <code>406 Not Acceptable</code> с соответствующими пояснениями.</p>
+<p>Например, об ошибке в имени <code>"name": "name@#$%^"</code>
+    сервер уведомит ответом:</p>
+<pre style="width: 95%;">{<br>    "fieldErrors":<br>    [{<br>        "field": "name",<br>        "message": "В имени допустимы только буквы, пробел, дефис и апостроф."<br>    }]<br>}</pre>
+<p>Получить или изменить контактные данные можно обращением к ресурсу соответственно
+    <code>/customer/contacts</code> запросами GET или PUT.</p>
+
+<br>
+<h5>Формирование заказа</h5>
+
+<p>Зарегистрированный покупатель может добавить товар в корзину запросом <code>PUT /cart</code>:</p>
+<pre style="width: 95%;">заголовок:   Content-Type: application/json; charset=UTF-8<br>             Authorization: Basic aXZhbi5wZXRyb3ZAeWFuZGV4LnJ10nBldHJvdg==<br>тело:        {"productId": 2, "quantity": 1}</pre>
+<p>В ответе приложение вернёт изменённую корзину:</p>
+<pre style="width: 95%;">заголовок:   Status Code: 200 Ok<br>             Content-Type: application/json; charset=UTF-8<br>тело:        {<br>                "user": "ivan.petrov@yandex.ru",<br>                "items":<br>                [<br>                    {<br>                        "productId": 2,<br>                        "quantity": 1,<br>                        "links": [{<br>                            "rel": "self",<br>                            "href": "http://46.101.111.55:8080/rest/products/2" }]<br>                    }<br>                ],<br>                "totalItems": 1,<br>                "productsCost": 4100,<br>                "deliveryCost": 400,<br>                "deliveryIncluded": true,<br>                "totalCost": 4500,<br>                "links":<br>                [<br>                    {<br>                        "rel": "Customer contacts",<br>                        "href": "http://46.101.111.55:8080/rest/customer/contacts"<br>                    },<br>                    {<br>                        "rel": "Payment",<br>                        "href": "http://46.101.111.55:8080/rest/cart/payment"<br>                    }<br>                ]<br>             }</pre>
+<p>Опция доставки может быть изменена запросом <code>PUT /cart/delivery/{boolean}</code>.</p>
+<br>
+<p>Для оформления заказа следует отправить номер банковской карты, с которой
+    будет оплачен заказ, запросом <code>POST /cart/payment</code>:</p>
+<pre style="width: 95%;">заголовок:   Content-Type: application/json; charset=UTF-8<br>             Authorization: Basic aXZhbi5wZXRyb3ZAeWFuZGV4LnJ10nBldHJvdg==<br>тело:        {"number": "4444 3333 2222 1111"}</pre>
+<p>Приложение вернёт подтверждение об оплате и приёме заказа:</p>
+<pre style="width: 95%;">заголовок:   Status Code: 201 Created<br>             Location: http://46.101.111.55:8080/rest/customer/orders/13<br>             Content-Type: application/json; charset=UTF-8<br>тело:        {<br>                  "id": 13,<br>                  "user": "ivan.petrov@yandex.ru",<br>                  "billNumber": 525553712,<br>                  "dateCreated": 1397559589798,<br>                  "productsCost": 4100,<br>                  "deliveryCost": 400,<br>                  "deliveryIncluded": true,<br>                  "totalCost": 4500,<br>                  "payed": true,<br>                  "executed": false<br>             }</pre>
+<p>Получить перечень всех оставленных покупателем заказов можно обратившись к ресурсу
+    <code>/customer/orders</code>.</p>
+<br>
+
+<h2>Операции с ресурсами</h2>
+
+<h4>Сведения о товарах</h4>
+<table class="table table-marked">
+    <thead>
+        <tr>
+            <th width="200">ресурс</th>
+            <th width="170">описание</th>
+            <th>статусы ответа</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td>GET /products</td>
+            <td>Возвращает перечень всех товаров магазина</td>
+            <td>200</td>
+        </tr>
+        <tr>
+            <td>GET /products/:id</td>
+            <td>Возвращает товар с указанным id</td>
+            <td>200 — товар возвращён в теле ответа,<br>
+                404 — товара с таким id не существует</td>
+        </tr>
+    </tbody>
+</table>
+
+<h4>Корзина покупателя (требует авторизации)</h4>
+<table class="table table-marked">
+    <thead>
+        <tr>
+            <th width="200">ресурс</th>
+            <th width="170">описание</th>
+            <th>статусы ответа</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td>GET /cart</td>
+            <td>Возвращает корзину покупателя</td>
+            <td>200</td>
+        </tr>
+        <tr>
+            <td>PUT /cart</td>
+            <td>Добавляет товар в корзину</td>
+            <td>200 — товар добавлен, обновлённая корзина находится в теле ответа,<br>
+                406 — товара с запрошенным id не существует; пояснения в теле ответа</td>
+        </tr>
+        <tr>
+            <td>DELETE /cart</td>
+            <td>Удаляет из корзины все товары</td>
+            <td>200 — корзина очищена, обновлённая корзина находится в теле ответа</td>
+        </tr>
+        <tr>
+            <td>PUT /cart/delivery/:boolean</td>
+            <td>Включает в заказ доставку</td>
+            <td>200 — опция доставки изменена, обновлённая корзина находится в теле ответа</td>
+        </tr>
+        <tr>
+            <td>POST /cart/payment</td>
+            <td>Подтверждает заказ и оплачивает его картой с указанным номером</td>
+            <td>201 — заказ оплачен и принят, ссылка на заказ находится в заголовке, детали заказа — в теле ответа,<br>
+                406 — некорректный формат номера карты, либо корзина пуста; пояснения в теле ответа</td>
+        </tr>
+    </tbody>
+</table>
+
+<h4>Регистрация нового покупателя</h4>
+<table class="table table-marked">
+    <thead>
+        <tr>
+            <th width="200">ресурс</th>
+            <th width="170">описание</th>
+            <th>статусы ответа</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td>POST /signup</td>
+            <td>Регистрирует нового покупателя</td>
+            <td>200 — покупатель зарегистрирован и возвращён в теле ответа,<br>
+                406 — некорректный формат полученных данных; пояснения в теле ответа</td>
+        </tr>
+    </tbody>
+</table>
+
+<h4>Профиль покупателя (требует авторизации)</h4>
+<table class="table table-marked">
+    <thead>
+        <tr>
+            <th width="200">ресурс</th>
+            <th width="170">описание</th>
+            <th>статусы ответа</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td>GET /customer/contacts</td>
+            <td>Возвращает контактные данные покупателя</td>
+            <td>200 — контактные данные возвращены в теле ответа</td>
+        </tr>
+        <tr>
+            <td>PUT /customer/contacts</td>
+            <td>Изменяет контактные данные покупателя</td>
+            <td>200 — данные изменены, обновлённые возвращены в теле ответа,<br>
+                406 — некорректный формат полученных данных; пояснения в теле ответа</td>
+        </tr>
+        <tr>
+            <td>GET /customer/orders</td>
+            <td>Возвращает перечень заказов покупателя</td>
+            <td>200 — перечень заказов возвращён в теле ответа</td>
+        </tr>
+        <tr>
+            <td>GET /customer/orders/:id</td>
+            <td>Возвращает заказ с указанным id</td>
+            <td>200 — заказ возвращён в теле ответа,<br>
+                404 — заказ с таким id у авторизованного пользователя не существует</td>
+        </tr>
+    </tbody>
+</table>

aratrl-service/jdk11/market/market-core/pom.xml

@@ -0,0 +1,99 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+		 xmlns="http://maven.apache.org/POM/4.0.0"
+		 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<parent>
+		<artifactId>market</artifactId>
+		<groupId>net.lukyanets</groupId>
+		<version>0.1.2</version>
+		<relativePath>..</relativePath>
+	</parent>
+	<modelVersion>4.0.0</modelVersion>
+
+	<artifactId>market-core</artifactId>
+	<version>0.1.2</version>
+
+	<name>market-core</name>
+
+	<properties>
+		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+	</properties>
+
+	<build>
+		<plugins>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-surefire-plugin</artifactId>
+				<version>${maven.surefire.plugin.version}</version>
+			</plugin>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-deploy-plugin</artifactId>
+				<version>2.8.2</version>
+				<configuration>
+					<skip>true</skip>
+				</configuration>
+			</plugin>
+			<plugin>
+				<groupId>org.jacoco</groupId>
+				<artifactId>jacoco-maven-plugin</artifactId>
+				<version>${jacoco.version}</version>
+				<executions>
+					<execution>
+						<goals>
+							<goal>prepare-agent</goal>
+						</goals>
+					</execution>
+					<execution>
+						<id>report</id>
+						<phase>prepare-package</phase>
+						<goals>
+							<goal>report</goal>
+						</goals>
+					</execution>
+				</executions>
+				<configuration>
+					<excludes>
+						<exclude>**/*market/dto/**</exclude>
+						<exclude>**/*market/exception/**</exclude>
+					</excludes>
+				</configuration>
+			</plugin>
+		</plugins>
+	</build>
+
+	<dependencies>
+		<dependency>
+			<groupId>com.h2database</groupId>
+			<artifactId>h2</artifactId>
+			<scope>runtime</scope>
+		</dependency>
+
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-data-jpa</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-jdbc</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-security</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-validation</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-hateoas</artifactId>
+		</dependency>
+
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-test</artifactId>
+		</dependency>
+	</dependencies>
+
+</project>

aratrl-service/jdk11/market/market-core/src/main/java/market/DataConfig.java

@@ -0,0 +1,65 @@
+package market;
+
+import com.zaxxer.hikari.HikariDataSource;
+import org.springframework.boot.autoconfigure.domain.EntityScan;
+import org.springframework.boot.autoconfigure.jdbc.DataSourceProperties;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.ComponentScan;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Primary;
+import org.springframework.dao.annotation.PersistenceExceptionTranslationPostProcessor;
+import org.springframework.orm.jpa.JpaTransactionManager;
+import org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean;
+import org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter;
+import org.springframework.transaction.PlatformTransactionManager;
+import org.springframework.transaction.annotation.EnableTransactionManagement;
+
+import javax.persistence.EntityManagerFactory;
+import javax.sql.DataSource;
+
+@Configuration
+@EntityScan(basePackages="market.domain")
+@EnableTransactionManagement
+@ComponentScan(basePackages = {
+	"market.properties",
+	"market.service"
+})
+public class DataConfig {
+
+	@Bean
+	@Primary
+	@ConfigurationProperties("spring.datasource")
+	public DataSourceProperties dataSourceProperties() {
+		return new DataSourceProperties();
+	}
+
+	@Bean // with Spring Boot this is actually not necessary but leaving it to note things explicitly
+	@Primary
+	@ConfigurationProperties("spring.datasource.configuration")
+	public HikariDataSource dataSource() {
+		DataSourceProperties properties = dataSourceProperties();
+		return properties.initializeDataSourceBuilder().type(HikariDataSource.class).build();
+	}
+
+	@Bean
+	public LocalContainerEntityManagerFactoryBean entityManagerFactory(DataSource dataSource) {
+		LocalContainerEntityManagerFactoryBean em = new LocalContainerEntityManagerFactoryBean(); // todo: EntityManagerFactoryBuilder ?
+		em.setDataSource(dataSource);
+		em.setPackagesToScan("market.domain");
+		em.setJpaVendorAdapter(new HibernateJpaVendorAdapter());
+		return em;
+	}
+
+	@Bean
+	public PlatformTransactionManager transactionManager(EntityManagerFactory emf) {
+		JpaTransactionManager transactionManager = new JpaTransactionManager();
+		transactionManager.setEntityManagerFactory(emf);
+		return transactionManager;
+	}
+
+	@Bean
+	public PersistenceExceptionTranslationPostProcessor exceptionTranslation() {
+		return new PersistenceExceptionTranslationPostProcessor();
+	}
+}

aratrl-service/jdk11/market/market-core/src/main/java/market/FixturesFactory.java

@@ -0,0 +1,116 @@
+package market;
+
+import market.domain.*;
+
+import java.util.Date;
+
+public class FixturesFactory {
+	private static final String DISTILLERY_TITLE = "distillery_title";
+	private static final String DISTILLERY_DESCRIPTION = "distillery_description";
+
+	private static final String REGION_NAME = "region name";
+	private static final String REGION_SUBTITLE = "region subtitle";
+	private static final String REGION_DESCRIPTION = "region description";
+	private static final String REGION_COLOR = "#ffffff";
+
+	private static final double PRODUCT_PRICE = 100.0;
+	private static final String PRODUCT_NAME = "product_name";
+	private static final int PRODUCT_AGE = 10;
+	private static final float PRODUCT_ALCOHOL = 40;
+	private static final int PRODUCT_VOLUME = 700;
+	private static final String PRODUCT_DESCRIPTION = "product_description";
+	private static final boolean PRODUCT_AVAILABLE = true;
+
+	private static final String ACCOUNT_EMAIL = "email@domain.com";
+	private static final String ACCOUNT_PASSWORD = "password";
+	private static final String ACCOUNT_NAME = "Name";
+	private static final boolean ACCOUNT_ACTIVE = true;
+
+	private static final String CONTACTS_PHONE = "+97211234567";
+	private static final String CONTACTS_ADDRESS = "some_address";
+
+	private static final int ORDERED_PRODUCT_QUANTITY = 3;
+
+	private static final String BILL_CARD_NUMBER = "1111222233334444";
+
+	private static long regionId = 123L;
+	private static long distilleryId = 234L;
+	private static long productId = 10L;
+	private static long accountId = 50L;
+	private static long orderId = 3000L;
+	private static int billId = 400;
+
+	public static Region.Builder region() {
+		return new Region.Builder()
+			.setId(++regionId)
+			.setName(REGION_NAME + regionId)
+			.setSubtitle(REGION_SUBTITLE)
+			.setDescription(REGION_DESCRIPTION)
+			.setColor(REGION_COLOR);
+	}
+
+	public static Distillery.Builder distillery(Region region) {
+		return new Distillery.Builder()
+			.setId(++distilleryId)
+			.setRegion(region)
+			.setTitle(DISTILLERY_TITLE + distilleryId)
+			.setDescription(DISTILLERY_DESCRIPTION);
+	}
+
+	public static Product.Builder product(Distillery distillery) {
+		return new Product.Builder()
+			.setId(++productId)
+			.setDistillery(distillery)
+			.setName(PRODUCT_NAME + productId)
+			.setAge(PRODUCT_AGE)
+			.setAlcohol(PRODUCT_ALCOHOL)
+			.setPrice(PRODUCT_PRICE)
+			.setVolume(PRODUCT_VOLUME)
+			.setDescription(PRODUCT_DESCRIPTION)
+			.setAvailable(PRODUCT_AVAILABLE);
+	}
+
+	public static UserAccount.Builder account(Cart cart) {
+		return account()
+			.setCart(cart);
+	}
+
+	public static UserAccount.Builder account() {
+		return new UserAccount.Builder()
+			.setId(++accountId)
+			.setEmail(ACCOUNT_EMAIL)
+			.setPassword(ACCOUNT_PASSWORD)
+			.setName(ACCOUNT_NAME)
+			.setActive(ACCOUNT_ACTIVE);
+	}
+
+	public static Contacts.Builder contacts() {
+		return new Contacts.Builder()
+			.setPhone(CONTACTS_PHONE)
+			.setAddress(CONTACTS_ADDRESS);
+	}
+
+	public static Order.Builder order(UserAccount userAccount) {
+		return new Order.Builder()
+			.setId(++orderId)
+			.setUserAccount(userAccount)
+			.setDateCreated(new Date());
+	}
+
+	public static OrderedProduct.Builder orderedProduct(Order order, Product product) {
+		return new OrderedProduct.Builder()
+			.setProduct(product)
+			.setOrder(order)
+			.setQuantity(ORDERED_PRODUCT_QUANTITY);
+	}
+
+	public static Bill.Builder bill(Order order) {
+		return new Bill.Builder()
+			.setOrder(order)
+			.setNumber(++billId)
+			.setTotalCost(order.getProductsCost() + order.getDeliveryCost())
+			.setPayed(true)
+			.setDateCreated(new Date())
+			.setCcNumber(BILL_CARD_NUMBER);
+	}
+}

aratrl-service/jdk11/market/market-core/src/main/java/market/SecurityConfigBase.java

@@ -0,0 +1,63 @@
+package market;
+
+import market.security.AuthenticationService;
+import market.security.UserDetailsServiceImpl;
+import market.service.UserAccountService;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.ComponentScan;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.security.authentication.AuthenticationManager;
+import org.springframework.security.authentication.dao.DaoAuthenticationProvider;
+import org.springframework.security.config.BeanIds;
+import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder;
+import org.springframework.security.config.annotation.method.configuration.EnableGlobalMethodSecurity;
+import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
+import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
+import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
+import org.springframework.security.crypto.password.PasswordEncoder;
+
+@Configuration
+@EnableWebSecurity
+@ComponentScan(basePackages = {"market.security"})
+@EnableGlobalMethodSecurity(securedEnabled = true)
+public class SecurityConfigBase extends WebSecurityConfigurerAdapter {
+
+	@Autowired
+	private DaoAuthenticationProvider daoAuthenticationProvider;
+
+	@Bean
+	public AuthenticationService authenticationService(AuthenticationManager authenticationManager) {
+		return new AuthenticationService(authenticationManager);
+	}
+
+	@Bean(name = BeanIds.AUTHENTICATION_MANAGER)
+	@Override
+	public AuthenticationManager authenticationManagerBean() throws Exception {
+		return super.authenticationManagerBean();
+	}
+
+	protected void configure(AuthenticationManagerBuilder auth) {
+		auth.authenticationProvider(daoAuthenticationProvider);
+	}
+
+	@Bean
+	public DaoAuthenticationProvider daoAuthenticationProvider(
+		UserDetailsServiceImpl customUserDetailsService, PasswordEncoder passwordEncoder)
+	{
+		DaoAuthenticationProvider provider = new DaoAuthenticationProvider();
+		provider.setUserDetailsService(customUserDetailsService);
+		provider.setPasswordEncoder(passwordEncoder);
+		return provider;
+	}
+
+	@Bean
+	public UserDetailsServiceImpl customUserDetailsService(UserAccountService userAccountService) {
+		return new UserDetailsServiceImpl(userAccountService);
+	}
+
+	@Bean
+	public PasswordEncoder passwordEncoder() {
+		return new BCryptPasswordEncoder();
+	}
+}

aratrl-service/jdk11/market/market-core/src/main/java/market/dao/CartDAO.java

@@ -0,0 +1,9 @@
+package market.dao;
+
+import market.domain.Cart;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.data.repository.CrudRepository;
+
+public interface CartDAO extends CrudRepository<Cart, Long>, JpaRepository<Cart, Long> {
+
+}

aratrl-service/jdk11/market/market-core/src/main/java/market/dao/ContactsDAO.java

@@ -0,0 +1,11 @@
+package market.dao;
+
+import market.domain.Contacts;
+import market.domain.UserAccount;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.data.repository.CrudRepository;
+
+public interface ContactsDAO extends CrudRepository<Contacts, Long>, JpaRepository<Contacts, Long> {
+
+	Contacts findByUserAccount(UserAccount userAccount);
+}

aratrl-service/jdk11/market/market-core/src/main/java/market/dao/DistilleryDAO.java

@@ -0,0 +1,15 @@
+package market.dao;
+
+import market.domain.Distillery;
+import market.domain.Region;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.data.repository.CrudRepository;
+
+import java.util.List;
+
+public interface DistilleryDAO extends CrudRepository<Distillery, Long>, JpaRepository<Distillery, Long> {
+
+	List<Distillery> findByRegionOrderByTitleAsc(Region region);
+
+	Distillery findByTitle(String title);
+}

aratrl-service/jdk11/market/market-core/src/main/java/market/dao/OrderDAO.java

@@ -0,0 +1,22 @@
+package market.dao;
+
+import market.domain.Order;
+import market.domain.UserAccount;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.Pageable;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.data.repository.CrudRepository;
+
+import java.util.Date;
+import java.util.List;
+
+public interface OrderDAO extends CrudRepository<Order, Long>, JpaRepository<Order, Long> {
+
+	List<Order> findByUserAccountOrderByDateCreatedDesc(UserAccount userAccount);
+
+	Page<Order> findByExecuted(boolean stored, Pageable pageable);
+
+	Page<Order> findByDateCreatedGreaterThan(Date created, Pageable pageable);
+
+	Page<Order> findByExecutedAndDateCreatedGreaterThan(boolean executed, Date created, Pageable pageable);
+}

aratrl-service/jdk11/market/market-core/src/main/java/market/dao/OrderedProductDAO.java

@@ -0,0 +1,9 @@
+package market.dao;
+
+import market.domain.OrderedProduct;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.data.repository.CrudRepository;
+
+public interface OrderedProductDAO extends CrudRepository<OrderedProduct, Long>, JpaRepository<OrderedProduct, Long> {
+
+}

aratrl-service/jdk11/market/market-core/src/main/java/market/dao/ProductDAO.java

@@ -0,0 +1,21 @@
+package market.dao;
+
+import market.domain.Distillery;
+import market.domain.Product;
+import market.domain.Region;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.Pageable;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.data.jpa.repository.Query;
+import org.springframework.data.repository.CrudRepository;
+import org.springframework.data.repository.query.Param;
+
+public interface ProductDAO extends CrudRepository<Product, Long>, JpaRepository<Product, Long> {
+
+	Page<Product> findByDistilleryOrderByName(Distillery distillery, Pageable request);
+
+	@Query(value = "SELECT p FROM Product p WHERE p.distillery IN (SELECT d FROM Distillery d WHERE d.region = :region) order by p.name")
+	Page<Product> findByRegionOrderByName(@Param("region") Region region, Pageable request);
+
+	Page<Product> findByAvailableOrderByName(boolean available, Pageable request);
+}

aratrl-service/jdk11/market/market-core/src/main/java/market/dao/RegionDAO.java

@@ -0,0 +1,13 @@
+package market.dao;
+
+import market.domain.Region;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.data.repository.CrudRepository;
+
+import java.util.Optional;
+
+public interface RegionDAO extends CrudRepository<Region, Long>, JpaRepository<Region, Long> {
+
+	Optional<Region> findByName(String regionName);
+
+}

aratrl-service/jdk11/market/market-core/src/main/java/market/dao/UserAccountDAO.java

@@ -0,0 +1,10 @@
+package market.dao;
+
+import market.domain.UserAccount;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.data.repository.CrudRepository;
+
+public interface UserAccountDAO extends CrudRepository<UserAccount, Long>, JpaRepository<UserAccount, Long> {
+
+	UserAccount findByEmail(String email);
+}

aratrl-service/jdk11/market/market-core/src/main/java/market/domain/Bill.java

@@ -0,0 +1,166 @@
+package market.domain;
+
+import javax.persistence.Column;
+import javax.persistence.Entity;
+import javax.persistence.GeneratedValue;
+import javax.persistence.GenerationType;
+import javax.persistence.Id;
+import javax.persistence.OneToOne;
+import javax.persistence.PrimaryKeyJoinColumn;
+import javax.persistence.Table;
+import javax.persistence.Temporal;
+import javax.validation.constraints.NotEmpty;
+import javax.validation.constraints.Pattern;
+import java.io.Serializable;
+import java.util.Date;
+
+import static javax.persistence.TemporalType.TIMESTAMP;
+
+/**
+ * Bill of the {@link Order}.
+ */
+@Entity
+@Table(name = "bill")
+public class Bill implements Serializable {
+	private static final long serialVersionUID = 3689283961628876802L;
+
+	@Id
+	@Column(name = "id", unique = true, nullable = false)
+	@GeneratedValue(strategy = GenerationType.IDENTITY)
+	private Long id;
+
+	@OneToOne
+	@PrimaryKeyJoinColumn
+	private Order order;
+
+	@Column(name = "number", nullable = false)
+	private int number;
+
+	@Column(name = "total_cost", nullable = false)
+	private double totalCost;
+
+	@Column(name = "payed", nullable = false)
+	private boolean payed = false;
+
+	@Column(name = "cc_number", nullable = false)
+	@NotEmpty
+	@Pattern(regexp = "\\b(?:\\d[ -]*?){13,16}\\b")
+	private String ccNumber;
+
+	@Column(name = "date_created", nullable = false)
+	@Temporal(TIMESTAMP)
+	private Date dateCreated;
+
+	public Long getId() {
+		return id;
+	}
+
+	public void setId(Long id) {
+		this.id = id;
+	}
+
+	public String getCcNumber() {
+		return ccNumber;
+	}
+
+	public void setCcNumber(String ccNumber) {
+		this.ccNumber = ccNumber;
+	}
+
+	public Order getOrder() {
+		return order;
+	}
+
+	public void setOrder(Order order) {
+		this.order = order;
+	}
+
+	public int getNumber() {
+		return number;
+	}
+
+	public void setNumber(int number) {
+		this.number = number;
+	}
+
+	public Date getDateCreated() {
+		return dateCreated;
+	}
+
+	public void setDateCreated(Date dateCreated) {
+		this.dateCreated = dateCreated;
+	}
+
+	public double getTotalCost() {
+		return totalCost;
+	}
+
+	public void setTotalCost(double totalCost) {
+		this.totalCost = totalCost;
+	}
+
+	public boolean isPayed() {
+		return payed;
+	}
+
+	public void setPayed(boolean payed) {
+		this.payed = payed;
+	}
+
+	public static class Builder {
+		private Long id;
+		private Order order;
+		private int number;
+		private double totalCost;
+		private boolean payed = false;
+		private String ccNumber;
+		private Date dateCreated;
+
+		public Bill build() {
+			Bill bill = new Bill();
+			bill.id = id;
+			bill.order = order;
+			bill.number = number;
+			bill.totalCost = totalCost;
+			bill.payed = payed;
+			bill.ccNumber = ccNumber;
+			bill.dateCreated = dateCreated;
+			return bill;
+		}
+
+		public Builder setId(Long id) {
+			this.id = id;
+			return this;
+		}
+
+		public Builder setOrder(Order order) {
+			this.order = order;
+			return this;
+		}
+
+		public Builder setNumber(int number) {
+			this.number = number;
+			return this;
+		}
+
+		public Builder setTotalCost(double totalCost) {
+			this.totalCost = totalCost;
+			return this;
+		}
+
+		public Builder setPayed(boolean payed) {
+			this.payed = payed;
+			return this;
+		}
+
+		public Builder setCcNumber(String ccNumber) {
+			this.ccNumber = ccNumber;
+			return this;
+		}
+
+		public Builder setDateCreated(Date dateCreated) {
+			this.dateCreated = dateCreated;
+			return this;
+		}
+	}
+}

aratrl-service/jdk11/market/market-core/src/main/java/market/domain/Cart.java

@@ -0,0 +1,184 @@
+package market.domain;
+
+import org.hibernate.annotations.GenericGenerator;
+import org.hibernate.annotations.Parameter;
+
+import javax.persistence.*;
+import java.io.Serializable;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import java.util.Objects;
+
+/**
+ * Cart of the {@link UserAccount}.
+ */
+@Entity
+@Table(name = "cart")
+public class Cart implements Serializable {
+	private static final long serialVersionUID = -6884843696895527904L;
+
+	@Id
+	@Column(name = "id", unique = true, nullable = false)
+	@GeneratedValue(generator = "gen")
+	@GenericGenerator(name = "gen", strategy = "foreign", parameters = @Parameter(name = "property", value = "userAccount"))
+	private long id;
+
+	@OneToOne
+	@PrimaryKeyJoinColumn
+	private UserAccount userAccount;
+
+	@OneToMany(fetch = FetchType.EAGER, cascade = CascadeType.ALL, orphanRemoval = true,
+		targetEntity = CartItem.class, mappedBy = "cart")
+	private List<CartItem> cartItems = new ArrayList<>(0);
+
+	@Column(name = "delivery_included", nullable = false)
+	private boolean deliveryIncluded = true;
+
+	public Cart() {
+		this(null);
+	}
+
+	public Cart(UserAccount userAccount) {
+		this.userAccount = userAccount;
+	}
+
+	public boolean isEmpty() {
+		return cartItems.isEmpty();
+	}
+
+	public CartItem update(Product product, int newQuantity) {
+		if (product == null)
+			return null;
+
+		CartItem updatedItem = null;
+		if (newQuantity > 0) {
+			CartItem existingItem = findItem(product.getId());
+			if (existingItem == null) {
+				CartItem newItem = new CartItem(this, product, newQuantity);
+				cartItems.add(newItem);
+				updatedItem = newItem;
+			} else {
+				existingItem.setQuantity(newQuantity);
+				updatedItem = existingItem;
+			}
+		} else {
+			removeItem(product.getId());
+		}
+		return updatedItem;
+	}
+
+	private void removeItem(long productId) {
+		cartItems.removeIf(item -> item.getProduct().getId() == productId);
+	}
+
+	private CartItem findItem(long productId) {
+		for (CartItem existingItem : cartItems) {
+			if (existingItem.getProduct().getId() == productId)
+				return existingItem;
+		}
+		return null;
+	}
+
+	private double calculateItemsCost() {
+		return cartItems.stream()
+			.mapToDouble(CartItem::calculateCost)
+			.sum();
+	}
+
+	public void clear() {
+		cartItems.clear();
+	}
+
+	public long getId() {
+		return id;
+	}
+
+	public void setId(long id) {
+		this.id = id;
+	}
+
+	public UserAccount getUserAccount() {
+		return userAccount;
+	}
+
+	public void setUserAccount(UserAccount userAccount) {
+		this.userAccount = userAccount;
+	}
+
+	public List<CartItem> getCartItems() {
+		return Collections.unmodifiableList(cartItems);
+	}
+
+	public boolean isDeliveryIncluded() {
+		return deliveryIncluded;
+	}
+
+	public void setDeliveryIncluded(boolean deliveryIncluded) {
+		this.deliveryIncluded = deliveryIncluded;
+	}
+
+	public int getItemsCount() {
+		return cartItems.size();
+	}
+
+	public double getItemsCost() {
+		return calculateItemsCost();
+	}
+
+	@Override
+	public boolean equals(Object o) {
+		if (this == o) return true;
+		if (o == null || getClass() != o.getClass()) return false;
+		Cart cart = (Cart) o;
+		return deliveryIncluded == cart.deliveryIncluded &&
+			Objects.equals(id, cart.id) &&
+			Objects.equals(cartItems, cart.cartItems);
+	}
+
+	@Override
+	public int hashCode() {
+		return Objects.hash(id, cartItems, deliveryIncluded);
+	}
+
+	public static class Builder {
+		private long id;
+		private UserAccount userAccount;
+		private List<CartItem> cartItems = new ArrayList<>(0);
+		private boolean deliveryIncluded = true;
+
+		public Builder() {
+		}
+
+		public Builder(Cart cart) {
+			id = cart.id;
+			userAccount = cart.userAccount;
+			cartItems = cart.cartItems;
+			deliveryIncluded = cart.deliveryIncluded;
+		}
+
+		public Cart build() {
+			Cart cart = new Cart();
+			cart.id = id;
+			cart.userAccount = userAccount;
+			cart.cartItems = cartItems;
+			cart.deliveryIncluded = deliveryIncluded;
+			return cart;
+		}
+
+		public Builder setId(long id) {
+			this.id = id;
+			return this;
+		}
+
+		public Builder setUserAccount(UserAccount userAccount) {
+			this.userAccount = userAccount;
+			return this;
+		}
+
+		public Builder setDeliveryIncluded(boolean deliveryIncluded) {
+			this.deliveryIncluded = deliveryIncluded;
+			return this;
+		}
+	}
+}

aratrl-service/jdk11/market/market-core/src/main/java/market/domain/CartItem.java

@@ -0,0 +1,82 @@
+package market.domain;
+
+import javax.persistence.Column;
+import javax.persistence.EmbeddedId;
+import javax.persistence.Entity;
+import javax.persistence.FetchType;
+import javax.persistence.JoinColumn;
+import javax.persistence.ManyToOne;
+import javax.persistence.MapsId;
+import javax.persistence.Table;
+import java.io.Serializable;
+import java.util.Objects;
+
+@Entity
+@Table(name = "cart_item")
+public class CartItem implements Serializable {
+	private static final long serialVersionUID = -3995571478236070123L;
+
+	@EmbeddedId
+	private CartItemId pk = new CartItemId();
+
+	@MapsId("cartId")
+	@JoinColumn(name = "cart_id", referencedColumnName = "id")
+	@ManyToOne(optional = false, fetch = FetchType.LAZY)
+	private Cart cart;
+
+	@MapsId("productId")
+	@JoinColumn(name = "product_id", referencedColumnName = "id")
+	@ManyToOne(optional = false, fetch = FetchType.EAGER)
+	private Product product;
+
+	@Column(name = "quantity")
+	private int quantity;
+
+	public CartItem() {
+	}
+
+	public CartItem(Cart cart, Product product, int quantity) {
+		this.pk = new CartItemId(cart.getId(), product.getId());
+		this.cart = cart;
+		this.product = product;
+		this.quantity = quantity;
+	}
+
+	public double calculateCost() {
+		return quantity * product.getPrice();
+	}
+
+	public int getQuantity() {
+		return quantity;
+	}
+
+	public void setQuantity(int quantity) {
+		this.quantity = quantity;
+	}
+
+	public Product getProduct() {
+		return product;
+	}
+
+	public void setProduct(Product product) {
+		this.product = product;
+		pk.setProduct(product.getId());
+	}
+
+	@Override
+	public boolean equals(Object o) {
+		if (this == o) {
+			return true;
+		}
+		if (o == null || getClass() != o.getClass()) {
+			return false;
+		}
+		CartItem that = (CartItem) o;
+		return Objects.equals(pk, that.pk);
+	}
+
+	@Override
+	public int hashCode() {
+		return (pk != null ? pk.hashCode() : 0);
+	}
+}

aratrl-service/jdk11/market/market-core/src/main/java/market/domain/CartItemId.java

@@ -0,0 +1,54 @@
+package market.domain;
+
+import javax.persistence.Embeddable;
+import java.io.Serializable;
+import java.util.Objects;
+
+/**
+ * Primary key of the {@link CartItem}.
+ */
+@Embeddable
+public class CartItemId implements Serializable {
+	private static final long serialVersionUID = -1255025293895062037L;
+
+	private long cartId;
+	private long productId;
+
+	public CartItemId() {
+	}
+
+	public CartItemId(long cartId, long productId) {
+		this.cartId = cartId;
+		this.productId = productId;
+	}
+
+	public long getCart() {
+		return cartId;
+	}
+
+	public void setCart(long orderId) {
+		this.cartId = orderId;
+	}
+
+	public long getProduct() {
+		return productId;
+	}
+
+	public void setProduct(long productId) {
+		this.productId = productId;
+	}
+
+	@Override
+	public boolean equals(Object o) {
+		if (this == o) return true;
+		if (o == null || getClass() != o.getClass()) return false;
+		CartItemId that = (CartItemId) o;
+		return cartId == that.cartId &&
+			productId == that.productId;
+	}
+
+	@Override
+	public int hashCode() {
+		return Objects.hash(cartId, productId);
+	}
+}

aratrl-service/jdk11/market/market-core/src/main/java/market/domain/Contacts.java

@@ -0,0 +1,156 @@
+package market.domain;
+
+import org.hibernate.annotations.GenericGenerator;
+import org.hibernate.annotations.Parameter;
+
+import javax.persistence.*;
+import java.io.Serializable;
+import java.util.Objects;
+
+/**
+ * Contacts of the {@link UserAccount}.
+ */
+@Entity
+@Table(name = "contacts")
+public class Contacts implements Serializable {
+	private static final long serialVersionUID = 582080671801480110L;
+
+	@Id
+	@Column(name = "id", unique = true, nullable = false)
+	@GeneratedValue(generator = "gen")
+	@GenericGenerator(name = "gen", strategy = "foreign", parameters = @Parameter(name = "property", value = "userAccount"))
+	private Long id;
+
+	@OneToOne
+	@PrimaryKeyJoinColumn
+	private UserAccount userAccount; // todo: change to 'String userLogin'
+
+	@Column(name = "phone", nullable = false)
+	private String phone;
+
+	@Column(name = "address", nullable = false)
+	private String address;
+
+	@Column(name = "city_region", nullable = false)
+	private String cityAndRegion;
+
+	public Contacts() {
+	}
+
+	public Contacts(UserAccount userAccount, String phone, String address/*, String cityAndRegion*/) {
+		this.userAccount = userAccount;
+		this.phone = phone;
+		this.address = address;
+		this.cityAndRegion = "13";
+	}
+
+	public Long getId() {
+		return id;
+	}
+
+	public void setId(Long id) {
+		this.id = id;
+	}
+
+	public UserAccount getUserAccount() {
+		return userAccount;
+	}
+
+	public void setUserAccount(UserAccount userAccount) {
+		this.userAccount = userAccount;
+	}
+
+	public String getPhone() {
+		return phone;
+	}
+
+	public void setPhone(String phone) {
+		this.phone = phone;
+	}
+
+	public String getAddress() {
+		return address;
+	}
+
+	public void setAddress(String address) {
+		this.address = address;
+	}
+
+	public String getCityAndRegion() {
+		return cityAndRegion;
+	}
+
+	public void setCityAndRegion(String cityAndRegion) {
+		this.cityAndRegion = cityAndRegion;
+	}
+
+	@Override
+	public boolean equals(Object o) {
+		if (this == o) return true;
+		if (o == null || getClass() != o.getClass()) return false;
+		Contacts contacts = (Contacts) o;
+		return Objects.equals(id, contacts.id) &&
+			Objects.equals(phone, contacts.phone) &&
+			Objects.equals(address, contacts.address) &&
+			Objects.equals(cityAndRegion, contacts.cityAndRegion);
+	}
+
+	@Override
+	public int hashCode() {
+		return Objects.hash(id, phone, address, cityAndRegion);
+	}
+
+	public static class Builder {
+		private Long id;
+		private UserAccount userAccount;
+		private String phone;
+		private String address;
+		private String cityAndRegion;
+
+		public Builder() {
+		}
+
+		public Builder(Contacts contacts) {
+			id = contacts.id;
+			userAccount = contacts.userAccount;
+			phone = contacts.phone;
+			address = contacts.address;
+			cityAndRegion = contacts.cityAndRegion;
+		}
+
+		public Contacts build() {
+			Contacts contacts = new Contacts();
+			contacts.id = id;
+			contacts.userAccount = userAccount;
+			contacts.phone = phone;
+			contacts.address = address;
+			contacts.cityAndRegion = cityAndRegion;
+			return contacts;
+		}
+
+		public Builder setId(Long id) {
+			this.id = id;
+			return this;
+		}
+
+		public Builder setUserAccount(UserAccount userAccount) {
+			this.userAccount = userAccount;
+			return this;
+		}
+
+		public Builder setPhone(String phone) {
+			this.phone = phone;
+			return this;
+		}
+
+		public Builder setAddress(String address) {
+			this.address = address;
+			return this;
+		}
+
+		public Builder setCityAndRegion(String cityAndRegion) {
+			this.cityAndRegion = cityAndRegion;
+			return this;
+		}
+	}
+}

aratrl-service/jdk11/market/market-core/src/main/java/market/domain/Distillery.java

@@ -0,0 +1,132 @@
+package market.domain;
+
+import javax.persistence.Column;
+import javax.persistence.Entity;
+import javax.persistence.FetchType;
+import javax.persistence.GeneratedValue;
+import javax.persistence.GenerationType;
+import javax.persistence.Id;
+import javax.persistence.JoinColumn;
+import javax.persistence.ManyToOne;
+import javax.persistence.Table;
+import javax.validation.constraints.NotEmpty;
+import javax.validation.constraints.Pattern;
+import java.io.Serializable;
+import java.util.Objects;
+
+@Entity
+@Table(name = "distillery")
+public class Distillery implements Serializable {
+	private static final long serialVersionUID = -1491932412037172392L;
+
+	@Id
+	@GeneratedValue(strategy = GenerationType.IDENTITY)
+	@Column(name = "id", insertable = false, updatable = false, nullable = false)
+	private Long id;
+
+	@Column(name = "title", nullable = false)
+	@NotEmpty
+	@Pattern(regexp = "^[^#$%^*()']*$")
+	private String title;
+
+	@ManyToOne(fetch = FetchType.EAGER)
+	@JoinColumn(name = "region_id", nullable = false)
+	private Region region;
+
+	@Column(name = "description")
+	private String description;
+
+	public Long getId() {
+		return id;
+	}
+
+	public void setId(Long id) {
+		this.id = id;
+	}
+
+	public String getTitle() {
+		return title;
+	}
+
+	public void setTitle(String title) {
+		this.title = title;
+	}
+
+	public String getDescription() {
+		return description;
+	}
+
+	public void setDescription(String description) {
+		this.description = description;
+	}
+
+	public Region getRegion() {
+		return region;
+	}
+
+	public void setRegion(Region region) {
+		this.region = region;
+	}
+
+	@Override
+	public boolean equals(Object o) {
+		if (this == o) return true;
+		if (o == null || getClass() != o.getClass()) return false;
+		Distillery that = (Distillery) o;
+		return Objects.equals(id, that.id) &&
+			Objects.equals(title, that.title) &&
+			Objects.equals(region, that.region) &&
+			Objects.equals(description, that.description);
+	}
+
+	@Override
+	public int hashCode() {
+		return Objects.hash(id, title, region, description);
+	}
+
+	public static class Builder {
+		private Long id;
+		private String title;
+		private Region region;
+		private String description;
+
+		public Builder() {
+		}
+
+		public Builder(Distillery source) {
+			id = source.id;
+			title = source.title;
+			region = source.region;
+			description = source.description;
+		}
+
+		public Distillery build() {
+			Distillery distillery = new Distillery();
+			distillery.id = id;
+			distillery.title = title;
+			distillery.region = region;
+			distillery.description = description;
+			return distillery;
+		}
+
+		public Builder setId(Long id) {
+			this.id = id;
+			return this;
+		}
+
+		public Builder setTitle(String title) {
+			this.title = title;
+			return this;
+		}
+
+		public Builder setRegion(Region region) {
+			this.region = region;
+			return this;
+		}
+
+		public Builder setDescription(String description) {
+			this.description = description;
+			return this;
+		}
+	}
+}

aratrl-service/jdk11/market/market-core/src/main/java/market/domain/Order.java

@@ -0,0 +1,222 @@
+package market.domain;
+
+import org.hibernate.annotations.GenericGenerator;
+import org.hibernate.annotations.Parameter;
+
+import javax.persistence.*;
+import java.io.Serializable;
+import java.util.Date;
+import java.util.HashSet;
+import java.util.Objects;
+import java.util.Set;
+
+import static javax.persistence.TemporalType.TIMESTAMP;
+
+/**
+ * Order of the {@link UserAccount}.
+ */
+@Entity
+@Table(name = "customer_order")
+public class Order implements Serializable {
+	private static final long serialVersionUID = -8328584058042877489L;
+
+	@Id
+	@Column(name = "id", insertable = false, updatable = false, nullable = false)
+	@GeneratedValue(generator = "gen")
+	@GenericGenerator(name = "gen", strategy = "foreign", parameters = @Parameter(name = "property", value = "bill"))
+	private Long id;
+
+	@ManyToOne(fetch = FetchType.EAGER)
+	@JoinColumn(name = "user_account_id")
+	private UserAccount userAccount;
+
+	@OneToMany(cascade = CascadeType.ALL, fetch = FetchType.EAGER,
+		targetEntity = OrderedProduct.class, mappedBy = "order")
+//    @OneToMany(fetch = FetchType.LAZY, mappedBy ="pk.order", cascade =
+//            {CascadeType.PERSIST, CascadeType.MERGE})
+//    @Cascade({CascadeType.SAVE_UPDATE, CascadeType.DELETE_ORPHAN})
+	private Set<OrderedProduct> orderedProducts = new HashSet<>(0);
+
+	@OneToOne(mappedBy = "order", cascade = CascadeType.ALL, fetch = FetchType.EAGER)
+	private Bill bill;
+
+	@Column(name = "products_cost", nullable = false)
+	private double productsCost;
+
+	@Column(name = "date_created", nullable = false)
+	@Temporal(TIMESTAMP)
+	private Date dateCreated;
+
+	@Column(name = "delivery_cost")
+	private int deliveryCost;
+
+	@Column(name = "delivery_included", nullable = false)
+	private boolean deliveryIncluded;
+
+	@Column(name = "executed", nullable = false)
+	private boolean executed;
+
+	public Long getId() {
+		return id;
+	}
+
+	public void setId(Long id) {
+		this.id = id;
+	}
+
+	public double getProductsCost() {
+		return productsCost;
+	}
+
+	public void setProductsCost(double amount) {
+		this.productsCost = amount;
+	}
+
+	public Date getDateCreated() {
+		return dateCreated;
+	}
+
+	public void setDateCreated(Date name) {
+		this.dateCreated = name;
+	}
+
+	public UserAccount getUserAccount() {
+		return userAccount;
+	}
+
+	public void setUserAccount(UserAccount userAccount) {
+		this.userAccount = userAccount;
+	}
+
+	public Set<OrderedProduct> getOrderedProducts() {
+		return orderedProducts;
+	}
+
+	public void setOrderedProducts(Set<OrderedProduct> products) {
+		this.orderedProducts = products;
+	}
+
+	public int getDeliveryCost() {
+		return deliveryCost;
+	}
+
+	public void setDeliveryCost(int deliveryСost) {
+		this.deliveryCost = deliveryСost;
+	}
+
+	public boolean isDeliveryIncluded() {
+		return deliveryIncluded;
+	}
+
+	public void setDeliveryIncluded(boolean deliveryIncluded) {
+		this.deliveryIncluded = deliveryIncluded;
+	}
+
+	public Bill getBill() {
+		return bill;
+	}
+
+	public void setBill(Bill bill) {
+		this.bill = bill;
+	}
+
+	public boolean isExecuted() {
+		return executed;
+	}
+
+	public void setExecuted(boolean executed) {
+		this.executed = executed;
+	}
+
+	@Override
+	public boolean equals(Object o) {
+		if (this == o) return true;
+		if (o == null || getClass() != o.getClass()) return false;
+		Order order = (Order) o;
+		return Double.compare(order.productsCost, productsCost) == 0 &&
+			deliveryCost == order.deliveryCost &&
+			deliveryIncluded == order.deliveryIncluded &&
+			executed == order.executed &&
+			Objects.equals(id, order.id) &&
+			Objects.equals(userAccount, order.userAccount) &&
+			Objects.equals(orderedProducts, order.orderedProducts) &&
+			Objects.equals(bill, order.bill) &&
+			Objects.equals(dateCreated, order.dateCreated);
+	}
+
+	@Override
+	public int hashCode() {
+		return Objects.hash(id, userAccount, orderedProducts, bill, productsCost, dateCreated, deliveryCost, deliveryIncluded, executed);
+	}
+
+	public static class Builder {
+		private Long id;
+		private UserAccount userAccount;
+		private Set<OrderedProduct> orderedProducts = new HashSet<>();
+		private Bill bill;
+		private double productsCost;
+		private Date dateCreated;
+		private int deliveryCost;
+		private boolean deliveryIncluded;
+		private boolean executed;
+
+		public Order build() {
+			Order order = new Order();
+			order.id = id;
+			order.userAccount = userAccount;
+			order.orderedProducts = orderedProducts;
+			order.bill = bill;
+			order.productsCost = productsCost;
+			order.dateCreated = dateCreated;
+			order.deliveryCost = deliveryCost;
+			order.deliveryIncluded = deliveryIncluded;
+			order.executed = executed;
+			return order;
+		}
+
+		public Builder setId(Long id) {
+			this.id = id;
+			return this;
+		}
+
+		public Builder setUserAccount(UserAccount userAccount) {
+			this.userAccount = userAccount;
+			return this;
+		}
+
+		public Builder setOrderedProducts(Set<OrderedProduct> orderedProducts) {
+			this.orderedProducts = orderedProducts;
+			return this;
+		}
+
+		public Builder setBill(Bill bill) {
+			this.bill = bill;
+			return this;
+		}
+
+		public Builder setProductsCost(double productsCost) {
+			this.productsCost = productsCost;
+			return this;
+		}
+
+		public Builder setDateCreated(Date dateCreated) {
+			this.dateCreated = dateCreated;
+			return this;
+		}
+
+		public Builder setDeliveryCost(int deliveryCost) {
+			this.deliveryCost = deliveryCost;
+			return this;
+		}
+
+		public Builder setDeliveryIncluded(boolean deliveryIncluded) {
+			this.deliveryIncluded = deliveryIncluded;
+			return this;
+		}
+
+		public Builder setExecuted(boolean executed) {
+			this.executed = executed;
+			return this;
+		}
+	}
+}

aratrl-service/jdk11/market/market-core/src/main/java/market/domain/OrderedProduct.java

@@ -0,0 +1,108 @@
+package market.domain;
+
+import javax.persistence.*;
+import java.io.Serializable;
+import java.util.Objects;
+
+/**
+ * {@link Product} of the {@link Order}.
+ */
+@Entity
+@Table(name = "ordered_product")
+public class OrderedProduct implements Serializable {
+	private static final long serialVersionUID = -2055528467252485472L;
+
+	@EmbeddedId
+	private OrderedProductId pk = new OrderedProductId();
+
+	@MapsId("orderId")
+	@JoinColumn(name = "customer_order_id", referencedColumnName = "id")
+	@ManyToOne(optional = false, fetch = FetchType.LAZY)
+	private Order order;
+
+	@MapsId("productId")
+	@JoinColumn(name = "product_id", referencedColumnName = "id")
+	@ManyToOne(optional = false, fetch = FetchType.EAGER)
+	private Product product;
+
+	@Column(name = "quantity")
+	private int quantity;
+
+	public OrderedProductId getPk() {
+		return pk;
+	}
+
+	public void setPk(OrderedProductId pk) {
+		this.pk = pk;
+	}
+
+	public int getQuantity() {
+		return quantity;
+	}
+
+	public void setQuantity(int quantity) {
+		this.quantity = quantity;
+	}
+
+	public Order getOrder() {
+		return order;
+	}
+
+	public void setOrder(Order order) {
+		this.order = order;
+		getPk().setCustomerOrder(order.getId());
+	}
+
+	public Product getProduct() {
+		return product;
+	}
+
+	public void setProduct(Product product) {
+		this.product = product;
+		getPk().setProduct(product.getId());
+	}
+
+	@Override
+	public boolean equals(Object o) {
+		if (this == o) return true;
+		if (o == null || getClass() != o.getClass()) return false;
+		OrderedProduct that = (OrderedProduct) o;
+		return quantity == that.quantity &&
+			Objects.equals(order.getId(), that.order.getId()) &&
+			Objects.equals(product.getId(), that.product.getId());
+	}
+
+	@Override
+	public int hashCode() {
+		return Objects.hash(order.getId(), product.getId(), quantity);
+	}
+
+	public static class Builder {
+		private Order order;
+		private Product product;
+		private int quantity;
+
+		public OrderedProduct build() {
+			OrderedProduct orderedProduct = new OrderedProduct();
+			orderedProduct.setOrder(order);
+			orderedProduct.setProduct(product);
+			orderedProduct.setQuantity(quantity);
+			return orderedProduct;
+		}
+
+		public Builder setOrder(Order order) {
+			this.order = order;
+			return this;
+		}
+
+		public Builder setProduct(Product product) {
+			this.product = product;
+			return this;
+		}
+
+		public Builder setQuantity(int quantity) {
+			this.quantity = quantity;
+			return this;
+		}
+	}
+}

aratrl-service/jdk11/market/market-core/src/main/java/market/domain/OrderedProductId.java

@@ -0,0 +1,51 @@
+package market.domain;
+
+import javax.persistence.*;
+import java.io.*;
+import java.util.*;
+
+/**
+ * Primary key of a {@link Product} inside the {@link Order}.
+ */
+@Embeddable
+public class OrderedProductId implements Serializable {
+	private static final long serialVersionUID = 5368453186150127449L;
+
+	private Long orderId;
+	private Long productId;
+
+	public Long getCustomerOrder() {
+		return orderId;
+	}
+
+	public void setCustomerOrder(Long orderId) {
+		this.orderId = orderId;
+	}
+
+	public Long getProduct() {
+		return productId;
+	}
+
+	public void setProduct(Long productId) {
+		this.productId = productId;
+	}
+
+	@Override
+	public boolean equals(Object o) {
+		if (this == o) return true;
+		if (o == null || getClass() != o.getClass()) return false;
+
+		OrderedProductId that = (OrderedProductId) o;
+
+		if (!Objects.equals(orderId, that.orderId)) return false;
+		return Objects.equals(productId, that.productId);
+	}
+
+	@Override
+	public int hashCode() {
+		int result;
+		result = (orderId != null ? orderId.hashCode() : 0);
+		result = 31 * result + (productId != null ? productId.hashCode() : 0);
+		return result;
+	}
+}

aratrl-service/jdk11/market/market-core/src/main/java/market/domain/Product.java

@@ -0,0 +1,241 @@
+package market.domain;
+
+import javax.persistence.Column;
+import javax.persistence.Entity;
+import javax.persistence.FetchType;
+import javax.persistence.GeneratedValue;
+import javax.persistence.GenerationType;
+import javax.persistence.Id;
+import javax.persistence.JoinColumn;
+import javax.persistence.ManyToOne;
+import javax.persistence.Table;
+import javax.validation.constraints.Max;
+import javax.validation.constraints.Min;
+import javax.validation.constraints.NotEmpty;
+import javax.validation.constraints.NotNull;
+import javax.validation.constraints.Pattern;
+import java.io.Serializable;
+import java.util.Objects;
+
+@Entity
+@Table(name = "product")
+public class Product implements Serializable {
+	private static final long serialVersionUID = -5637368176838137416L;
+
+	@Id
+	@GeneratedValue(strategy = GenerationType.IDENTITY)
+	@Column(name = "id", insertable = false, updatable = false, nullable = false)
+	private Long id;
+
+	@ManyToOne(fetch = FetchType.EAGER)
+	@JoinColumn(name = "distillery_id", nullable = false)
+	private Distillery distillery;
+
+	@Column(name = "name", nullable = false)
+	@NotEmpty
+	@Pattern(regexp = "^[^#$%^&*()']*$")
+	private String name;
+
+	@Column(name = "price", nullable = false)
+	@NotNull
+	private Double price;
+
+	@Column(name = "description")
+	private String description;
+
+	@Column(name = "volume")
+	@NotNull
+	private Integer volume;
+
+	@Column(name = "alcohol")
+	@NotNull
+	@Min(value = 1)
+	@Max(value = 96)
+	private Float alcohol;
+
+	@Column(name = "age")
+	@Max(value = 2000)
+	private Integer age;
+
+	@Column(name = "available", nullable = false)
+	private boolean available = true;
+
+	public Long getId() {
+		return id;
+	}
+
+	public void setId(Long id) {
+		this.id = id;
+	}
+
+	public String getName() {
+		return name;
+	}
+
+	public void setName(String name) {
+		this.name = name;
+	}
+
+	public @NotNull Double getPrice() {
+		return price;
+	}
+
+	public void setPrice(@NotNull Double price) {
+		this.price = price;
+	}
+
+	public String getDescription() {
+		return description;
+	}
+
+	public void setDescription(String description) {
+		this.description = description;
+	}
+
+	public Integer getVolume() {
+		return volume;
+	}
+
+	public void setVolume(Integer volume) {
+		this.volume = volume;
+	}
+
+	public Float getAlcohol() {
+		return alcohol;
+	}
+
+	public void setAlcohol(Float alcohol) {
+		this.alcohol = alcohol;
+	}
+
+	public Integer getAge() {
+		return age;
+	}
+
+	public void setAge(Integer age) {
+		this.age = age;
+	}
+
+	public Distillery getDistillery() {
+		return distillery;
+	}
+
+	public void setDistillery(Distillery distillery) {
+		this.distillery = distillery;
+	}
+
+	public boolean isAvailable() {
+		return available;
+	}
+
+	public void setAvailable(boolean available) {
+		this.available = available;
+	}
+
+	@Override
+	public boolean equals(Object o) {
+		if (this == o) return true;
+		if (o == null || getClass() != o.getClass()) return false;
+		Product product = (Product) o;
+		return id == product.id &&
+			available == product.available &&
+			Objects.equals(distillery, product.distillery) &&
+			Objects.equals(name, product.name) &&
+			Objects.equals(price, product.price) &&
+			Objects.equals(description, product.description) &&
+			Objects.equals(volume, product.volume) &&
+			Objects.equals(alcohol, product.alcohol) &&
+			Objects.equals(age, product.age);
+	}
+
+	@Override
+	public int hashCode() {
+		return Objects.hash(id, distillery, name, price, description, volume, alcohol, age, available);
+	}
+
+	public static class Builder {
+		private Long id;
+		private Distillery distillery;
+		private String name;
+		private Double price;
+		private String description;
+		private Integer volume;
+		private Float alcohol;
+		private Integer age;
+		private boolean available = true;
+
+		public Builder() {
+		}
+
+		public Builder(Product product) {
+			id = product.id;
+			distillery = product.distillery;
+			name = product.name;
+			price = product.price;
+			description = product.description;
+			volume = product.volume;
+			alcohol = product.alcohol;
+			age = product.age;
+			available = product.available;
+		}
+
+		public Product build() {
+			Product product = new Product();
+			product.id = id;
+			product.distillery = distillery;
+			product.name = name;
+			product.price = price;
+			product.description = description;
+			product.volume = volume;
+			product.alcohol = alcohol;
+			product.age = age;
+			product.available = available;
+			return product;
+		}
+
+		public Builder setId(Long id) {
+			this.id = id;
+			return this;
+		}
+
+		public Builder setDistillery(Distillery distillery) {
+			this.distillery = distillery;
+			return this;
+		}
+
+		public Builder setName(String name) {
+			this.name = name;
+			return this;
+		}
+
+		public Builder setPrice(@NotNull Double price) {
+			this.price = price;
+			return this;
+		}
+
+		public Builder setDescription(String description) {
+			this.description = description;
+			return this;
+		}
+
+		public Builder setVolume(Integer volume) {
+			this.volume = volume;
+			return this;
+		}
+
+		public Builder setAlcohol(Float alcohol) {
+			this.alcohol = alcohol;
+			return this;
+		}
+
+		public Builder setAge(Integer age) {
+			this.age = age;
+			return this;
+		}
+
+		public Builder setAvailable(boolean available) {
+			this.available = available;
+			return this;
+		}
+	}
+}