fab-clientlib 0.17.0

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

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)
    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	GET /definitions/benchmarks/{benchmark_ids}
DefaultApi	definitions_benchmarks_get	GET /definitions/benchmarks/
DefaultApi	definitions_fields_field_ids_get	GET /definitions/fields/{field_ids}
DefaultApi	definitions_scenarios_scenario_ids_get	GET /definitions/scenarios/{scenario_ids}
DefaultApi	definitions_suites_get	GET /definitions/suites
DefaultApi	definitions_suites_suite_ids_get	GET /definitions/suites/{suite_ids}
DefaultApi	definitions_tests_test_ids_get	GET /definitions/tests/{test_ids}
DefaultApi	health_live_get	GET /health/live
DefaultApi	info_get	GET /info
DefaultApi	results_benchmarks_benchmark_id_tests_test_ids_get	GET /results/benchmarks/{benchmark_id}/tests/{test_ids}
DefaultApi	results_benchmarks_benchmark_ids_get	GET /results/benchmarks/{benchmark_ids}
DefaultApi	results_campaign_items_benchmark_ids_get	GET /results/campaign-items/{benchmark_ids}
DefaultApi	results_campaigns_suite_ids_get	GET /results/campaigns/{suite_ids}
DefaultApi	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	GET /results/submissions/{submission_id}/tests/{test_ids}
DefaultApi	results_submissions_submission_id_tests_test_ids_post	POST /results/submissions/{submission_id}/tests/{test_ids}
DefaultApi	results_submissions_submission_ids_get	GET /results/submissions/{submission_ids}
DefaultApi	submissions_get	GET /submissions
DefaultApi	submissions_own_get	GET /submissions/own
DefaultApi	submissions_post	POST /submissions
DefaultApi	submissions_submission_ids_get	GET /submissions/{submission_ids}
DefaultApi	submissions_submission_ids_patch	PATCH /submissions/{submission_ids}

Documentation For Models

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

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]