fab-clientlib 0.17.0
FAB Client Lib
Requires Python: >=3.9
Keywords: OpenAPI, OpenAPI-Generator, FAB Client Lib

# fab-clientlib
Python client lib to access Flatland Association Benchmarks / AI4REALNET Campaign Hub Backend API, generated with openapi-generator

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.0.0
- Package version: v0.17.0
- Generator version: 7.15.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.9+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/flatland-association/flatland-benchmarks.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/flatland-association/flatland-benchmarks.git`)

Then import the package:
```python
import fab_clientlib
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import fab_clientlib
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import fab_clientlib
from fab_clientlib.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = fab_clientlib.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with fab_clientlib.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fab_clientlib.DefaultApi(api_client)
    benchmark_ids = ['benchmark_ids_example'] # List[str] | Comma-separated list of IDs.

    try:
        api_response = api_instance.definitions_benchmarks_benchmark_ids_get(benchmark_ids)
        print("The response of DefaultApi->definitions_benchmarks_benchmark_ids_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->definitions_benchmarks_benchmark_ids_get: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**definitions_benchmarks_benchmark_ids_get**](docs/DefaultApi.md#definitions_benchmarks_benchmark_ids_get) | **GET** /definitions/benchmarks/{benchmark_ids} | 
*DefaultApi* | [**definitions_benchmarks_get**](docs/DefaultApi.md#definitions_benchmarks_get) | **GET** /definitions/benchmarks/ | 
*DefaultApi* | [**definitions_fields_field_ids_get**](docs/DefaultApi.md#definitions_fields_field_ids_get) | **GET** /definitions/fields/{field_ids} | 
*DefaultApi* | [**definitions_scenarios_scenario_ids_get**](docs/DefaultApi.md#definitions_scenarios_scenario_ids_get) | **GET** /definitions/scenarios/{scenario_ids} | 
*DefaultApi* | [**definitions_suites_get**](docs/DefaultApi.md#definitions_suites_get) | **GET** /definitions/suites | 
*DefaultApi* | [**definitions_suites_suite_ids_get**](docs/DefaultApi.md#definitions_suites_suite_ids_get) | **GET** /definitions/suites/{suite_ids} | 
*DefaultApi* | [**definitions_tests_test_ids_get**](docs/DefaultApi.md#definitions_tests_test_ids_get) | **GET** /definitions/tests/{test_ids} | 
*DefaultApi* | [**health_live_get**](docs/DefaultApi.md#health_live_get) | **GET** /health/live | 
*DefaultApi* | [**info_get**](docs/DefaultApi.md#info_get) | **GET** /info | 
*DefaultApi* | [**results_benchmarks_benchmark_id_tests_test_ids_get**](docs/DefaultApi.md#results_benchmarks_benchmark_id_tests_test_ids_get) | **GET** /results/benchmarks/{benchmark_id}/tests/{test_ids} | 
*DefaultApi* | [**results_benchmarks_benchmark_ids_get**](docs/DefaultApi.md#results_benchmarks_benchmark_ids_get) | **GET** /results/benchmarks/{benchmark_ids} | 
*DefaultApi* | [**results_campaign_items_benchmark_ids_get**](docs/DefaultApi.md#results_campaign_items_benchmark_ids_get) | **GET** /results/campaign-items/{benchmark_ids} | 
*DefaultApi* | [**results_campaigns_suite_ids_get**](docs/DefaultApi.md#results_campaigns_suite_ids_get) | **GET** /results/campaigns/{suite_ids} | 
*DefaultApi* | [**results_submissions_submission_id_scenarios_scenario_ids_get**](docs/DefaultApi.md#results_submissions_submission_id_scenarios_scenario_ids_get) | **GET** /results/submissions/{submission_id}/scenarios/{scenario_ids} | 
*DefaultApi* | [**results_submissions_submission_id_tests_test_ids_get**](docs/DefaultApi.md#results_submissions_submission_id_tests_test_ids_get) | **GET** /results/submissions/{submission_id}/tests/{test_ids} | 
*DefaultApi* | [**results_submissions_submission_id_tests_test_ids_post**](docs/DefaultApi.md#results_submissions_submission_id_tests_test_ids_post) | **POST** /results/submissions/{submission_id}/tests/{test_ids} | 
*DefaultApi* | [**results_submissions_submission_ids_get**](docs/DefaultApi.md#results_submissions_submission_ids_get) | **GET** /results/submissions/{submission_ids} | 
*DefaultApi* | [**submissions_get**](docs/DefaultApi.md#submissions_get) | **GET** /submissions | 
*DefaultApi* | [**submissions_own_get**](docs/DefaultApi.md#submissions_own_get) | **GET** /submissions/own | 
*DefaultApi* | [**submissions_post**](docs/DefaultApi.md#submissions_post) | **POST** /submissions | 
*DefaultApi* | [**submissions_submission_ids_get**](docs/DefaultApi.md#submissions_submission_ids_get) | **GET** /submissions/{submission_ids} | 
*DefaultApi* | [**submissions_submission_ids_patch**](docs/DefaultApi.md#submissions_submission_ids_patch) | **PATCH** /submissions/{submission_ids} | 


## Documentation For Models

 - [ApiResponse](docs/ApiResponse.md)
 - [ApiResponseError](docs/ApiResponseError.md)
 - [DefinitionsBenchmarksGet200Response](docs/DefinitionsBenchmarksGet200Response.md)
 - [DefinitionsBenchmarksGet200ResponseAllOfBodyInner](docs/DefinitionsBenchmarksGet200ResponseAllOfBodyInner.md)
 - [DefinitionsFieldsFieldIdsGet200Response](docs/DefinitionsFieldsFieldIdsGet200Response.md)
 - [DefinitionsFieldsFieldIdsGet200ResponseAllOfBodyInner](docs/DefinitionsFieldsFieldIdsGet200ResponseAllOfBodyInner.md)
 - [DefinitionsScenariosScenarioIdsGet200Response](docs/DefinitionsScenariosScenarioIdsGet200Response.md)
 - [DefinitionsScenariosScenarioIdsGet200ResponseAllOfBodyInner](docs/DefinitionsScenariosScenarioIdsGet200ResponseAllOfBodyInner.md)
 - [DefinitionsSuitesGet200Response](docs/DefinitionsSuitesGet200Response.md)
 - [DefinitionsSuitesGet200ResponseAllOfBodyInner](docs/DefinitionsSuitesGet200ResponseAllOfBodyInner.md)
 - [DefinitionsTestsTestIdsGet200Response](docs/DefinitionsTestsTestIdsGet200Response.md)
 - [DefinitionsTestsTestIdsGet200ResponseAllOfBodyInner](docs/DefinitionsTestsTestIdsGet200ResponseAllOfBodyInner.md)
 - [HealthLiveGet200Response](docs/HealthLiveGet200Response.md)
 - [HealthLiveGet200ResponseAllOfBody](docs/HealthLiveGet200ResponseAllOfBody.md)
 - [HealthLiveGet200ResponseAllOfBodyChecksInner](docs/HealthLiveGet200ResponseAllOfBodyChecksInner.md)
 - [InfoGet200Response](docs/InfoGet200Response.md)
 - [InfoGet200ResponseAllOfBody](docs/InfoGet200ResponseAllOfBody.md)
 - [ResultsBenchmarksBenchmarkIdTestsTestIdsGet200Response](docs/ResultsBenchmarksBenchmarkIdTestsTestIdsGet200Response.md)
 - [ResultsBenchmarksBenchmarkIdTestsTestIdsGet200ResponseAllOfBodyInner](docs/ResultsBenchmarksBenchmarkIdTestsTestIdsGet200ResponseAllOfBodyInner.md)
 - [ResultsBenchmarksBenchmarkIdsGet200Response](docs/ResultsBenchmarksBenchmarkIdsGet200Response.md)
 - [ResultsBenchmarksBenchmarkIdsGet200ResponseAllOfBodyInner](docs/ResultsBenchmarksBenchmarkIdsGet200ResponseAllOfBodyInner.md)
 - [ResultsCampaignItemsBenchmarkIdsGet200Response](docs/ResultsCampaignItemsBenchmarkIdsGet200Response.md)
 - [ResultsCampaignItemsBenchmarkIdsGet200ResponseAllOfBodyInner](docs/ResultsCampaignItemsBenchmarkIdsGet200ResponseAllOfBodyInner.md)
 - [ResultsCampaignItemsBenchmarkIdsGet200ResponseAllOfBodyInnerItemsInner](docs/ResultsCampaignItemsBenchmarkIdsGet200ResponseAllOfBodyInnerItemsInner.md)
 - [ResultsCampaignsSuiteIdsGet200Response](docs/ResultsCampaignsSuiteIdsGet200Response.md)
 - [ResultsCampaignsSuiteIdsGet200ResponseAllOfBodyInner](docs/ResultsCampaignsSuiteIdsGet200ResponseAllOfBodyInner.md)
 - [ResultsCampaignsSuiteIdsGet200ResponseAllOfBodyInnerItemsInner](docs/ResultsCampaignsSuiteIdsGet200ResponseAllOfBodyInnerItemsInner.md)
 - [ResultsSubmissionsSubmissionIdScenariosScenarioIdsGet200Response](docs/ResultsSubmissionsSubmissionIdScenariosScenarioIdsGet200Response.md)
 - [ResultsSubmissionsSubmissionIdTestsTestIdsGet200Response](docs/ResultsSubmissionsSubmissionIdTestsTestIdsGet200Response.md)
 - [ResultsSubmissionsSubmissionIdTestsTestIdsPostRequest](docs/ResultsSubmissionsSubmissionIdTestsTestIdsPostRequest.md)
 - [ResultsSubmissionsSubmissionIdTestsTestIdsPostRequestDataInner](docs/ResultsSubmissionsSubmissionIdTestsTestIdsPostRequestDataInner.md)
 - [ResultsSubmissionsSubmissionIdsGet200Response](docs/ResultsSubmissionsSubmissionIdsGet200Response.md)
 - [ResultsSubmissionsSubmissionIdsGet200ResponseAllOfBodyInner](docs/ResultsSubmissionsSubmissionIdsGet200ResponseAllOfBodyInner.md)
 - [ResultsSubmissionsSubmissionIdsGet200ResponseAllOfBodyInnerTestScoringsInner](docs/ResultsSubmissionsSubmissionIdsGet200ResponseAllOfBodyInnerTestScoringsInner.md)
 - [ResultsSubmissionsSubmissionIdsGet200ResponseAllOfBodyInnerTestScoringsInnerScenarioScoringsInner](docs/ResultsSubmissionsSubmissionIdsGet200ResponseAllOfBodyInnerTestScoringsInnerScenarioScoringsInner.md)
 - [Scoring](docs/Scoring.md)
 - [SubmissionsGet200Response](docs/SubmissionsGet200Response.md)
 - [SubmissionsGet200ResponseAllOfBodyInner](docs/SubmissionsGet200ResponseAllOfBodyInner.md)
 - [SubmissionsPost200Response](docs/SubmissionsPost200Response.md)
 - [SubmissionsPost200ResponseAllOfBody](docs/SubmissionsPost200ResponseAllOfBody.md)
 - [SubmissionsPostRequest](docs/SubmissionsPostRequest.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="oauth2"></a>
### oauth2

- **Type**: OAuth
- **Flow**: accessCode
- **Authorization URL**: https://keycloak.flatland.cloud/realms/flatland/protocol/openid-connect/auth
- **Scopes**: N/A


## Author

contact@flatland-association.org