fab-clientlib 0.8.4

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 project:

• API version: 0.0.0
• Package version: v0.8.4
• Generator version: 7.14.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:

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:

import fab_clientlib

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import fab_clientlib

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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)

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

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
DefaultApi	health_live_get	GET /health/live
DefaultApi	results_benchmark_benchmark_id_get	GET /results/benchmark/{benchmark_id}
DefaultApi	results_campaign_item_benchmark_id_get	GET /results/campaign-item/{benchmark_id}
DefaultApi	results_campaign_item_benchmark_id_tests_test_id_get	GET /results/campaign-item/{benchmark_id}/tests/{test_id}
DefaultApi	results_submission_submission_id_get	GET /results/submission/{submission_id}
DefaultApi	results_submission_submission_id_tests_test_id_get	GET /results/submission/{submission_id}/tests/{test_id}
DefaultApi	results_submission_submission_id_tests_test_id_post	POST /results/submission/{submission_id}/tests/{test_id}
DefaultApi	results_submission_submission_id_tests_test_id_scenario_scenario_id_get	GET /results/submission/{submission_id}/tests/{test_id}/scenario/{scenario_id}
DefaultApi	submissions_get	GET /submissions
DefaultApi	submissions_post	POST /submissions
DefaultApi	submissions_uuid_get	GET /submissions/{uuid}
DefaultApi	tests_ids_get	GET /tests/{ids}

Documentation For Models

• ApiResponse
• ApiResponseError
• HealthLiveGet200Response
• HealthLiveGet200ResponseAllOfBody
• HealthLiveGet200ResponseAllOfBodyChecksInner
• ResultsBenchmarkBenchmarkIdGet200Response
• ResultsBenchmarkBenchmarkIdGet200ResponseAllOfBodyInner
• ResultsCampaignItemBenchmarkIdGet200Response
• ResultsCampaignItemBenchmarkIdGet200ResponseAllOfBodyInner
• ResultsCampaignItemBenchmarkIdGet200ResponseAllOfBodyInnerItemsInner
• ResultsSubmissionSubmissionIdGet200Response
• ResultsSubmissionSubmissionIdGet200ResponseAllOfBodyInner
• ResultsSubmissionSubmissionIdGet200ResponseAllOfBodyInnerTestScoringsInner
• ResultsSubmissionSubmissionIdGet200ResponseAllOfBodyInnerTestScoringsInnerScenarioScoringsInner
• ResultsSubmissionSubmissionIdTestsTestIdGet200Response
• ResultsSubmissionSubmissionIdTestsTestIdPostRequest
• ResultsSubmissionSubmissionIdTestsTestIdPostRequestDataInner
• ResultsSubmissionSubmissionIdTestsTestIdScenarioScenarioIdGet200Response
• SubmissionsGet200Response
• SubmissionsGet200ResponseAllOfBodyInner
• SubmissionsPost200Response
• SubmissionsPost200ResponseAllOfBody
• SubmissionsPostRequest
• TestsIdsGet200Response
• TestsIdsGet200ResponseAllOfBodyInner

Documentation For Authorization

Authentication schemes defined for the API:

oauth2

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

Author

[e-mail]