From 38718ca633d874e732cf1b5d1fad683c7917b900 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hern=C3=A1n=20Vargas?= Date: Wed, 18 Nov 2020 01:57:54 -0300 Subject: [PATCH] update to 1.6.0 --- README.md | 35 +- docs/endpoints/CatalogIdentifier.md | 26 + docs/endpoints/CatalogIdentifierApi.md | 318 ++++ docs/endpoints/CausalDiagram.md | 2 +- docs/endpoints/CausalDiagramApi.md | 14 +- docs/endpoints/ConfigurationSetup.md | 40 +- docs/endpoints/ConfigurationSetupApi.md | 14 +- docs/endpoints/CoupledModel.md | 62 + docs/endpoints/CoupledModelApi.md | 318 ++++ docs/endpoints/DataTransformation.md | 38 +- docs/endpoints/DataTransformationApi.md | 73 +- docs/endpoints/DataTransformationSetup.md | 40 +- docs/endpoints/DataTransformationSetupApi.md | 14 +- docs/endpoints/DatasetSpecification.md | 1 + docs/endpoints/DatasetSpecificationApi.md | 14 +- docs/endpoints/DefaultApi.md | 2 +- docs/endpoints/EmpiricalModel.md | 10 +- docs/endpoints/EmpiricalModelApi.md | 14 +- docs/endpoints/Emulator.md | 10 +- docs/endpoints/EmulatorApi.md | 14 +- docs/endpoints/EquationApi.md | 14 +- docs/endpoints/FundingInformation.md | 2 +- docs/endpoints/FundingInformationApi.md | 14 +- docs/endpoints/GeoCoordinatesApi.md | 14 +- docs/endpoints/GeoShapeApi.md | 14 +- docs/endpoints/Grid.md | 1 + docs/endpoints/GridApi.md | 14 +- docs/endpoints/HybridModel.md | 10 +- docs/endpoints/HybridModelApi.md | 14 +- docs/endpoints/Image.md | 5 +- docs/endpoints/ImageApi.md | 14 +- docs/endpoints/InterventionApi.md | 14 +- docs/endpoints/Model.md | 10 +- docs/endpoints/ModelApi.md | 14 +- docs/endpoints/ModelCategory.md | 13 + docs/endpoints/ModelCategoryApi.md | 318 ++++ docs/endpoints/ModelConfiguration.md | 10 +- docs/endpoints/ModelConfigurationApi.md | 14 +- docs/endpoints/ModelConfigurationSetup.md | 12 +- docs/endpoints/ModelConfigurationSetupApi.md | 14 +- docs/endpoints/NumericalIndexApi.md | 14 +- docs/endpoints/OrganizationApi.md | 14 +- docs/endpoints/Parameter.md | 8 +- docs/endpoints/ParameterApi.md | 14 +- docs/endpoints/Person.md | 2 +- docs/endpoints/PersonApi.md | 14 +- docs/endpoints/PointBasedGrid.md | 1 + docs/endpoints/PointBasedGridApi.md | 14 +- docs/endpoints/ProcessApi.md | 14 +- docs/endpoints/Region.md | 2 +- docs/endpoints/RegionApi.md | 14 +- docs/endpoints/SampleCollection.md | 2 +- docs/endpoints/SampleCollectionApi.md | 14 +- docs/endpoints/SampleExecutionApi.md | 14 +- docs/endpoints/SampleResource.md | 2 +- docs/endpoints/SampleResourceApi.md | 14 +- docs/endpoints/Software.md | 34 +- docs/endpoints/SoftwareApi.md | 14 +- docs/endpoints/SoftwareConfiguration.md | 38 +- docs/endpoints/SoftwareConfigurationApi.md | 14 +- docs/endpoints/SoftwareImage.md | 34 +- docs/endpoints/SoftwareImageApi.md | 14 +- docs/endpoints/SoftwareVersion.md | 34 +- docs/endpoints/SoftwareVersionApi.md | 14 +- docs/endpoints/SourceCode.md | 2 +- docs/endpoints/SourceCodeApi.md | 14 +- docs/endpoints/SpatialResolutionApi.md | 14 +- docs/endpoints/SpatiallyDistributedGrid.md | 1 + docs/endpoints/SpatiallyDistributedGridApi.md | 14 +- docs/endpoints/StandardVariableApi.md | 14 +- docs/endpoints/TheoryGuidedModel.md | 10 +- docs/endpoints/TheoryGuidedModelApi.md | 14 +- docs/endpoints/TimeInterval.md | 2 +- docs/endpoints/TimeIntervalApi.md | 14 +- docs/endpoints/UnitApi.md | 14 +- docs/endpoints/VariableApi.md | 14 +- docs/endpoints/VariablePresentation.md | 6 +- docs/endpoints/VariablePresentationApi.md | 14 +- docs/endpoints/Visualization.md | 6 +- docs/endpoints/VisualizationApi.md | 14 +- generate-client-mac.sh | 37 + generate-client.sh | 6 + modelcatalog/__init__.py | 8 +- modelcatalog/api/__init__.py | 3 + modelcatalog/api/catalog_identifier_api.py | 621 +++++++ modelcatalog/api/causal_diagram_api.py | 2 +- modelcatalog/api/configuration_setup_api.py | 2 +- modelcatalog/api/coupled_model_api.py | 621 +++++++ modelcatalog/api/data_transformation_api.py | 118 +- .../api/data_transformation_setup_api.py | 2 +- modelcatalog/api/dataset_specification_api.py | 2 +- modelcatalog/api/default_api.py | 2 +- modelcatalog/api/empirical_model_api.py | 2 +- modelcatalog/api/emulator_api.py | 2 +- modelcatalog/api/equation_api.py | 2 +- modelcatalog/api/funding_information_api.py | 2 +- modelcatalog/api/geo_coordinates_api.py | 2 +- modelcatalog/api/geo_shape_api.py | 2 +- modelcatalog/api/grid_api.py | 2 +- modelcatalog/api/hybrid_model_api.py | 2 +- modelcatalog/api/image_api.py | 2 +- modelcatalog/api/intervention_api.py | 2 +- modelcatalog/api/model_api.py | 2 +- modelcatalog/api/model_category_api.py | 621 +++++++ modelcatalog/api/model_configuration_api.py | 2 +- .../api/model_configuration_setup_api.py | 2 +- modelcatalog/api/numerical_index_api.py | 2 +- modelcatalog/api/organization_api.py | 2 +- modelcatalog/api/parameter_api.py | 2 +- modelcatalog/api/person_api.py | 2 +- modelcatalog/api/point_based_grid_api.py | 2 +- modelcatalog/api/process_api.py | 2 +- modelcatalog/api/region_api.py | 2 +- modelcatalog/api/sample_collection_api.py | 2 +- modelcatalog/api/sample_execution_api.py | 2 +- modelcatalog/api/sample_resource_api.py | 2 +- modelcatalog/api/software_api.py | 2 +- .../api/software_configuration_api.py | 2 +- modelcatalog/api/software_image_api.py | 2 +- modelcatalog/api/software_version_api.py | 2 +- modelcatalog/api/source_code_api.py | 2 +- modelcatalog/api/spatial_resolution_api.py | 2 +- .../api/spatially_distributed_grid_api.py | 2 +- modelcatalog/api/standard_variable_api.py | 2 +- modelcatalog/api/theory_guided_model_api.py | 2 +- modelcatalog/api/time_interval_api.py | 2 +- modelcatalog/api/unit_api.py | 2 +- modelcatalog/api/variable_api.py | 2 +- modelcatalog/api/variable_presentation_api.py | 2 +- modelcatalog/api/visualization_api.py | 2 +- modelcatalog/api_client.py | 2 +- modelcatalog/configuration.py | 12 +- modelcatalog/exceptions.py | 2 +- modelcatalog/models/__init__.py | 5 +- modelcatalog/models/catalog_identifier.py | 546 ++++++ modelcatalog/models/causal_diagram.py | 2 +- modelcatalog/models/configuration_setup.py | 134 +- modelcatalog/models/coupled_model.py | 1518 +++++++++++++++++ modelcatalog/models/data_transformation.py | 78 +- .../models/data_transformation_setup.py | 134 +- modelcatalog/models/dataset_specification.py | 31 +- modelcatalog/models/empirical_model.py | 12 +- modelcatalog/models/emulator.py | 12 +- modelcatalog/models/equation.py | 2 +- modelcatalog/models/funding_information.py | 6 +- modelcatalog/models/geo_coordinates.py | 2 +- modelcatalog/models/geo_shape.py | 2 +- modelcatalog/models/grid.py | 31 +- modelcatalog/models/hybrid_model.py | 12 +- modelcatalog/models/image.py | 35 +- modelcatalog/models/intervention.py | 2 +- modelcatalog/models/model.py | 12 +- modelcatalog/models/model_category.py | 195 +++ modelcatalog/models/model_configuration.py | 12 +- .../models/model_configuration_setup.py | 68 +- modelcatalog/models/numerical_index.py | 2 +- modelcatalog/models/organization.py | 2 +- modelcatalog/models/parameter.py | 2 +- modelcatalog/models/person.py | 6 +- modelcatalog/models/point_based_grid.py | 31 +- modelcatalog/models/process.py | 2 +- modelcatalog/models/region.py | 2 +- modelcatalog/models/sample_collection.py | 2 +- modelcatalog/models/sample_execution.py | 2 +- modelcatalog/models/sample_resource.py | 2 +- modelcatalog/models/software.py | 122 +- modelcatalog/models/software_configuration.py | 78 +- modelcatalog/models/software_image.py | 70 +- modelcatalog/models/software_version.py | 70 +- modelcatalog/models/source_code.py | 6 +- modelcatalog/models/spatial_resolution.py | 2 +- .../models/spatially_distributed_grid.py | 31 +- modelcatalog/models/standard_variable.py | 2 +- modelcatalog/models/theory_guided_model.py | 12 +- modelcatalog/models/time_interval.py | 2 +- modelcatalog/models/unit.py | 2 +- modelcatalog/models/user.py | 2 +- modelcatalog/models/variable.py | 2 +- modelcatalog/models/variable_presentation.py | 2 +- modelcatalog/models/visualization.py | 10 +- modelcatalog/rest.py | 2 +- setup.py | 2 +- test/test_catalog_identifier.py | 39 + test/test_catalog_identifier_api.py | 68 + test/test_coupled_model.py | 39 + test/test_coupled_model_api.py | 68 + test/test_model_category.py | 39 + test/test_model_category_api.py | 68 + 188 files changed, 6797 insertions(+), 1094 deletions(-) create mode 100644 docs/endpoints/CatalogIdentifier.md create mode 100644 docs/endpoints/CatalogIdentifierApi.md create mode 100644 docs/endpoints/CoupledModel.md create mode 100644 docs/endpoints/CoupledModelApi.md create mode 100644 docs/endpoints/ModelCategory.md create mode 100644 docs/endpoints/ModelCategoryApi.md create mode 100644 generate-client-mac.sh create mode 100644 modelcatalog/api/catalog_identifier_api.py create mode 100644 modelcatalog/api/coupled_model_api.py create mode 100644 modelcatalog/api/model_category_api.py create mode 100644 modelcatalog/models/catalog_identifier.py create mode 100644 modelcatalog/models/coupled_model.py create mode 100644 modelcatalog/models/model_category.py create mode 100644 test/test_catalog_identifier.py create mode 100644 test/test_catalog_identifier_api.py create mode 100644 test/test_coupled_model.py create mode 100644 test/test_coupled_model_api.py create mode 100644 test/test_model_category.py create mode 100644 test/test_model_category_api.py diff --git a/README.md b/README.md index 02e8268..7b69766 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/ This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: -- API version: v1.5.0 +- API version: v1.6.0 - Package version: 5.0.0 - Build package: org.openapitools.codegen.languages.PythonClientCodegen @@ -52,30 +52,35 @@ from modelcatalog.rest import ApiException from pprint import pprint -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class -api_instance = modelcatalog.CausalDiagramApi(modelcatalog.ApiClient(configuration)) +api_instance = modelcatalog.CatalogIdentifierApi(modelcatalog.ApiClient(configuration)) username = 'username_example' # str | Name of the user graph to query (optional) label = 'label_example' # str | Filter by label (optional) page = 1 # int | Page number (optional) (default to 1) per_page = 100 # int | Items per page (optional) (default to 100) try: - # List all instances of CausalDiagram - api_response = api_instance.causaldiagrams_get(username=username, label=label, page=page, per_page=per_page) + # List all instances of CatalogIdentifier + api_response = api_instance.catalogidentifiers_get(username=username, label=label, page=page, per_page=per_page) pprint(api_response) except ApiException as e: - print("Exception when calling CausalDiagramApi->causaldiagrams_get: %s\n" % e) + print("Exception when calling CatalogIdentifierApi->catalogidentifiers_get: %s\n" % e) ``` ## Documentation for API Endpoints -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- +*CatalogIdentifierApi* | [**catalogidentifiers_get**](docs/endpoints/CatalogIdentifierApi.md#catalogidentifiers_get) | **GET** /catalogidentifiers | List all instances of CatalogIdentifier +*CatalogIdentifierApi* | [**catalogidentifiers_id_delete**](docs/endpoints/CatalogIdentifierApi.md#catalogidentifiers_id_delete) | **DELETE** /catalogidentifiers/{id} | Delete an existing CatalogIdentifier +*CatalogIdentifierApi* | [**catalogidentifiers_id_get**](docs/endpoints/CatalogIdentifierApi.md#catalogidentifiers_id_get) | **GET** /catalogidentifiers/{id} | Get a single CatalogIdentifier by its id +*CatalogIdentifierApi* | [**catalogidentifiers_id_put**](docs/endpoints/CatalogIdentifierApi.md#catalogidentifiers_id_put) | **PUT** /catalogidentifiers/{id} | Update an existing CatalogIdentifier +*CatalogIdentifierApi* | [**catalogidentifiers_post**](docs/endpoints/CatalogIdentifierApi.md#catalogidentifiers_post) | **POST** /catalogidentifiers | Create one CatalogIdentifier *CausalDiagramApi* | [**causaldiagrams_get**](docs/endpoints/CausalDiagramApi.md#causaldiagrams_get) | **GET** /causaldiagrams | List all instances of CausalDiagram *CausalDiagramApi* | [**causaldiagrams_id_delete**](docs/endpoints/CausalDiagramApi.md#causaldiagrams_id_delete) | **DELETE** /causaldiagrams/{id} | Delete an existing CausalDiagram *CausalDiagramApi* | [**causaldiagrams_id_get**](docs/endpoints/CausalDiagramApi.md#causaldiagrams_id_get) | **GET** /causaldiagrams/{id} | Get a single CausalDiagram by its id @@ -87,7 +92,11 @@ Class | Method | HTTP request | Description *ConfigurationSetupApi* | [**configurationsetups_id_put**](docs/endpoints/ConfigurationSetupApi.md#configurationsetups_id_put) | **PUT** /configurationsetups/{id} | Update an existing ConfigurationSetup *ConfigurationSetupApi* | [**configurationsetups_post**](docs/endpoints/ConfigurationSetupApi.md#configurationsetups_post) | **POST** /configurationsetups | Create one ConfigurationSetup *ConfigurationSetupApi* | [**custom_configurationsetups_id_get**](docs/endpoints/ConfigurationSetupApi.md#custom_configurationsetups_id_get) | **GET** /custom/configurationsetups/{id} | Get a ModelConfigurationSetup -*DataTransformationApi* | [**custom_dataspecifications_id_datatransformations_get**](docs/endpoints/DataTransformationApi.md#custom_dataspecifications_id_datatransformations_get) | **GET** /custom/dataspecifications/{id}/datatransformations | Gets a list of data transformations related a dataset +*CoupledModelApi* | [**coupledmodels_get**](docs/endpoints/CoupledModelApi.md#coupledmodels_get) | **GET** /coupledmodels | List all instances of CoupledModel +*CoupledModelApi* | [**coupledmodels_id_delete**](docs/endpoints/CoupledModelApi.md#coupledmodels_id_delete) | **DELETE** /coupledmodels/{id} | Delete an existing CoupledModel +*CoupledModelApi* | [**coupledmodels_id_get**](docs/endpoints/CoupledModelApi.md#coupledmodels_id_get) | **GET** /coupledmodels/{id} | Get a single CoupledModel by its id +*CoupledModelApi* | [**coupledmodels_id_put**](docs/endpoints/CoupledModelApi.md#coupledmodels_id_put) | **PUT** /coupledmodels/{id} | Update an existing CoupledModel +*CoupledModelApi* | [**coupledmodels_post**](docs/endpoints/CoupledModelApi.md#coupledmodels_post) | **POST** /coupledmodels | Create one CoupledModel *DataTransformationApi* | [**datatransformations_get**](docs/endpoints/DataTransformationApi.md#datatransformations_get) | **GET** /datatransformations | List all instances of DataTransformation *DataTransformationApi* | [**datatransformations_id_delete**](docs/endpoints/DataTransformationApi.md#datatransformations_id_delete) | **DELETE** /datatransformations/{id} | Delete an existing DataTransformation *DataTransformationApi* | [**datatransformations_id_get**](docs/endpoints/DataTransformationApi.md#datatransformations_id_get) | **GET** /datatransformations/{id} | Get a single DataTransformation by its id @@ -163,6 +172,11 @@ Class | Method | HTTP request | Description *ModelApi* | [**models_id_get**](docs/endpoints/ModelApi.md#models_id_get) | **GET** /models/{id} | Get a single Model by its id *ModelApi* | [**models_id_put**](docs/endpoints/ModelApi.md#models_id_put) | **PUT** /models/{id} | Update an existing Model *ModelApi* | [**models_post**](docs/endpoints/ModelApi.md#models_post) | **POST** /models | Create one Model +*ModelCategoryApi* | [**modelcategorys_get**](docs/endpoints/ModelCategoryApi.md#modelcategorys_get) | **GET** /modelcategorys | List all instances of ModelCategory +*ModelCategoryApi* | [**modelcategorys_id_delete**](docs/endpoints/ModelCategoryApi.md#modelcategorys_id_delete) | **DELETE** /modelcategorys/{id} | Delete an existing ModelCategory +*ModelCategoryApi* | [**modelcategorys_id_get**](docs/endpoints/ModelCategoryApi.md#modelcategorys_id_get) | **GET** /modelcategorys/{id} | Get a single ModelCategory by its id +*ModelCategoryApi* | [**modelcategorys_id_put**](docs/endpoints/ModelCategoryApi.md#modelcategorys_id_put) | **PUT** /modelcategorys/{id} | Update an existing ModelCategory +*ModelCategoryApi* | [**modelcategorys_post**](docs/endpoints/ModelCategoryApi.md#modelcategorys_post) | **POST** /modelcategorys | Create one ModelCategory *ModelConfigurationApi* | [**custom_modelconfigurations_id_get**](docs/endpoints/ModelConfigurationApi.md#custom_modelconfigurations_id_get) | **GET** /custom/modelconfigurations/{id} | Get a ModelConfiguration *ModelConfigurationApi* | [**modelconfigurations_get**](docs/endpoints/ModelConfigurationApi.md#modelconfigurations_get) | **GET** /modelconfigurations | List all instances of ModelConfiguration *ModelConfigurationApi* | [**modelconfigurations_id_delete**](docs/endpoints/ModelConfigurationApi.md#modelconfigurations_id_delete) | **DELETE** /modelconfigurations/{id} | Delete an existing ModelConfiguration @@ -301,8 +315,10 @@ Class | Method | HTTP request | Description ## Documentation For Models + - [CatalogIdentifier](docs/endpoints/CatalogIdentifier.md) - [CausalDiagram](docs/endpoints/CausalDiagram.md) - [ConfigurationSetup](docs/endpoints/ConfigurationSetup.md) + - [CoupledModel](docs/endpoints/CoupledModel.md) - [DataTransformation](docs/endpoints/DataTransformation.md) - [DataTransformationSetup](docs/endpoints/DataTransformationSetup.md) - [DatasetSpecification](docs/endpoints/DatasetSpecification.md) @@ -317,6 +333,7 @@ Class | Method | HTTP request | Description - [Image](docs/endpoints/Image.md) - [Intervention](docs/endpoints/Intervention.md) - [Model](docs/endpoints/Model.md) + - [ModelCategory](docs/endpoints/ModelCategory.md) - [ModelConfiguration](docs/endpoints/ModelConfiguration.md) - [ModelConfigurationSetup](docs/endpoints/ModelConfigurationSetup.md) - [NumericalIndex](docs/endpoints/NumericalIndex.md) diff --git a/docs/endpoints/CatalogIdentifier.md b/docs/endpoints/CatalogIdentifier.md new file mode 100644 index 0000000..ca5fb8d --- /dev/null +++ b/docs/endpoints/CatalogIdentifier.md @@ -0,0 +1,26 @@ +# CatalogIdentifier + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**has_default_value** | [**list[AnyOfURIbooleanDateTimefloatintegerstring]**](AnyOfURIbooleanDateTimefloatintegerstring.md) | Default accepted value of a variable presentation (or a parameter) | [optional] +**has_maximum_accepted_value** | [**list[AnyOfDateTimefloatinteger]**](AnyOfDateTimefloatinteger.md) | Maximum accepted value of a variable presentation (or a parameter) | [optional] +**description** | **list[str]** | small description | [optional] +**has_data_type** | **list[str]** | Property that indicates the data type of a parameter | [optional] +**has_fixed_value** | [**list[AnyOfURIbooleanDateTimefloatintegerstring]**](AnyOfURIbooleanDateTimefloatintegerstring.md) | Value of a parameter in a software setup. | [optional] +**has_presentation** | [**list[VariablePresentation]**](VariablePresentation.md) | Property that links an instance of a dataset (or a dataset specification) to the presentation of a variable contained (or expected to be contained) on it. | [optional] +**label** | **list[str]** | short description of the resource | [optional] +**recommended_increment** | **list[float]** | Value that represents how a parameter should be incremented on each iteration of a software component execution. This value is important when preparing execution ensembles automatically, e.g., simulating crop production varying the parameter \"fertilizer amount\" in increments of 10%. | [optional] +**type** | **list[str]** | type of the resource | [optional] +**has_minimum_accepted_value** | [**list[AnyOfDateTimefloatinteger]**](AnyOfDateTimefloatinteger.md) | Minimum accepted value of a variable presentation (or a parameter) | [optional] +**has_accepted_values** | **list[str]** | Property that constraints which values are accepted for a parameter. For example, the name of a crop can only be \"Maize\" or \"Sorghum\" | [optional] +**adjusts_variable** | [**list[Variable]**](Variable.md) | Property that links parameter with the variable they adjust. This property can be used when parameters quantify variables without directly representing them. For example, a \"fertilizer percentage adjustment\" parameter can quantify a \"fertilizer price\" variable | [optional] +**relevant_for_intervention** | [**list[Intervention]**](Intervention.md) | Description not available | [optional] +**position** | **list[int]** | Position of the parameter or input/output in the model configuration. This property is needed to know how to organize the I/O of the component on execution | [optional] +**id** | **str** | identifier | [optional] +**uses_unit** | [**list[Unit]**](Unit.md) | Property used to link a variable presentation or time interval to the unit they are represented in | [optional] +**has_step_size** | **list[float]** | Property that determines what are the increments (step size) that are commonly used to vary a parameter. This is commonly used for automatically setting up software tests. For example, if I want to set up a model and try 30 reasonable values on a parameter, I may use the default value and the step size to create the appropriate increments. If the step size is 0.1 and the default value is 0, then I will will be able to create setups: 0, 0.1, 0.2...2.9,3 | [optional] + +[[Back to Model list]](../#documentation-for-models) [[Back to API list]](../#documentation-for-api-endpoints) [[Back to README]](../) + + diff --git a/docs/endpoints/CatalogIdentifierApi.md b/docs/endpoints/CatalogIdentifierApi.md new file mode 100644 index 0000000..bbc8621 --- /dev/null +++ b/docs/endpoints/CatalogIdentifierApi.md @@ -0,0 +1,318 @@ +# modelcatalog.CatalogIdentifierApi + +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**catalogidentifiers_get**](CatalogIdentifierApi.md#catalogidentifiers_get) | **GET** /catalogidentifiers | List all instances of CatalogIdentifier +[**catalogidentifiers_id_delete**](CatalogIdentifierApi.md#catalogidentifiers_id_delete) | **DELETE** /catalogidentifiers/{id} | Delete an existing CatalogIdentifier +[**catalogidentifiers_id_get**](CatalogIdentifierApi.md#catalogidentifiers_id_get) | **GET** /catalogidentifiers/{id} | Get a single CatalogIdentifier by its id +[**catalogidentifiers_id_put**](CatalogIdentifierApi.md#catalogidentifiers_id_put) | **PUT** /catalogidentifiers/{id} | Update an existing CatalogIdentifier +[**catalogidentifiers_post**](CatalogIdentifierApi.md#catalogidentifiers_post) | **POST** /catalogidentifiers | Create one CatalogIdentifier + + +# **catalogidentifiers_get** +> list[CatalogIdentifier] catalogidentifiers_get(username=username, label=label, page=page, per_page=per_page) + +List all instances of CatalogIdentifier + +Gets a list of all instances of CatalogIdentifier (more information in https://w3id.org/okn/o/sd#CatalogIdentifier) + +### Example + +```python +from __future__ import print_function +import time +import modelcatalog +from modelcatalog.rest import ApiException +from pprint import pprint + +# Create an instance of the API class +api_instance = modelcatalog.CatalogIdentifierApi() +username = 'username_example' # str | Name of the user graph to query (optional) +label = 'label_example' # str | Filter by label (optional) +page = 1 # int | Page number (optional) (default to 1) +per_page = 100 # int | Items per page (optional) (default to 100) + +try: + # List all instances of CatalogIdentifier + api_response = api_instance.catalogidentifiers_get(username=username, label=label, page=page, per_page=per_page) + pprint(api_response) +except ApiException as e: + print("Exception when calling CatalogIdentifierApi->catalogidentifiers_get: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **username** | **str**| Name of the user graph to query | [optional] + **label** | **str**| Filter by label | [optional] + **page** | **int**| Page number | [optional] [default to 1] + **per_page** | **int**| Items per page | [optional] [default to 100] + +### Return type + +[**list[CatalogIdentifier]**](CatalogIdentifier.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successful response - returns an array with the instances of CatalogIdentifier. | - | + +[[Back to top]](#) [[Back to API list]](../#documentation-for-api-endpoints) [[Back to Model list]](../#documentation-for-models) [[Back to README]](../) + +# **catalogidentifiers_id_delete** +> catalogidentifiers_id_delete(id, user) + +Delete an existing CatalogIdentifier + +Delete an existing CatalogIdentifier (more information in https://w3id.org/okn/o/sd#CatalogIdentifier) + +### Example + +* Bearer (JWT) Authentication (BearerAuth): +```python +from __future__ import print_function +import time +import modelcatalog +from modelcatalog.rest import ApiException +from pprint import pprint +configuration = modelcatalog.Configuration() +# Configure Bearer authorization (JWT): BearerAuth +configuration.access_token = 'YOUR_BEARER_TOKEN' + +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" +# Create an instance of the API class +api_instance = modelcatalog.CatalogIdentifierApi(modelcatalog.ApiClient(configuration)) +id = 'id_example' # str | The ID of the CatalogIdentifier to be retrieved +user = 'user_example' # str | Username + +try: + # Delete an existing CatalogIdentifier + api_instance.catalogidentifiers_id_delete(id, user) +except ApiException as e: + print("Exception when calling CatalogIdentifierApi->catalogidentifiers_id_delete: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| The ID of the CatalogIdentifier to be retrieved | + **user** | **str**| Username | + +### Return type + +void (empty response body) + +### Authorization + +[BearerAuth](../#BearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**202** | Deleted | - | +**404** | Not Found | - | + +[[Back to top]](#) [[Back to API list]](../#documentation-for-api-endpoints) [[Back to Model list]](../#documentation-for-models) [[Back to README]](../) + +# **catalogidentifiers_id_get** +> CatalogIdentifier catalogidentifiers_id_get(id, username=username) + +Get a single CatalogIdentifier by its id + +Gets the details of a given CatalogIdentifier (more information in https://w3id.org/okn/o/sd#CatalogIdentifier) + +### Example + +```python +from __future__ import print_function +import time +import modelcatalog +from modelcatalog.rest import ApiException +from pprint import pprint + +# Create an instance of the API class +api_instance = modelcatalog.CatalogIdentifierApi() +id = 'id_example' # str | The ID of the CatalogIdentifier to be retrieved +username = 'username_example' # str | Name of the user graph to query (optional) + +try: + # Get a single CatalogIdentifier by its id + api_response = api_instance.catalogidentifiers_id_get(id, username=username) + pprint(api_response) +except ApiException as e: + print("Exception when calling CatalogIdentifierApi->catalogidentifiers_id_get: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| The ID of the CatalogIdentifier to be retrieved | + **username** | **str**| Name of the user graph to query | [optional] + +### Return type + +[**CatalogIdentifier**](CatalogIdentifier.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Gets the details of a given CatalogIdentifier | - | + +[[Back to top]](#) [[Back to API list]](../#documentation-for-api-endpoints) [[Back to Model list]](../#documentation-for-models) [[Back to README]](../) + +# **catalogidentifiers_id_put** +> CatalogIdentifier catalogidentifiers_id_put(id, user, catalog_identifier=catalog_identifier) + +Update an existing CatalogIdentifier + +Updates an existing CatalogIdentifier (more information in https://w3id.org/okn/o/sd#CatalogIdentifier) + +### Example + +* Bearer (JWT) Authentication (BearerAuth): +```python +from __future__ import print_function +import time +import modelcatalog +from modelcatalog.rest import ApiException +from pprint import pprint +configuration = modelcatalog.Configuration() +# Configure Bearer authorization (JWT): BearerAuth +configuration.access_token = 'YOUR_BEARER_TOKEN' + +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" +# Create an instance of the API class +api_instance = modelcatalog.CatalogIdentifierApi(modelcatalog.ApiClient(configuration)) +id = 'id_example' # str | The ID of the CatalogIdentifier to be retrieved +user = 'user_example' # str | Username +catalog_identifier = modelcatalog.CatalogIdentifier() # CatalogIdentifier | An old CatalogIdentifierto be updated (optional) + +try: + # Update an existing CatalogIdentifier + api_response = api_instance.catalogidentifiers_id_put(id, user, catalog_identifier=catalog_identifier) + pprint(api_response) +except ApiException as e: + print("Exception when calling CatalogIdentifierApi->catalogidentifiers_id_put: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| The ID of the CatalogIdentifier to be retrieved | + **user** | **str**| Username | + **catalog_identifier** | [**CatalogIdentifier**](CatalogIdentifier.md)| An old CatalogIdentifierto be updated | [optional] + +### Return type + +[**CatalogIdentifier**](CatalogIdentifier.md) + +### Authorization + +[BearerAuth](../#BearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Updated | - | +**404** | Not Found | - | + +[[Back to top]](#) [[Back to API list]](../#documentation-for-api-endpoints) [[Back to Model list]](../#documentation-for-models) [[Back to README]](../) + +# **catalogidentifiers_post** +> CatalogIdentifier catalogidentifiers_post(user, catalog_identifier=catalog_identifier) + +Create one CatalogIdentifier + +Create a new instance of CatalogIdentifier (more information in https://w3id.org/okn/o/sd#CatalogIdentifier) + +### Example + +* Bearer (JWT) Authentication (BearerAuth): +```python +from __future__ import print_function +import time +import modelcatalog +from modelcatalog.rest import ApiException +from pprint import pprint +configuration = modelcatalog.Configuration() +# Configure Bearer authorization (JWT): BearerAuth +configuration.access_token = 'YOUR_BEARER_TOKEN' + +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" +# Create an instance of the API class +api_instance = modelcatalog.CatalogIdentifierApi(modelcatalog.ApiClient(configuration)) +user = 'user_example' # str | Username +catalog_identifier = modelcatalog.CatalogIdentifier() # CatalogIdentifier | Information about the CatalogIdentifierto be created (optional) + +try: + # Create one CatalogIdentifier + api_response = api_instance.catalogidentifiers_post(user, catalog_identifier=catalog_identifier) + pprint(api_response) +except ApiException as e: + print("Exception when calling CatalogIdentifierApi->catalogidentifiers_post: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user** | **str**| Username | + **catalog_identifier** | [**CatalogIdentifier**](CatalogIdentifier.md)| Information about the CatalogIdentifierto be created | [optional] + +### Return type + +[**CatalogIdentifier**](CatalogIdentifier.md) + +### Authorization + +[BearerAuth](../#BearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Created | - | + +[[Back to top]](#) [[Back to API list]](../#documentation-for-api-endpoints) [[Back to Model list]](../#documentation-for-models) [[Back to README]](../) + diff --git a/docs/endpoints/CausalDiagram.md b/docs/endpoints/CausalDiagram.md index 0bc0855..6b461c3 100644 --- a/docs/endpoints/CausalDiagram.md +++ b/docs/endpoints/CausalDiagram.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**has_diagram_part** | **list[object]** | Property that links a causal diagram with its constituent nodes | [optional] +**has_diagram_part** | [**list[AnyOfVariablePresentationProcess]**](AnyOfVariablePresentationProcess.md) | Property that links a causal diagram with its constituent nodes | [optional] **description** | **list[str]** | small description | [optional] **id** | **str** | identifier | [optional] **label** | **list[str]** | short description of the resource | [optional] diff --git a/docs/endpoints/CausalDiagramApi.md b/docs/endpoints/CausalDiagramApi.md index c08a5cc..ea27a44 100644 --- a/docs/endpoints/CausalDiagramApi.md +++ b/docs/endpoints/CausalDiagramApi.md @@ -1,6 +1,6 @@ # modelcatalog.CausalDiagramApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.CausalDiagramApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the CausalDiagram to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.CausalDiagramApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the CausalDiagram to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.CausalDiagramApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/ConfigurationSetup.md b/docs/endpoints/ConfigurationSetup.md index 6c6763b..ac8f996 100644 --- a/docs/endpoints/ConfigurationSetup.md +++ b/docs/endpoints/ConfigurationSetup.md @@ -7,53 +7,55 @@ Name | Type | Description | Notes **keywords** | **list[str]** | Keywords associated with a software component | [optional] **has_documentation** | **list[str]** | Pointer to the documentation of the model | [optional] **has_implementation_script_location** | **list[str]** | Property that points to the main runnable script for the current function | [optional] -**software_requirements** | **list[str]** | Description not available | [optional] +**software_requirements** | **list[str]** | Software requirements needed to install a software component | [optional] **has_download_url** | **list[str]** | Download URL where to obtain the source/executable of the software | [optional] **type** | **list[str]** | type of the resource | [optional] **has_installation_instructions** | **list[str]** | Instructions required to install this particular piece of software. Installation instructions usually are available in a human-readable manner. | [optional] **compatible_visualization_software** | [**list[Software]**](Software.md) | Property that links a software component to other useful software that canbe used to visualize its outputs | [optional] -**copyright_holder** | **list[object]** | Description not available | [optional] +**copyright_holder** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Copyright holder for a software component | [optional] **has_faq** | **list[str]** | Frequently asked questions about a software | [optional] -**logo** | [**list[Image]**](Image.md) | Description not available | [optional] -**has_contact_person** | **list[object]** | Description not available | [optional] +**logo** | [**list[Image]**](Image.md) | Property that links to the image used as logo for a software component | [optional] +**has_contact_person** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Contact person responsible for a software component | [optional] **tag** | **list[str]** | Tag used to annotate a version or a software configuration. This annotation is useful to show which version is the latest, or which version is deprecated. Supported tags are: \"latest\", \"deprecated\" | [optional] **id** | **str** | identifier | [optional] **identifier** | **list[str]** | Identifier of the resource being described | [optional] -**has_sample_execution** | [**list[SampleExecution]**](SampleExecution.md) | Description not available | [optional] -**has_sample_result** | [**list[SampleResource]**](SampleResource.md) | Description not available | [optional] -**author** | **list[object]** | Description not available | [optional] +**has_sample_execution** | [**list[SampleExecution]**](SampleExecution.md) | Property pointing to a sample execution of a software configuration | [optional] +**has_sample_result** | [**list[SampleResource]**](SampleResource.md) | Property designed to link a software configuration to a sample resource resulting from its execution | [optional] +**author** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | The creator of a software component | [optional] +**was_derived_from_setup** | [**list[ConfigurationSetup]**](ConfigurationSetup.md) | Property that links a setup to a previous version of that setup. This property is needed (for example) when creating snapshots of setups. | [optional] **has_constraint** | **list[str]** | Constraint or rule associated to a variable or software configuration. For example: \"This model accepts only monthly data\", or \"all inputs of this model configuration must share the same location\". More structured restrictions, such as Jena rules or SWRL rules may also be captured with this property | [optional] **has_build_file** | **list[str]** | A file (e.g., Dockerfile) with executable instructions indicating how a Software Image or a Software component is built | [optional] **short_description** | **list[str]** | A summarized description of the resource | [optional] **has_execution_command** | **list[str]** | Execution instructions on how to run the image | [optional] -**date_published** | **list[datetime]** | Description not available | [optional] +**date_published** | **list[datetime]** | Date when a software component was published | [optional] **license** | **list[str]** | License of a software component or its source code | [optional] -**has_source_code** | [**list[SourceCode]**](SourceCode.md) | Description not available | [optional] +**has_source_code** | [**list[SourceCode]**](SourceCode.md) | Property designed to link a software with its software source code (which may reside in a code repository such as GitHub) | [optional] **has_setup** | [**list[ConfigurationSetup]**](ConfigurationSetup.md) | Property used to define configurations with some fixed resources and values. The rationale of this property is to allow predefined configurations | [optional] **has_example** | **list[str]** | An example explaining a scenario where the software component was used in plain language. | [optional] -**publisher** | **list[object]** | Description not available | [optional] +**publisher** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Publisher organization or person responsible for a software component | [optional] **has_output** | [**list[DatasetSpecification]**](DatasetSpecification.md) | Property that expresses what are the outputs of a model | [optional] +**status** | **list[str]** | Data property to indicate the status of a configuration setups. For example, to indicate that a setup has been executed in a platform, that the setup should notbe shown to users (it's an auxiliary setup), etc. | [optional] **doi** | **list[str]** | Digital Object Identifier associated with a software component | [optional] **has_funding** | [**list[FundingInformation]**](FundingInformation.md) | Property that links a software project to its funding information | [optional] **has_component_location** | **list[str]** | Location of the aggregation of all the files needed to execute the component. Usually a zip file including the run script and support scripts, including specification files | [optional] **support_details** | **list[str]** | Property to link details, such as mailing lists in case a contact person is not provided | [optional] -**has_version** | [**list[SoftwareVersion]**](SoftwareVersion.md) | Description not available | [optional] -**has_typical_data_source** | **list[str]** | Description not available | [optional] +**has_version** | [**list[SoftwareVersion]**](SoftwareVersion.md) | Property designed to link a software component with its corresponding versions | [optional] +**has_typical_data_source** | **list[str]** | Typical data sources that are used by a software component | [optional] **description** | **list[str]** | small description | [optional] **reference_publication** | **list[str]** | Main publication to cite for this software component | [optional] -**screenshot** | [**list[Image]**](Image.md) | Description not available | [optional] -**had_primary_source** | **list[object]** | had primary source | [optional] +**screenshot** | [**list[Image]**](Image.md) | Image illustrating a snapshot of the target software | [optional] +**had_primary_source** | **list[object]** | Property to identify the original source of the information of the annotated resource. It could be a web page, an organization, a person, some experiment notes, etc. | [optional] **issue_tracker** | **list[str]** | Pointer to the issue tracker of a software component | [optional] **has_software_image** | [**list[SoftwareImage]**](SoftwareImage.md) | Function to link a function with its corresponding container | [optional] -**date_created** | **list[datetime]** | Description not available | [optional] -**contributor** | [**list[Person]**](Person.md) | Description not available | [optional] +**date_created** | **list[datetime]** | Date when a software component was created | [optional] +**contributor** | [**list[Person]**](Person.md) | Contributor to a software component | [optional] **has_purpose** | **list[str]** | Objective or main functionality that can be achieved by running this software | [optional] **has_executable_instructions** | **list[str]** | Instructions that indicate how a software component should be executed. The difference with `hasExecutionCommand` is that the execution instructions aim to be human-readable, and have explanations between the different commands and instructions | [optional] **has_sample_visualization** | [**list[Visualization]**](Visualization.md) | A typical sample visualization of the softwware outputs | [optional] -**memory_requirements** | **list[str]** | Description not available | [optional] +**memory_requirements** | **list[str]** | Memory requirements of a software | [optional] **website** | **list[str]** | Website of the software | [optional] **citation** | **list[str]** | How to cite this software | [optional] -**processor_requirements** | **list[str]** | Description not available | [optional] +**processor_requirements** | **list[str]** | Processor requirements of a software component | [optional] **adjustable_parameter** | [**list[Parameter]**](Parameter.md) | Parameter that can be adjusted in a configuration setup | [optional] **has_usage_notes** | **list[str]** | Property that describes the usage considerations of a particular software. These notes capture the rationale of for that software configuration, along with an explanation for sample inputs, things to consider when running the model with data, etc. | [optional] **has_support_script_location** | **list[str]** | Property that links to the location of scripts that may be used from the main runnable script. | [optional] @@ -61,7 +63,7 @@ Name | Type | Description | Notes **label** | **list[str]** | short description of the resource | [optional] **has_assumption** | **list[str]** | Assumptions of a software, e.g. the solver being used for a particular model, the source of the data (e.g., all data must have a given resolution), etc. | [optional] **has_parameter** | [**list[Parameter]**](Parameter.md) | Property that indicates the parameters of a model configuration | [optional] -**operating_systems** | **list[str]** | Description not available | [optional] +**operating_systems** | **list[str]** | Operating systems under which a software component can operate | [optional] **has_executable_notebook** | **list[str]** | Property that links a software component with an executable notebook (e.g., Jupyter notebook) that illustrates how to use it in an executable manner. | [optional] **useful_for_calculating_index** | [**list[NumericalIndex]**](NumericalIndex.md) | Property that indicates that a software component (or any of its outputs) can be used to calculate a particular index. The rationale for this property is that indices are usually calculated by applying post-processing steps to the outputs of a software component. | [optional] **has_input** | [**list[DatasetSpecification]**](DatasetSpecification.md) | Property that links a model configuration to the input types expected by it. | [optional] diff --git a/docs/endpoints/ConfigurationSetupApi.md b/docs/endpoints/ConfigurationSetupApi.md index c93072e..cdfaacb 100644 --- a/docs/endpoints/ConfigurationSetupApi.md +++ b/docs/endpoints/ConfigurationSetupApi.md @@ -1,6 +1,6 @@ # modelcatalog.ConfigurationSetupApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -92,8 +92,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.ConfigurationSetupApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the ConfigurationSetup to be retrieved @@ -210,8 +210,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.ConfigurationSetupApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the ConfigurationSetup to be retrieved @@ -275,8 +275,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.ConfigurationSetupApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/CoupledModel.md b/docs/endpoints/CoupledModel.md new file mode 100644 index 0000000..871dee9 --- /dev/null +++ b/docs/endpoints/CoupledModel.md @@ -0,0 +1,62 @@ +# CoupledModel + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**has_download_instructions** | **list[str]** | Description not available | [optional] +**keywords** | **list[str]** | Description not available | [optional] +**has_documentation** | **list[str]** | Description not available | [optional] +**has_grid** | [**list[Grid]**](Grid.md) | Grid information about the model | [optional] +**software_requirements** | **list[str]** | Description not available | [optional] +**has_download_url** | **list[str]** | Description not available | [optional] +**type** | **list[str]** | type of the resource | [optional] +**has_installation_instructions** | **list[str]** | Description not available | [optional] +**compatible_visualization_software** | [**list[Software]**](Software.md) | Description not available | [optional] +**copyright_holder** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Description not available | [optional] +**has_faq** | **list[str]** | Description not available | [optional] +**logo** | [**list[Image]**](Image.md) | Description not available | [optional] +**has_contact_person** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Description not available | [optional] +**id** | **str** | identifier | [optional] +**identifier** | **list[str]** | Description not available | [optional] +**author** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Description not available | [optional] +**has_build_file** | **list[str]** | Description not available | [optional] +**short_description** | **list[str]** | Description not available | [optional] +**date_published** | **list[datetime]** | Description not available | [optional] +**license** | **list[str]** | Description not available | [optional] +**has_source_code** | [**list[SourceCode]**](SourceCode.md) | Description not available | [optional] +**has_explanation_diagram** | [**list[Image]**](Image.md) | Diagram used to explain the behavior of the model | [optional] +**has_example** | **list[str]** | Description not available | [optional] +**publisher** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Description not available | [optional] +**doi** | **list[str]** | Description not available | [optional] +**has_funding** | [**list[FundingInformation]**](FundingInformation.md) | Description not available | [optional] +**support_details** | **list[str]** | Description not available | [optional] +**has_version** | [**list[SoftwareVersion]**](SoftwareVersion.md) | Description not available | [optional] +**has_typical_data_source** | **list[str]** | Description not available | [optional] +**description** | **list[str]** | small description | [optional] +**reference_publication** | **list[str]** | Description not available | [optional] +**screenshot** | [**list[Image]**](Image.md) | Description not available | [optional] +**uses_model** | [**list[Model]**](Model.md) | Property that describes which models are used by a coupled model | [optional] +**has_model_category** | [**list[ModelCategory]**](ModelCategory.md) | Category associated with a model (e.g., Hydrology, etc.) | [optional] +**had_primary_source** | **list[object]** | Description not available | [optional] +**issue_tracker** | **list[str]** | Description not available | [optional] +**date_created** | **list[datetime]** | Description not available | [optional] +**contributor** | [**list[Person]**](Person.md) | Description not available | [optional] +**has_purpose** | **list[str]** | Description not available | [optional] +**has_executable_instructions** | **list[str]** | Description not available | [optional] +**has_sample_visualization** | [**list[Visualization]**](Visualization.md) | Description not available | [optional] +**memory_requirements** | **list[str]** | Description not available | [optional] +**website** | **list[str]** | Description not available | [optional] +**citation** | **list[str]** | Description not available | [optional] +**processor_requirements** | **list[str]** | Description not available | [optional] +**has_usage_notes** | **list[str]** | Description not available | [optional] +**readme** | **list[str]** | Description not available | [optional] +**label** | **list[str]** | short description of the resource | [optional] +**has_assumption** | **list[str]** | Description not available | [optional] +**operating_systems** | **list[str]** | Description not available | [optional] +**has_executable_notebook** | **list[str]** | Description not available | [optional] +**has_equation** | [**list[Equation]**](Equation.md) | Equations used in the model | [optional] +**useful_for_calculating_index** | [**list[NumericalIndex]**](NumericalIndex.md) | Description not available | [optional] + +[[Back to Model list]](../#documentation-for-models) [[Back to API list]](../#documentation-for-api-endpoints) [[Back to README]](../) + + diff --git a/docs/endpoints/CoupledModelApi.md b/docs/endpoints/CoupledModelApi.md new file mode 100644 index 0000000..103b246 --- /dev/null +++ b/docs/endpoints/CoupledModelApi.md @@ -0,0 +1,318 @@ +# modelcatalog.CoupledModelApi + +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**coupledmodels_get**](CoupledModelApi.md#coupledmodels_get) | **GET** /coupledmodels | List all instances of CoupledModel +[**coupledmodels_id_delete**](CoupledModelApi.md#coupledmodels_id_delete) | **DELETE** /coupledmodels/{id} | Delete an existing CoupledModel +[**coupledmodels_id_get**](CoupledModelApi.md#coupledmodels_id_get) | **GET** /coupledmodels/{id} | Get a single CoupledModel by its id +[**coupledmodels_id_put**](CoupledModelApi.md#coupledmodels_id_put) | **PUT** /coupledmodels/{id} | Update an existing CoupledModel +[**coupledmodels_post**](CoupledModelApi.md#coupledmodels_post) | **POST** /coupledmodels | Create one CoupledModel + + +# **coupledmodels_get** +> list[CoupledModel] coupledmodels_get(username=username, label=label, page=page, per_page=per_page) + +List all instances of CoupledModel + +Gets a list of all instances of CoupledModel (more information in https://w3id.org/okn/o/sdm#CoupledModel) + +### Example + +```python +from __future__ import print_function +import time +import modelcatalog +from modelcatalog.rest import ApiException +from pprint import pprint + +# Create an instance of the API class +api_instance = modelcatalog.CoupledModelApi() +username = 'username_example' # str | Name of the user graph to query (optional) +label = 'label_example' # str | Filter by label (optional) +page = 1 # int | Page number (optional) (default to 1) +per_page = 100 # int | Items per page (optional) (default to 100) + +try: + # List all instances of CoupledModel + api_response = api_instance.coupledmodels_get(username=username, label=label, page=page, per_page=per_page) + pprint(api_response) +except ApiException as e: + print("Exception when calling CoupledModelApi->coupledmodels_get: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **username** | **str**| Name of the user graph to query | [optional] + **label** | **str**| Filter by label | [optional] + **page** | **int**| Page number | [optional] [default to 1] + **per_page** | **int**| Items per page | [optional] [default to 100] + +### Return type + +[**list[CoupledModel]**](CoupledModel.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successful response - returns an array with the instances of CoupledModel. | - | + +[[Back to top]](#) [[Back to API list]](../#documentation-for-api-endpoints) [[Back to Model list]](../#documentation-for-models) [[Back to README]](../) + +# **coupledmodels_id_delete** +> coupledmodels_id_delete(id, user) + +Delete an existing CoupledModel + +Delete an existing CoupledModel (more information in https://w3id.org/okn/o/sdm#CoupledModel) + +### Example + +* Bearer (JWT) Authentication (BearerAuth): +```python +from __future__ import print_function +import time +import modelcatalog +from modelcatalog.rest import ApiException +from pprint import pprint +configuration = modelcatalog.Configuration() +# Configure Bearer authorization (JWT): BearerAuth +configuration.access_token = 'YOUR_BEARER_TOKEN' + +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" +# Create an instance of the API class +api_instance = modelcatalog.CoupledModelApi(modelcatalog.ApiClient(configuration)) +id = 'id_example' # str | The ID of the CoupledModel to be retrieved +user = 'user_example' # str | Username + +try: + # Delete an existing CoupledModel + api_instance.coupledmodels_id_delete(id, user) +except ApiException as e: + print("Exception when calling CoupledModelApi->coupledmodels_id_delete: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| The ID of the CoupledModel to be retrieved | + **user** | **str**| Username | + +### Return type + +void (empty response body) + +### Authorization + +[BearerAuth](../#BearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**202** | Deleted | - | +**404** | Not Found | - | + +[[Back to top]](#) [[Back to API list]](../#documentation-for-api-endpoints) [[Back to Model list]](../#documentation-for-models) [[Back to README]](../) + +# **coupledmodels_id_get** +> CoupledModel coupledmodels_id_get(id, username=username) + +Get a single CoupledModel by its id + +Gets the details of a given CoupledModel (more information in https://w3id.org/okn/o/sdm#CoupledModel) + +### Example + +```python +from __future__ import print_function +import time +import modelcatalog +from modelcatalog.rest import ApiException +from pprint import pprint + +# Create an instance of the API class +api_instance = modelcatalog.CoupledModelApi() +id = 'id_example' # str | The ID of the CoupledModel to be retrieved +username = 'username_example' # str | Name of the user graph to query (optional) + +try: + # Get a single CoupledModel by its id + api_response = api_instance.coupledmodels_id_get(id, username=username) + pprint(api_response) +except ApiException as e: + print("Exception when calling CoupledModelApi->coupledmodels_id_get: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| The ID of the CoupledModel to be retrieved | + **username** | **str**| Name of the user graph to query | [optional] + +### Return type + +[**CoupledModel**](CoupledModel.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Gets the details of a given CoupledModel | - | + +[[Back to top]](#) [[Back to API list]](../#documentation-for-api-endpoints) [[Back to Model list]](../#documentation-for-models) [[Back to README]](../) + +# **coupledmodels_id_put** +> CoupledModel coupledmodels_id_put(id, user, coupled_model=coupled_model) + +Update an existing CoupledModel + +Updates an existing CoupledModel (more information in https://w3id.org/okn/o/sdm#CoupledModel) + +### Example + +* Bearer (JWT) Authentication (BearerAuth): +```python +from __future__ import print_function +import time +import modelcatalog +from modelcatalog.rest import ApiException +from pprint import pprint +configuration = modelcatalog.Configuration() +# Configure Bearer authorization (JWT): BearerAuth +configuration.access_token = 'YOUR_BEARER_TOKEN' + +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" +# Create an instance of the API class +api_instance = modelcatalog.CoupledModelApi(modelcatalog.ApiClient(configuration)) +id = 'id_example' # str | The ID of the CoupledModel to be retrieved +user = 'user_example' # str | Username +coupled_model = modelcatalog.CoupledModel() # CoupledModel | An old CoupledModelto be updated (optional) + +try: + # Update an existing CoupledModel + api_response = api_instance.coupledmodels_id_put(id, user, coupled_model=coupled_model) + pprint(api_response) +except ApiException as e: + print("Exception when calling CoupledModelApi->coupledmodels_id_put: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| The ID of the CoupledModel to be retrieved | + **user** | **str**| Username | + **coupled_model** | [**CoupledModel**](CoupledModel.md)| An old CoupledModelto be updated | [optional] + +### Return type + +[**CoupledModel**](CoupledModel.md) + +### Authorization + +[BearerAuth](../#BearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Updated | - | +**404** | Not Found | - | + +[[Back to top]](#) [[Back to API list]](../#documentation-for-api-endpoints) [[Back to Model list]](../#documentation-for-models) [[Back to README]](../) + +# **coupledmodels_post** +> CoupledModel coupledmodels_post(user, coupled_model=coupled_model) + +Create one CoupledModel + +Create a new instance of CoupledModel (more information in https://w3id.org/okn/o/sdm#CoupledModel) + +### Example + +* Bearer (JWT) Authentication (BearerAuth): +```python +from __future__ import print_function +import time +import modelcatalog +from modelcatalog.rest import ApiException +from pprint import pprint +configuration = modelcatalog.Configuration() +# Configure Bearer authorization (JWT): BearerAuth +configuration.access_token = 'YOUR_BEARER_TOKEN' + +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" +# Create an instance of the API class +api_instance = modelcatalog.CoupledModelApi(modelcatalog.ApiClient(configuration)) +user = 'user_example' # str | Username +coupled_model = modelcatalog.CoupledModel() # CoupledModel | Information about the CoupledModelto be created (optional) + +try: + # Create one CoupledModel + api_response = api_instance.coupledmodels_post(user, coupled_model=coupled_model) + pprint(api_response) +except ApiException as e: + print("Exception when calling CoupledModelApi->coupledmodels_post: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user** | **str**| Username | + **coupled_model** | [**CoupledModel**](CoupledModel.md)| Information about the CoupledModelto be created | [optional] + +### Return type + +[**CoupledModel**](CoupledModel.md) + +### Authorization + +[BearerAuth](../#BearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Created | - | + +[[Back to top]](#) [[Back to API list]](../#documentation-for-api-endpoints) [[Back to Model list]](../#documentation-for-models) [[Back to README]](../) + diff --git a/docs/endpoints/DataTransformation.md b/docs/endpoints/DataTransformation.md index 14a6ba0..f817907 100644 --- a/docs/endpoints/DataTransformation.md +++ b/docs/endpoints/DataTransformation.md @@ -7,60 +7,60 @@ Name | Type | Description | Notes **keywords** | **list[str]** | Keywords associated with a software component | [optional] **has_documentation** | **list[str]** | Pointer to the documentation of the model | [optional] **has_implementation_script_location** | **list[str]** | Property that points to the main runnable script for the current function | [optional] -**software_requirements** | **list[str]** | Description not available | [optional] +**software_requirements** | **list[str]** | Software requirements needed to install a software component | [optional] **has_download_url** | **list[str]** | Download URL where to obtain the source/executable of the software | [optional] **type** | **list[str]** | type of the resource | [optional] **has_installation_instructions** | **list[str]** | Instructions required to install this particular piece of software. Installation instructions usually are available in a human-readable manner. | [optional] **compatible_visualization_software** | [**list[Software]**](Software.md) | Property that links a software component to other useful software that canbe used to visualize its outputs | [optional] -**copyright_holder** | **list[object]** | Description not available | [optional] +**copyright_holder** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Copyright holder for a software component | [optional] **has_faq** | **list[str]** | Frequently asked questions about a software | [optional] -**logo** | [**list[Image]**](Image.md) | Description not available | [optional] -**has_contact_person** | **list[object]** | Description not available | [optional] +**logo** | [**list[Image]**](Image.md) | Property that links to the image used as logo for a software component | [optional] +**has_contact_person** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Contact person responsible for a software component | [optional] **tag** | **list[str]** | Tag used to annotate a version or a software configuration. This annotation is useful to show which version is the latest, or which version is deprecated. Supported tags are: \"latest\", \"deprecated\" | [optional] **id** | **str** | identifier | [optional] **identifier** | **list[str]** | Identifier of the resource being described | [optional] -**has_sample_execution** | [**list[SampleExecution]**](SampleExecution.md) | Description not available | [optional] -**has_sample_result** | [**list[SampleResource]**](SampleResource.md) | Description not available | [optional] -**author** | **list[object]** | Description not available | [optional] +**has_sample_execution** | [**list[SampleExecution]**](SampleExecution.md) | Property pointing to a sample execution of a software configuration | [optional] +**has_sample_result** | [**list[SampleResource]**](SampleResource.md) | Property designed to link a software configuration to a sample resource resulting from its execution | [optional] +**author** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | The creator of a software component | [optional] **has_constraint** | **list[str]** | Constraint or rule associated to a variable or software configuration. For example: \"This model accepts only monthly data\", or \"all inputs of this model configuration must share the same location\". More structured restrictions, such as Jena rules or SWRL rules may also be captured with this property | [optional] **has_build_file** | **list[str]** | A file (e.g., Dockerfile) with executable instructions indicating how a Software Image or a Software component is built | [optional] **short_description** | **list[str]** | A summarized description of the resource | [optional] **has_execution_command** | **list[str]** | Execution instructions on how to run the image | [optional] -**date_published** | **list[datetime]** | Description not available | [optional] +**date_published** | **list[datetime]** | Date when a software component was published | [optional] **license** | **list[str]** | License of a software component or its source code | [optional] -**has_source_code** | [**list[SourceCode]**](SourceCode.md) | Description not available | [optional] +**has_source_code** | [**list[SourceCode]**](SourceCode.md) | Property designed to link a software with its software source code (which may reside in a code repository such as GitHub) | [optional] **has_setup** | [**list[ConfigurationSetup]**](ConfigurationSetup.md) | Property used to define configurations with some fixed resources and values. The rationale of this property is to allow predefined configurations | [optional] **has_example** | **list[str]** | An example explaining a scenario where the software component was used in plain language. | [optional] -**publisher** | **list[object]** | Description not available | [optional] +**publisher** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Publisher organization or person responsible for a software component | [optional] **has_output** | [**list[DatasetSpecification]**](DatasetSpecification.md) | Property that expresses what are the outputs of a model | [optional] **doi** | **list[str]** | Digital Object Identifier associated with a software component | [optional] **has_funding** | [**list[FundingInformation]**](FundingInformation.md) | Property that links a software project to its funding information | [optional] **has_component_location** | **list[str]** | Location of the aggregation of all the files needed to execute the component. Usually a zip file including the run script and support scripts, including specification files | [optional] **support_details** | **list[str]** | Property to link details, such as mailing lists in case a contact person is not provided | [optional] -**has_version** | [**list[SoftwareVersion]**](SoftwareVersion.md) | Description not available | [optional] -**has_typical_data_source** | **list[str]** | Description not available | [optional] +**has_version** | [**list[SoftwareVersion]**](SoftwareVersion.md) | Property designed to link a software component with its corresponding versions | [optional] +**has_typical_data_source** | **list[str]** | Typical data sources that are used by a software component | [optional] **description** | **list[str]** | small description | [optional] **reference_publication** | **list[str]** | Main publication to cite for this software component | [optional] -**screenshot** | [**list[Image]**](Image.md) | Description not available | [optional] -**had_primary_source** | **list[object]** | had primary source | [optional] +**screenshot** | [**list[Image]**](Image.md) | Image illustrating a snapshot of the target software | [optional] +**had_primary_source** | **list[object]** | Property to identify the original source of the information of the annotated resource. It could be a web page, an organization, a person, some experiment notes, etc. | [optional] **issue_tracker** | **list[str]** | Pointer to the issue tracker of a software component | [optional] **has_software_image** | [**list[SoftwareImage]**](SoftwareImage.md) | Function to link a function with its corresponding container | [optional] -**date_created** | **list[datetime]** | Description not available | [optional] -**contributor** | [**list[Person]**](Person.md) | Description not available | [optional] +**date_created** | **list[datetime]** | Date when a software component was created | [optional] +**contributor** | [**list[Person]**](Person.md) | Contributor to a software component | [optional] **has_purpose** | **list[str]** | Objective or main functionality that can be achieved by running this software | [optional] **has_executable_instructions** | **list[str]** | Instructions that indicate how a software component should be executed. The difference with `hasExecutionCommand` is that the execution instructions aim to be human-readable, and have explanations between the different commands and instructions | [optional] **has_sample_visualization** | [**list[Visualization]**](Visualization.md) | A typical sample visualization of the softwware outputs | [optional] -**memory_requirements** | **list[str]** | Description not available | [optional] +**memory_requirements** | **list[str]** | Memory requirements of a software | [optional] **website** | **list[str]** | Website of the software | [optional] **citation** | **list[str]** | How to cite this software | [optional] -**processor_requirements** | **list[str]** | Description not available | [optional] +**processor_requirements** | **list[str]** | Processor requirements of a software component | [optional] **has_usage_notes** | **list[str]** | Property that describes the usage considerations of a particular software. These notes capture the rationale of for that software configuration, along with an explanation for sample inputs, things to consider when running the model with data, etc. | [optional] **has_support_script_location** | **list[str]** | Property that links to the location of scripts that may be used from the main runnable script. | [optional] **readme** | **list[str]** | URl to the readme file of a software component | [optional] **label** | **list[str]** | short description of the resource | [optional] **has_assumption** | **list[str]** | Assumptions of a software, e.g. the solver being used for a particular model, the source of the data (e.g., all data must have a given resolution), etc. | [optional] **has_parameter** | [**list[Parameter]**](Parameter.md) | Property that indicates the parameters of a model configuration | [optional] -**operating_systems** | **list[str]** | Description not available | [optional] +**operating_systems** | **list[str]** | Operating systems under which a software component can operate | [optional] **has_executable_notebook** | **list[str]** | Property that links a software component with an executable notebook (e.g., Jupyter notebook) that illustrates how to use it in an executable manner. | [optional] **useful_for_calculating_index** | [**list[NumericalIndex]**](NumericalIndex.md) | Property that indicates that a software component (or any of its outputs) can be used to calculate a particular index. The rationale for this property is that indices are usually calculated by applying post-processing steps to the outputs of a software component. | [optional] **has_input** | [**list[DatasetSpecification]**](DatasetSpecification.md) | Property that links a model configuration to the input types expected by it. | [optional] diff --git a/docs/endpoints/DataTransformationApi.md b/docs/endpoints/DataTransformationApi.md index 1d37165..cbaee44 100644 --- a/docs/endpoints/DataTransformationApi.md +++ b/docs/endpoints/DataTransformationApi.md @@ -1,10 +1,9 @@ # modelcatalog.DataTransformationApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- -[**custom_dataspecifications_id_datatransformations_get**](DataTransformationApi.md#custom_dataspecifications_id_datatransformations_get) | **GET** /custom/dataspecifications/{id}/datatransformations | Gets a list of data transformations related a dataset [**datatransformations_get**](DataTransformationApi.md#datatransformations_get) | **GET** /datatransformations | List all instances of DataTransformation [**datatransformations_id_delete**](DataTransformationApi.md#datatransformations_id_delete) | **DELETE** /datatransformations/{id} | Delete an existing DataTransformation [**datatransformations_id_get**](DataTransformationApi.md#datatransformations_id_get) | **GET** /datatransformations/{id} | Get a single DataTransformation by its id @@ -12,64 +11,6 @@ Method | HTTP request | Description [**datatransformations_post**](DataTransformationApi.md#datatransformations_post) | **POST** /datatransformations | Create one DataTransformation -# **custom_dataspecifications_id_datatransformations_get** -> list[DataTransformation] custom_dataspecifications_id_datatransformations_get(id, custom_query_name=custom_query_name, username=username) - -Gets a list of data transformations related a dataset - -Gets a list of data transformations related a dataset - -### Example - -```python -from __future__ import print_function -import time -import modelcatalog -from modelcatalog.rest import ApiException -from pprint import pprint - -# Create an instance of the API class -api_instance = modelcatalog.DataTransformationApi() -id = 'id_example' # str | The ID of the dataspecification -custom_query_name = 'custom_datatransformations' # str | Name of the custom query (optional) (default to 'custom_datatransformations') -username = 'username_example' # str | Username to query (optional) - -try: - # Gets a list of data transformations related a dataset - api_response = api_instance.custom_dataspecifications_id_datatransformations_get(id, custom_query_name=custom_query_name, username=username) - pprint(api_response) -except ApiException as e: - print("Exception when calling DataTransformationApi->custom_dataspecifications_id_datatransformations_get: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| The ID of the dataspecification | - **custom_query_name** | **str**| Name of the custom query | [optional] [default to 'custom_datatransformations'] - **username** | **str**| Username to query | [optional] - -### Return type - -[**list[DataTransformation]**](DataTransformation.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Gets a list of data transformations filter related a dataset | - | - -[[Back to top]](#) [[Back to API list]](../#documentation-for-api-endpoints) [[Back to Model list]](../#documentation-for-models) [[Back to README]](../) - # **datatransformations_get** > list[DataTransformation] datatransformations_get(username=username, label=label, page=page, per_page=per_page) @@ -150,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.DataTransformationApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the DataTransformation to be retrieved @@ -268,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.DataTransformationApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the DataTransformation to be retrieved @@ -333,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.DataTransformationApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/DataTransformationSetup.md b/docs/endpoints/DataTransformationSetup.md index 91566ef..50460fd 100644 --- a/docs/endpoints/DataTransformationSetup.md +++ b/docs/endpoints/DataTransformationSetup.md @@ -7,53 +7,55 @@ Name | Type | Description | Notes **keywords** | **list[str]** | Keywords associated with a software component | [optional] **has_documentation** | **list[str]** | Pointer to the documentation of the model | [optional] **has_implementation_script_location** | **list[str]** | Property that points to the main runnable script for the current function | [optional] -**software_requirements** | **list[str]** | Description not available | [optional] +**software_requirements** | **list[str]** | Software requirements needed to install a software component | [optional] **has_download_url** | **list[str]** | Download URL where to obtain the source/executable of the software | [optional] **type** | **list[str]** | type of the resource | [optional] **has_installation_instructions** | **list[str]** | Instructions required to install this particular piece of software. Installation instructions usually are available in a human-readable manner. | [optional] **compatible_visualization_software** | [**list[Software]**](Software.md) | Property that links a software component to other useful software that canbe used to visualize its outputs | [optional] -**copyright_holder** | **list[object]** | Description not available | [optional] +**copyright_holder** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Copyright holder for a software component | [optional] **has_faq** | **list[str]** | Frequently asked questions about a software | [optional] -**logo** | [**list[Image]**](Image.md) | Description not available | [optional] -**has_contact_person** | **list[object]** | Description not available | [optional] +**logo** | [**list[Image]**](Image.md) | Property that links to the image used as logo for a software component | [optional] +**has_contact_person** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Contact person responsible for a software component | [optional] **tag** | **list[str]** | Tag used to annotate a version or a software configuration. This annotation is useful to show which version is the latest, or which version is deprecated. Supported tags are: \"latest\", \"deprecated\" | [optional] **id** | **str** | identifier | [optional] **identifier** | **list[str]** | Identifier of the resource being described | [optional] -**has_sample_execution** | [**list[SampleExecution]**](SampleExecution.md) | Description not available | [optional] -**has_sample_result** | [**list[SampleResource]**](SampleResource.md) | Description not available | [optional] -**author** | **list[object]** | Description not available | [optional] +**has_sample_execution** | [**list[SampleExecution]**](SampleExecution.md) | Property pointing to a sample execution of a software configuration | [optional] +**has_sample_result** | [**list[SampleResource]**](SampleResource.md) | Property designed to link a software configuration to a sample resource resulting from its execution | [optional] +**author** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | The creator of a software component | [optional] +**was_derived_from_setup** | [**list[ConfigurationSetup]**](ConfigurationSetup.md) | Property that links a setup to a previous version of that setup. This property is needed (for example) when creating snapshots of setups. | [optional] **has_constraint** | **list[str]** | Constraint or rule associated to a variable or software configuration. For example: \"This model accepts only monthly data\", or \"all inputs of this model configuration must share the same location\". More structured restrictions, such as Jena rules or SWRL rules may also be captured with this property | [optional] **has_build_file** | **list[str]** | A file (e.g., Dockerfile) with executable instructions indicating how a Software Image or a Software component is built | [optional] **short_description** | **list[str]** | A summarized description of the resource | [optional] **has_execution_command** | **list[str]** | Execution instructions on how to run the image | [optional] -**date_published** | **list[datetime]** | Description not available | [optional] +**date_published** | **list[datetime]** | Date when a software component was published | [optional] **license** | **list[str]** | License of a software component or its source code | [optional] -**has_source_code** | [**list[SourceCode]**](SourceCode.md) | Description not available | [optional] +**has_source_code** | [**list[SourceCode]**](SourceCode.md) | Property designed to link a software with its software source code (which may reside in a code repository such as GitHub) | [optional] **has_setup** | [**list[ConfigurationSetup]**](ConfigurationSetup.md) | Property used to define configurations with some fixed resources and values. The rationale of this property is to allow predefined configurations | [optional] **has_example** | **list[str]** | An example explaining a scenario where the software component was used in plain language. | [optional] -**publisher** | **list[object]** | Description not available | [optional] +**publisher** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Publisher organization or person responsible for a software component | [optional] **has_output** | [**list[DatasetSpecification]**](DatasetSpecification.md) | Property that expresses what are the outputs of a model | [optional] +**status** | **list[str]** | Data property to indicate the status of a configuration setups. For example, to indicate that a setup has been executed in a platform, that the setup should notbe shown to users (it's an auxiliary setup), etc. | [optional] **doi** | **list[str]** | Digital Object Identifier associated with a software component | [optional] **has_funding** | [**list[FundingInformation]**](FundingInformation.md) | Property that links a software project to its funding information | [optional] **has_component_location** | **list[str]** | Location of the aggregation of all the files needed to execute the component. Usually a zip file including the run script and support scripts, including specification files | [optional] **support_details** | **list[str]** | Property to link details, such as mailing lists in case a contact person is not provided | [optional] -**has_version** | [**list[SoftwareVersion]**](SoftwareVersion.md) | Description not available | [optional] -**has_typical_data_source** | **list[str]** | Description not available | [optional] +**has_version** | [**list[SoftwareVersion]**](SoftwareVersion.md) | Property designed to link a software component with its corresponding versions | [optional] +**has_typical_data_source** | **list[str]** | Typical data sources that are used by a software component | [optional] **description** | **list[str]** | small description | [optional] **reference_publication** | **list[str]** | Main publication to cite for this software component | [optional] -**screenshot** | [**list[Image]**](Image.md) | Description not available | [optional] -**had_primary_source** | **list[object]** | had primary source | [optional] +**screenshot** | [**list[Image]**](Image.md) | Image illustrating a snapshot of the target software | [optional] +**had_primary_source** | **list[object]** | Property to identify the original source of the information of the annotated resource. It could be a web page, an organization, a person, some experiment notes, etc. | [optional] **issue_tracker** | **list[str]** | Pointer to the issue tracker of a software component | [optional] **has_software_image** | [**list[SoftwareImage]**](SoftwareImage.md) | Function to link a function with its corresponding container | [optional] -**date_created** | **list[datetime]** | Description not available | [optional] -**contributor** | [**list[Person]**](Person.md) | Description not available | [optional] +**date_created** | **list[datetime]** | Date when a software component was created | [optional] +**contributor** | [**list[Person]**](Person.md) | Contributor to a software component | [optional] **has_purpose** | **list[str]** | Objective or main functionality that can be achieved by running this software | [optional] **has_executable_instructions** | **list[str]** | Instructions that indicate how a software component should be executed. The difference with `hasExecutionCommand` is that the execution instructions aim to be human-readable, and have explanations between the different commands and instructions | [optional] **has_sample_visualization** | [**list[Visualization]**](Visualization.md) | A typical sample visualization of the softwware outputs | [optional] -**memory_requirements** | **list[str]** | Description not available | [optional] +**memory_requirements** | **list[str]** | Memory requirements of a software | [optional] **website** | **list[str]** | Website of the software | [optional] **citation** | **list[str]** | How to cite this software | [optional] -**processor_requirements** | **list[str]** | Description not available | [optional] +**processor_requirements** | **list[str]** | Processor requirements of a software component | [optional] **adjustable_parameter** | [**list[Parameter]**](Parameter.md) | Parameter that can be adjusted in a configuration setup | [optional] **has_usage_notes** | **list[str]** | Property that describes the usage considerations of a particular software. These notes capture the rationale of for that software configuration, along with an explanation for sample inputs, things to consider when running the model with data, etc. | [optional] **has_support_script_location** | **list[str]** | Property that links to the location of scripts that may be used from the main runnable script. | [optional] @@ -61,7 +63,7 @@ Name | Type | Description | Notes **label** | **list[str]** | short description of the resource | [optional] **has_assumption** | **list[str]** | Assumptions of a software, e.g. the solver being used for a particular model, the source of the data (e.g., all data must have a given resolution), etc. | [optional] **has_parameter** | [**list[Parameter]**](Parameter.md) | Property that indicates the parameters of a model configuration | [optional] -**operating_systems** | **list[str]** | Description not available | [optional] +**operating_systems** | **list[str]** | Operating systems under which a software component can operate | [optional] **has_executable_notebook** | **list[str]** | Property that links a software component with an executable notebook (e.g., Jupyter notebook) that illustrates how to use it in an executable manner. | [optional] **useful_for_calculating_index** | [**list[NumericalIndex]**](NumericalIndex.md) | Property that indicates that a software component (or any of its outputs) can be used to calculate a particular index. The rationale for this property is that indices are usually calculated by applying post-processing steps to the outputs of a software component. | [optional] **has_input** | [**list[DatasetSpecification]**](DatasetSpecification.md) | Property that links a model configuration to the input types expected by it. | [optional] diff --git a/docs/endpoints/DataTransformationSetupApi.md b/docs/endpoints/DataTransformationSetupApi.md index 7cf0f92..84dafce 100644 --- a/docs/endpoints/DataTransformationSetupApi.md +++ b/docs/endpoints/DataTransformationSetupApi.md @@ -1,6 +1,6 @@ # modelcatalog.DataTransformationSetupApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.DataTransformationSetupApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the DataTransformationSetup to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.DataTransformationSetupApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the DataTransformationSetup to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.DataTransformationSetupApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/DatasetSpecification.md b/docs/endpoints/DatasetSpecification.md index fb388c1..0b907b5 100644 --- a/docs/endpoints/DatasetSpecification.md +++ b/docs/endpoints/DatasetSpecification.md @@ -13,6 +13,7 @@ Name | Type | Description | Notes **label** | **list[str]** | short description of the resource | [optional] **type** | **list[str]** | type of the resource | [optional] **has_fixed_resource** | [**list[SampleResource]**](SampleResource.md) | Property that links a parameter or an input to a fixed value. For example, in a given configuration a parameter with the planting date for a model could be fixed to avoid the user changing it for that region. | [optional] +**is_transformed_from** | [**list[DatasetSpecification]**](DatasetSpecification.md) | Property that links a dataset specification from a model configuration or setup to the output from a target data transformation. This occurs when a data transformation produces several outputs, but only one of them is the one needed for a model | [optional] **has_data_transformation_setup** | [**list[DataTransformationSetup]**](DataTransformationSetup.md) | Property to link an input/output dataset to the specific data transformation (with URLs | [optional] **position** | **list[int]** | Position of the parameter or input/output in the model configuration. This property is needed to know how to organize the I/O of the component on execution | [optional] **id** | **str** | identifier | [optional] diff --git a/docs/endpoints/DatasetSpecificationApi.md b/docs/endpoints/DatasetSpecificationApi.md index 45cf797..ba41bd3 100644 --- a/docs/endpoints/DatasetSpecificationApi.md +++ b/docs/endpoints/DatasetSpecificationApi.md @@ -1,6 +1,6 @@ # modelcatalog.DatasetSpecificationApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.DatasetSpecificationApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the DatasetSpecification to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.DatasetSpecificationApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the DatasetSpecification to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.DatasetSpecificationApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/DefaultApi.md b/docs/endpoints/DefaultApi.md index f28dbb7..fb77798 100644 --- a/docs/endpoints/DefaultApi.md +++ b/docs/endpoints/DefaultApi.md @@ -1,6 +1,6 @@ # modelcatalog.DefaultApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- diff --git a/docs/endpoints/EmpiricalModel.md b/docs/endpoints/EmpiricalModel.md index 7ea5239..538be1f 100644 --- a/docs/endpoints/EmpiricalModel.md +++ b/docs/endpoints/EmpiricalModel.md @@ -12,13 +12,13 @@ Name | Type | Description | Notes **type** | **list[str]** | type of the resource | [optional] **has_installation_instructions** | **list[str]** | Description not available | [optional] **compatible_visualization_software** | [**list[Software]**](Software.md) | Description not available | [optional] -**copyright_holder** | **list[object]** | Description not available | [optional] +**copyright_holder** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Description not available | [optional] **has_faq** | **list[str]** | Description not available | [optional] **logo** | [**list[Image]**](Image.md) | Description not available | [optional] -**has_contact_person** | **list[object]** | Description not available | [optional] +**has_contact_person** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Description not available | [optional] **id** | **str** | identifier | [optional] **identifier** | **list[str]** | Description not available | [optional] -**author** | **list[object]** | Description not available | [optional] +**author** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Description not available | [optional] **has_build_file** | **list[str]** | Description not available | [optional] **short_description** | **list[str]** | Description not available | [optional] **date_published** | **list[datetime]** | Description not available | [optional] @@ -26,7 +26,7 @@ Name | Type | Description | Notes **has_source_code** | [**list[SourceCode]**](SourceCode.md) | Description not available | [optional] **has_explanation_diagram** | [**list[Image]**](Image.md) | Diagram used to explain the behavior of the model | [optional] **has_example** | **list[str]** | Description not available | [optional] -**publisher** | **list[object]** | Description not available | [optional] +**publisher** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Description not available | [optional] **doi** | **list[str]** | Description not available | [optional] **has_funding** | [**list[FundingInformation]**](FundingInformation.md) | Description not available | [optional] **support_details** | **list[str]** | Description not available | [optional] @@ -35,7 +35,7 @@ Name | Type | Description | Notes **description** | **list[str]** | small description | [optional] **reference_publication** | **list[str]** | Description not available | [optional] **screenshot** | [**list[Image]**](Image.md) | Description not available | [optional] -**has_model_category** | **list[str]** | Category associated with a model (e.g., Hydrology) | [optional] +**has_model_category** | [**list[ModelCategory]**](ModelCategory.md) | Category associated with a model (e.g., Hydrology, etc.) | [optional] **had_primary_source** | **list[object]** | Description not available | [optional] **issue_tracker** | **list[str]** | Description not available | [optional] **date_created** | **list[datetime]** | Description not available | [optional] diff --git a/docs/endpoints/EmpiricalModelApi.md b/docs/endpoints/EmpiricalModelApi.md index 4acbad3..1e40e23 100644 --- a/docs/endpoints/EmpiricalModelApi.md +++ b/docs/endpoints/EmpiricalModelApi.md @@ -1,6 +1,6 @@ # modelcatalog.EmpiricalModelApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.EmpiricalModelApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the EmpiricalModel to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.EmpiricalModelApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the EmpiricalModel to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.EmpiricalModelApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/Emulator.md b/docs/endpoints/Emulator.md index bad9989..ad090a8 100644 --- a/docs/endpoints/Emulator.md +++ b/docs/endpoints/Emulator.md @@ -12,13 +12,13 @@ Name | Type | Description | Notes **type** | **list[str]** | type of the resource | [optional] **has_installation_instructions** | **list[str]** | Description not available | [optional] **compatible_visualization_software** | [**list[Software]**](Software.md) | Description not available | [optional] -**copyright_holder** | **list[object]** | Description not available | [optional] +**copyright_holder** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Description not available | [optional] **has_faq** | **list[str]** | Description not available | [optional] **logo** | [**list[Image]**](Image.md) | Description not available | [optional] -**has_contact_person** | **list[object]** | Description not available | [optional] +**has_contact_person** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Description not available | [optional] **id** | **str** | identifier | [optional] **identifier** | **list[str]** | Description not available | [optional] -**author** | **list[object]** | Description not available | [optional] +**author** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Description not available | [optional] **has_build_file** | **list[str]** | Description not available | [optional] **short_description** | **list[str]** | Description not available | [optional] **date_published** | **list[datetime]** | Description not available | [optional] @@ -26,7 +26,7 @@ Name | Type | Description | Notes **has_source_code** | [**list[SourceCode]**](SourceCode.md) | Description not available | [optional] **has_explanation_diagram** | [**list[Image]**](Image.md) | Diagram used to explain the behavior of the model | [optional] **has_example** | **list[str]** | Description not available | [optional] -**publisher** | **list[object]** | Description not available | [optional] +**publisher** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Description not available | [optional] **doi** | **list[str]** | Description not available | [optional] **has_funding** | [**list[FundingInformation]**](FundingInformation.md) | Description not available | [optional] **support_details** | **list[str]** | Description not available | [optional] @@ -35,7 +35,7 @@ Name | Type | Description | Notes **description** | **list[str]** | small description | [optional] **reference_publication** | **list[str]** | Description not available | [optional] **screenshot** | [**list[Image]**](Image.md) | Description not available | [optional] -**has_model_category** | **list[str]** | Category associated with a model (e.g., Hydrology) | [optional] +**has_model_category** | [**list[ModelCategory]**](ModelCategory.md) | Category associated with a model (e.g., Hydrology, etc.) | [optional] **had_primary_source** | **list[object]** | Description not available | [optional] **issue_tracker** | **list[str]** | Description not available | [optional] **date_created** | **list[datetime]** | Description not available | [optional] diff --git a/docs/endpoints/EmulatorApi.md b/docs/endpoints/EmulatorApi.md index 5275dfb..58443d4 100644 --- a/docs/endpoints/EmulatorApi.md +++ b/docs/endpoints/EmulatorApi.md @@ -1,6 +1,6 @@ # modelcatalog.EmulatorApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.EmulatorApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the Emulator to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.EmulatorApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the Emulator to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.EmulatorApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/EquationApi.md b/docs/endpoints/EquationApi.md index 4a58242..99f4430 100644 --- a/docs/endpoints/EquationApi.md +++ b/docs/endpoints/EquationApi.md @@ -1,6 +1,6 @@ # modelcatalog.EquationApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.EquationApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the Equation to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.EquationApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the Equation to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.EquationApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/FundingInformation.md b/docs/endpoints/FundingInformation.md index 1b7323d..a8f0db0 100644 --- a/docs/endpoints/FundingInformation.md +++ b/docs/endpoints/FundingInformation.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes **description** | **list[str]** | small description | [optional] **id** | **str** | identifier | [optional] **label** | **list[str]** | short description of the resource | [optional] -**funding_source** | [**list[Organization]**](Organization.md) | Description not available | [optional] +**funding_source** | [**list[Organization]**](Organization.md) | Link to the organization funding a software component | [optional] **type** | **list[str]** | type of the resource | [optional] **funding_grant** | **list[str]** | Grant number used for funding | [optional] diff --git a/docs/endpoints/FundingInformationApi.md b/docs/endpoints/FundingInformationApi.md index ed5ff8f..86edddb 100644 --- a/docs/endpoints/FundingInformationApi.md +++ b/docs/endpoints/FundingInformationApi.md @@ -1,6 +1,6 @@ # modelcatalog.FundingInformationApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.FundingInformationApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the FundingInformation to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.FundingInformationApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the FundingInformation to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.FundingInformationApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/GeoCoordinatesApi.md b/docs/endpoints/GeoCoordinatesApi.md index 281e6c2..eb13ce2 100644 --- a/docs/endpoints/GeoCoordinatesApi.md +++ b/docs/endpoints/GeoCoordinatesApi.md @@ -1,6 +1,6 @@ # modelcatalog.GeoCoordinatesApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.GeoCoordinatesApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the GeoCoordinates to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.GeoCoordinatesApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the GeoCoordinates to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.GeoCoordinatesApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/GeoShapeApi.md b/docs/endpoints/GeoShapeApi.md index 21e0acc..f29752d 100644 --- a/docs/endpoints/GeoShapeApi.md +++ b/docs/endpoints/GeoShapeApi.md @@ -1,6 +1,6 @@ # modelcatalog.GeoShapeApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.GeoShapeApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the GeoShape to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.GeoShapeApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the GeoShape to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.GeoShapeApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/Grid.md b/docs/endpoints/Grid.md index eac4981..9dbb721 100644 --- a/docs/endpoints/Grid.md +++ b/docs/endpoints/Grid.md @@ -15,6 +15,7 @@ Name | Type | Description | Notes **has_fixed_resource** | [**list[SampleResource]**](SampleResource.md) | Description not available | [optional] **has_coordinate_system** | **list[str]** | Coordinate system used in a grid | [optional] **has_spatial_resolution** | **list[str]** | Spatial resolution of a grid (e.g., 50m) | [optional] +**is_transformed_from** | [**list[DatasetSpecification]**](DatasetSpecification.md) | Description not available | [optional] **has_shape** | **list[str]** | Grids may be: rectangular, triangular, hexagonal, hybrid, unstructured, block structure, etc. | [optional] **has_dimension** | **list[str]** | Dimension of the grid (2D, 3D) | [optional] **has_data_transformation_setup** | [**list[DataTransformationSetup]**](DataTransformationSetup.md) | Description not available | [optional] diff --git a/docs/endpoints/GridApi.md b/docs/endpoints/GridApi.md index 10efe0d..f9424be 100644 --- a/docs/endpoints/GridApi.md +++ b/docs/endpoints/GridApi.md @@ -1,6 +1,6 @@ # modelcatalog.GridApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.GridApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the Grid to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.GridApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the Grid to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.GridApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/HybridModel.md b/docs/endpoints/HybridModel.md index 5f89e79..cd438ff 100644 --- a/docs/endpoints/HybridModel.md +++ b/docs/endpoints/HybridModel.md @@ -12,13 +12,13 @@ Name | Type | Description | Notes **type** | **list[str]** | type of the resource | [optional] **has_installation_instructions** | **list[str]** | Description not available | [optional] **compatible_visualization_software** | [**list[Software]**](Software.md) | Description not available | [optional] -**copyright_holder** | **list[object]** | Description not available | [optional] +**copyright_holder** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Description not available | [optional] **has_faq** | **list[str]** | Description not available | [optional] **logo** | [**list[Image]**](Image.md) | Description not available | [optional] -**has_contact_person** | **list[object]** | Description not available | [optional] +**has_contact_person** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Description not available | [optional] **id** | **str** | identifier | [optional] **identifier** | **list[str]** | Description not available | [optional] -**author** | **list[object]** | Description not available | [optional] +**author** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Description not available | [optional] **has_build_file** | **list[str]** | Description not available | [optional] **short_description** | **list[str]** | Description not available | [optional] **date_published** | **list[datetime]** | Description not available | [optional] @@ -26,7 +26,7 @@ Name | Type | Description | Notes **has_source_code** | [**list[SourceCode]**](SourceCode.md) | Description not available | [optional] **has_explanation_diagram** | [**list[Image]**](Image.md) | Diagram used to explain the behavior of the model | [optional] **has_example** | **list[str]** | Description not available | [optional] -**publisher** | **list[object]** | Description not available | [optional] +**publisher** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Description not available | [optional] **doi** | **list[str]** | Description not available | [optional] **has_funding** | [**list[FundingInformation]**](FundingInformation.md) | Description not available | [optional] **support_details** | **list[str]** | Description not available | [optional] @@ -35,7 +35,7 @@ Name | Type | Description | Notes **description** | **list[str]** | small description | [optional] **reference_publication** | **list[str]** | Description not available | [optional] **screenshot** | [**list[Image]**](Image.md) | Description not available | [optional] -**has_model_category** | **list[str]** | Category associated with a model (e.g., Hydrology) | [optional] +**has_model_category** | [**list[ModelCategory]**](ModelCategory.md) | Category associated with a model (e.g., Hydrology, etc.) | [optional] **had_primary_source** | **list[object]** | Description not available | [optional] **issue_tracker** | **list[str]** | Description not available | [optional] **date_created** | **list[datetime]** | Description not available | [optional] diff --git a/docs/endpoints/HybridModelApi.md b/docs/endpoints/HybridModelApi.md index 336ff81..43e60f2 100644 --- a/docs/endpoints/HybridModelApi.md +++ b/docs/endpoints/HybridModelApi.md @@ -1,6 +1,6 @@ # modelcatalog.HybridModelApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.HybridModelApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the HybridModel to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.HybridModelApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the HybridModel to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.HybridModelApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/Image.md b/docs/endpoints/Image.md index 28b0c3f..c92b3d0 100644 --- a/docs/endpoints/Image.md +++ b/docs/endpoints/Image.md @@ -13,11 +13,12 @@ Name | Type | Description | Notes **label** | **list[str]** | short description of the resource | [optional] **type** | **list[str]** | type of the resource | [optional] **has_fixed_resource** | [**list[SampleResource]**](SampleResource.md) | Property that links a parameter or an input to a fixed value. For example, in a given configuration a parameter with the planting date for a model could be fixed to avoid the user changing it for that region. | [optional] -**had_primary_source** | **list[object]** | had primary source | [optional] +**is_transformed_from** | [**list[DatasetSpecification]**](DatasetSpecification.md) | Property that links a dataset specification from a model configuration or setup to the output from a target data transformation. This occurs when a data transformation produces several outputs, but only one of them is the one needed for a model | [optional] +**had_primary_source** | **list[object]** | Property to identify the original source of the information of the annotated resource. It could be a web page, an organization, a person, some experiment notes, etc. | [optional] **has_data_transformation_setup** | [**list[DataTransformationSetup]**](DataTransformationSetup.md) | Property to link an input/output dataset to the specific data transformation (with URLs | [optional] **position** | **list[int]** | Position of the parameter or input/output in the model configuration. This property is needed to know how to organize the I/O of the component on execution | [optional] **id** | **str** | identifier | [optional] -**value** | **list[object]** | Value associated to the described entity | [optional] +**value** | [**list[AnyOfURIbooleanDateTimefloatintegerstring]**](AnyOfURIbooleanDateTimefloatintegerstring.md) | Value associated to the described entity | [optional] [[Back to Model list]](../#documentation-for-models) [[Back to API list]](../#documentation-for-api-endpoints) [[Back to README]](../) diff --git a/docs/endpoints/ImageApi.md b/docs/endpoints/ImageApi.md index f373ee5..1896385 100644 --- a/docs/endpoints/ImageApi.md +++ b/docs/endpoints/ImageApi.md @@ -1,6 +1,6 @@ # modelcatalog.ImageApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.ImageApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the Image to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.ImageApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the Image to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.ImageApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/InterventionApi.md b/docs/endpoints/InterventionApi.md index c5f2b68..c53c203 100644 --- a/docs/endpoints/InterventionApi.md +++ b/docs/endpoints/InterventionApi.md @@ -1,6 +1,6 @@ # modelcatalog.InterventionApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.InterventionApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the Intervention to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.InterventionApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the Intervention to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.InterventionApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/Model.md b/docs/endpoints/Model.md index f4b315f..74bac22 100644 --- a/docs/endpoints/Model.md +++ b/docs/endpoints/Model.md @@ -12,13 +12,13 @@ Name | Type | Description | Notes **type** | **list[str]** | type of the resource | [optional] **has_installation_instructions** | **list[str]** | Description not available | [optional] **compatible_visualization_software** | [**list[Software]**](Software.md) | Description not available | [optional] -**copyright_holder** | **list[object]** | Description not available | [optional] +**copyright_holder** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Description not available | [optional] **has_faq** | **list[str]** | Description not available | [optional] **logo** | [**list[Image]**](Image.md) | Description not available | [optional] -**has_contact_person** | **list[object]** | Description not available | [optional] +**has_contact_person** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Description not available | [optional] **id** | **str** | identifier | [optional] **identifier** | **list[str]** | Description not available | [optional] -**author** | **list[object]** | Description not available | [optional] +**author** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Description not available | [optional] **has_build_file** | **list[str]** | Description not available | [optional] **short_description** | **list[str]** | Description not available | [optional] **date_published** | **list[datetime]** | Description not available | [optional] @@ -26,7 +26,7 @@ Name | Type | Description | Notes **has_source_code** | [**list[SourceCode]**](SourceCode.md) | Description not available | [optional] **has_explanation_diagram** | [**list[Image]**](Image.md) | Diagram used to explain the behavior of the model | [optional] **has_example** | **list[str]** | Description not available | [optional] -**publisher** | **list[object]** | Description not available | [optional] +**publisher** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Description not available | [optional] **doi** | **list[str]** | Description not available | [optional] **has_funding** | [**list[FundingInformation]**](FundingInformation.md) | Description not available | [optional] **support_details** | **list[str]** | Description not available | [optional] @@ -35,7 +35,7 @@ Name | Type | Description | Notes **description** | **list[str]** | small description | [optional] **reference_publication** | **list[str]** | Description not available | [optional] **screenshot** | [**list[Image]**](Image.md) | Description not available | [optional] -**has_model_category** | **list[str]** | Category associated with a model (e.g., Hydrology) | [optional] +**has_model_category** | [**list[ModelCategory]**](ModelCategory.md) | Category associated with a model (e.g., Hydrology, etc.) | [optional] **had_primary_source** | **list[object]** | Description not available | [optional] **issue_tracker** | **list[str]** | Description not available | [optional] **date_created** | **list[datetime]** | Description not available | [optional] diff --git a/docs/endpoints/ModelApi.md b/docs/endpoints/ModelApi.md index 0e8aa2d..8164404 100644 --- a/docs/endpoints/ModelApi.md +++ b/docs/endpoints/ModelApi.md @@ -1,6 +1,6 @@ # modelcatalog.ModelApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -386,8 +386,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.ModelApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the Model to be retrieved @@ -504,8 +504,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.ModelApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the Model to be retrieved @@ -569,8 +569,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.ModelApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/ModelCategory.md b/docs/endpoints/ModelCategory.md new file mode 100644 index 0000000..f46563b --- /dev/null +++ b/docs/endpoints/ModelCategory.md @@ -0,0 +1,13 @@ +# ModelCategory + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **list[str]** | small description | [optional] +**id** | **str** | identifier | [optional] +**label** | **list[str]** | short description of the resource | [optional] +**type** | **list[str]** | type of the resource | [optional] + +[[Back to Model list]](../#documentation-for-models) [[Back to API list]](../#documentation-for-api-endpoints) [[Back to README]](../) + + diff --git a/docs/endpoints/ModelCategoryApi.md b/docs/endpoints/ModelCategoryApi.md new file mode 100644 index 0000000..1e3decb --- /dev/null +++ b/docs/endpoints/ModelCategoryApi.md @@ -0,0 +1,318 @@ +# modelcatalog.ModelCategoryApi + +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**modelcategorys_get**](ModelCategoryApi.md#modelcategorys_get) | **GET** /modelcategorys | List all instances of ModelCategory +[**modelcategorys_id_delete**](ModelCategoryApi.md#modelcategorys_id_delete) | **DELETE** /modelcategorys/{id} | Delete an existing ModelCategory +[**modelcategorys_id_get**](ModelCategoryApi.md#modelcategorys_id_get) | **GET** /modelcategorys/{id} | Get a single ModelCategory by its id +[**modelcategorys_id_put**](ModelCategoryApi.md#modelcategorys_id_put) | **PUT** /modelcategorys/{id} | Update an existing ModelCategory +[**modelcategorys_post**](ModelCategoryApi.md#modelcategorys_post) | **POST** /modelcategorys | Create one ModelCategory + + +# **modelcategorys_get** +> list[ModelCategory] modelcategorys_get(username=username, label=label, page=page, per_page=per_page) + +List all instances of ModelCategory + +Gets a list of all instances of ModelCategory (more information in https://w3id.org/okn/o/sdm#ModelCategory) + +### Example + +```python +from __future__ import print_function +import time +import modelcatalog +from modelcatalog.rest import ApiException +from pprint import pprint + +# Create an instance of the API class +api_instance = modelcatalog.ModelCategoryApi() +username = 'username_example' # str | Name of the user graph to query (optional) +label = 'label_example' # str | Filter by label (optional) +page = 1 # int | Page number (optional) (default to 1) +per_page = 100 # int | Items per page (optional) (default to 100) + +try: + # List all instances of ModelCategory + api_response = api_instance.modelcategorys_get(username=username, label=label, page=page, per_page=per_page) + pprint(api_response) +except ApiException as e: + print("Exception when calling ModelCategoryApi->modelcategorys_get: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **username** | **str**| Name of the user graph to query | [optional] + **label** | **str**| Filter by label | [optional] + **page** | **int**| Page number | [optional] [default to 1] + **per_page** | **int**| Items per page | [optional] [default to 100] + +### Return type + +[**list[ModelCategory]**](ModelCategory.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successful response - returns an array with the instances of ModelCategory. | - | + +[[Back to top]](#) [[Back to API list]](../#documentation-for-api-endpoints) [[Back to Model list]](../#documentation-for-models) [[Back to README]](../) + +# **modelcategorys_id_delete** +> modelcategorys_id_delete(id, user) + +Delete an existing ModelCategory + +Delete an existing ModelCategory (more information in https://w3id.org/okn/o/sdm#ModelCategory) + +### Example + +* Bearer (JWT) Authentication (BearerAuth): +```python +from __future__ import print_function +import time +import modelcatalog +from modelcatalog.rest import ApiException +from pprint import pprint +configuration = modelcatalog.Configuration() +# Configure Bearer authorization (JWT): BearerAuth +configuration.access_token = 'YOUR_BEARER_TOKEN' + +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" +# Create an instance of the API class +api_instance = modelcatalog.ModelCategoryApi(modelcatalog.ApiClient(configuration)) +id = 'id_example' # str | The ID of the ModelCategory to be retrieved +user = 'user_example' # str | Username + +try: + # Delete an existing ModelCategory + api_instance.modelcategorys_id_delete(id, user) +except ApiException as e: + print("Exception when calling ModelCategoryApi->modelcategorys_id_delete: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| The ID of the ModelCategory to be retrieved | + **user** | **str**| Username | + +### Return type + +void (empty response body) + +### Authorization + +[BearerAuth](../#BearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**202** | Deleted | - | +**404** | Not Found | - | + +[[Back to top]](#) [[Back to API list]](../#documentation-for-api-endpoints) [[Back to Model list]](../#documentation-for-models) [[Back to README]](../) + +# **modelcategorys_id_get** +> ModelCategory modelcategorys_id_get(id, username=username) + +Get a single ModelCategory by its id + +Gets the details of a given ModelCategory (more information in https://w3id.org/okn/o/sdm#ModelCategory) + +### Example + +```python +from __future__ import print_function +import time +import modelcatalog +from modelcatalog.rest import ApiException +from pprint import pprint + +# Create an instance of the API class +api_instance = modelcatalog.ModelCategoryApi() +id = 'id_example' # str | The ID of the ModelCategory to be retrieved +username = 'username_example' # str | Name of the user graph to query (optional) + +try: + # Get a single ModelCategory by its id + api_response = api_instance.modelcategorys_id_get(id, username=username) + pprint(api_response) +except ApiException as e: + print("Exception when calling ModelCategoryApi->modelcategorys_id_get: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| The ID of the ModelCategory to be retrieved | + **username** | **str**| Name of the user graph to query | [optional] + +### Return type + +[**ModelCategory**](ModelCategory.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Gets the details of a given ModelCategory | - | + +[[Back to top]](#) [[Back to API list]](../#documentation-for-api-endpoints) [[Back to Model list]](../#documentation-for-models) [[Back to README]](../) + +# **modelcategorys_id_put** +> ModelCategory modelcategorys_id_put(id, user, model_category=model_category) + +Update an existing ModelCategory + +Updates an existing ModelCategory (more information in https://w3id.org/okn/o/sdm#ModelCategory) + +### Example + +* Bearer (JWT) Authentication (BearerAuth): +```python +from __future__ import print_function +import time +import modelcatalog +from modelcatalog.rest import ApiException +from pprint import pprint +configuration = modelcatalog.Configuration() +# Configure Bearer authorization (JWT): BearerAuth +configuration.access_token = 'YOUR_BEARER_TOKEN' + +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" +# Create an instance of the API class +api_instance = modelcatalog.ModelCategoryApi(modelcatalog.ApiClient(configuration)) +id = 'id_example' # str | The ID of the ModelCategory to be retrieved +user = 'user_example' # str | Username +model_category = modelcatalog.ModelCategory() # ModelCategory | An old ModelCategoryto be updated (optional) + +try: + # Update an existing ModelCategory + api_response = api_instance.modelcategorys_id_put(id, user, model_category=model_category) + pprint(api_response) +except ApiException as e: + print("Exception when calling ModelCategoryApi->modelcategorys_id_put: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| The ID of the ModelCategory to be retrieved | + **user** | **str**| Username | + **model_category** | [**ModelCategory**](ModelCategory.md)| An old ModelCategoryto be updated | [optional] + +### Return type + +[**ModelCategory**](ModelCategory.md) + +### Authorization + +[BearerAuth](../#BearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Updated | - | +**404** | Not Found | - | + +[[Back to top]](#) [[Back to API list]](../#documentation-for-api-endpoints) [[Back to Model list]](../#documentation-for-models) [[Back to README]](../) + +# **modelcategorys_post** +> ModelCategory modelcategorys_post(user, model_category=model_category) + +Create one ModelCategory + +Create a new instance of ModelCategory (more information in https://w3id.org/okn/o/sdm#ModelCategory) + +### Example + +* Bearer (JWT) Authentication (BearerAuth): +```python +from __future__ import print_function +import time +import modelcatalog +from modelcatalog.rest import ApiException +from pprint import pprint +configuration = modelcatalog.Configuration() +# Configure Bearer authorization (JWT): BearerAuth +configuration.access_token = 'YOUR_BEARER_TOKEN' + +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" +# Create an instance of the API class +api_instance = modelcatalog.ModelCategoryApi(modelcatalog.ApiClient(configuration)) +user = 'user_example' # str | Username +model_category = modelcatalog.ModelCategory() # ModelCategory | Information about the ModelCategoryto be created (optional) + +try: + # Create one ModelCategory + api_response = api_instance.modelcategorys_post(user, model_category=model_category) + pprint(api_response) +except ApiException as e: + print("Exception when calling ModelCategoryApi->modelcategorys_post: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user** | **str**| Username | + **model_category** | [**ModelCategory**](ModelCategory.md)| Information about the ModelCategoryto be created | [optional] + +### Return type + +[**ModelCategory**](ModelCategory.md) + +### Authorization + +[BearerAuth](../#BearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Created | - | + +[[Back to top]](#) [[Back to API list]](../#documentation-for-api-endpoints) [[Back to Model list]](../#documentation-for-models) [[Back to README]](../) + diff --git a/docs/endpoints/ModelConfiguration.md b/docs/endpoints/ModelConfiguration.md index d83e8dd..2109fb0 100644 --- a/docs/endpoints/ModelConfiguration.md +++ b/docs/endpoints/ModelConfiguration.md @@ -13,17 +13,17 @@ Name | Type | Description | Notes **type** | **list[str]** | type of the resource | [optional] **has_installation_instructions** | **list[str]** | Description not available | [optional] **compatible_visualization_software** | [**list[Software]**](Software.md) | Description not available | [optional] -**copyright_holder** | **list[object]** | Description not available | [optional] +**copyright_holder** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Description not available | [optional] **has_region** | [**list[Region]**](Region.md) | Property linking a region to a model configuration/calibration. This property implies that the described model configuration is prepared to execute in that target region | [optional] **has_faq** | **list[str]** | Description not available | [optional] **logo** | [**list[Image]**](Image.md) | Description not available | [optional] -**has_contact_person** | **list[object]** | Description not available | [optional] +**has_contact_person** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Description not available | [optional] **tag** | **list[str]** | Description not available | [optional] **id** | **str** | identifier | [optional] **identifier** | **list[str]** | Description not available | [optional] **has_sample_execution** | [**list[SampleExecution]**](SampleExecution.md) | Description not available | [optional] **has_sample_result** | [**list[SampleResource]**](SampleResource.md) | Description not available | [optional] -**author** | **list[object]** | Description not available | [optional] +**author** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Description not available | [optional] **has_constraint** | **list[str]** | Description not available | [optional] **has_build_file** | **list[str]** | Description not available | [optional] **short_description** | **list[str]** | Description not available | [optional] @@ -34,7 +34,7 @@ Name | Type | Description | Notes **has_setup** | [**list[ConfigurationSetup]**](ConfigurationSetup.md) | Description not available | [optional] **has_explanation_diagram** | [**list[Image]**](Image.md) | Diagram used to explain the behavior of the model | [optional] **has_example** | **list[str]** | Description not available | [optional] -**publisher** | **list[object]** | Description not available | [optional] +**publisher** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Description not available | [optional] **has_output** | [**list[DatasetSpecification]**](DatasetSpecification.md) | Description not available | [optional] **has_output_time_interval** | [**list[TimeInterval]**](TimeInterval.md) | Time interval used in the model configuration | [optional] **doi** | **list[str]** | Description not available | [optional] @@ -47,7 +47,7 @@ Name | Type | Description | Notes **description** | **list[str]** | small description | [optional] **reference_publication** | **list[str]** | Description not available | [optional] **screenshot** | [**list[Image]**](Image.md) | Description not available | [optional] -**has_model_category** | **list[str]** | Category associated with a model (e.g., Hydrology) | [optional] +**has_model_category** | [**list[ModelCategory]**](ModelCategory.md) | Category associated with a model (e.g., Hydrology, etc.) | [optional] **had_primary_source** | **list[object]** | Description not available | [optional] **issue_tracker** | **list[str]** | Description not available | [optional] **has_software_image** | [**list[SoftwareImage]**](SoftwareImage.md) | Description not available | [optional] diff --git a/docs/endpoints/ModelConfigurationApi.md b/docs/endpoints/ModelConfigurationApi.md index 2a4b18d..0b96ea7 100644 --- a/docs/endpoints/ModelConfigurationApi.md +++ b/docs/endpoints/ModelConfigurationApi.md @@ -1,6 +1,6 @@ # modelcatalog.ModelConfigurationApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -150,8 +150,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.ModelConfigurationApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the ModelConfiguration to be retrieved @@ -268,8 +268,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.ModelConfigurationApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the ModelConfiguration to be retrieved @@ -333,8 +333,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.ModelConfigurationApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/ModelConfigurationSetup.md b/docs/endpoints/ModelConfigurationSetup.md index 941ec64..f985fd5 100644 --- a/docs/endpoints/ModelConfigurationSetup.md +++ b/docs/endpoints/ModelConfigurationSetup.md @@ -14,18 +14,19 @@ Name | Type | Description | Notes **calibrated_variable** | [**list[VariablePresentation]**](VariablePresentation.md) | Variable that was calibrated in this particular model configuration calibration | [optional] **has_installation_instructions** | **list[str]** | Description not available | [optional] **compatible_visualization_software** | [**list[Software]**](Software.md) | Description not available | [optional] -**copyright_holder** | **list[object]** | Description not available | [optional] +**copyright_holder** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Description not available | [optional] **calibration_method** | **list[str]** | Calibration method used for a particular model configuration or setup | [optional] **has_region** | [**list[Region]**](Region.md) | Property linking a region to a model configuration/calibration. This property implies that the described model configuration is prepared to execute in that target region | [optional] **has_faq** | **list[str]** | Description not available | [optional] **logo** | [**list[Image]**](Image.md) | Description not available | [optional] -**has_contact_person** | **list[object]** | Description not available | [optional] +**has_contact_person** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Description not available | [optional] **tag** | **list[str]** | Description not available | [optional] **id** | **str** | identifier | [optional] **identifier** | **list[str]** | Description not available | [optional] **has_sample_execution** | [**list[SampleExecution]**](SampleExecution.md) | Description not available | [optional] **has_sample_result** | [**list[SampleResource]**](SampleResource.md) | Description not available | [optional] -**author** | **list[object]** | Description not available | [optional] +**author** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Description not available | [optional] +**was_derived_from_setup** | [**list[ConfigurationSetup]**](ConfigurationSetup.md) | Description not available | [optional] **has_constraint** | **list[str]** | Description not available | [optional] **has_build_file** | **list[str]** | Description not available | [optional] **short_description** | **list[str]** | Description not available | [optional] @@ -37,9 +38,10 @@ Name | Type | Description | Notes **has_explanation_diagram** | [**list[Image]**](Image.md) | Diagram used to explain the behavior of the model | [optional] **has_example** | **list[str]** | Description not available | [optional] **calibration_interval** | **list[str]** | Property that represents the temporal interval used to calibrate a model | [optional] -**publisher** | **list[object]** | Description not available | [optional] +**publisher** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Description not available | [optional] **has_output** | [**list[DatasetSpecification]**](DatasetSpecification.md) | Description not available | [optional] **has_output_time_interval** | [**list[TimeInterval]**](TimeInterval.md) | Time interval used in the model configuration | [optional] +**status** | **list[str]** | Description not available | [optional] **doi** | **list[str]** | Description not available | [optional] **parameter_assignment_method** | **list[str]** | Property that indicates how have the parameters assigned in a model configuration (e.g., using an expert guess, by using calibration, etc.) | [optional] **has_funding** | [**list[FundingInformation]**](FundingInformation.md) | Description not available | [optional] @@ -51,7 +53,7 @@ Name | Type | Description | Notes **description** | **list[str]** | small description | [optional] **reference_publication** | **list[str]** | Description not available | [optional] **screenshot** | [**list[Image]**](Image.md) | Description not available | [optional] -**has_model_category** | **list[str]** | Category associated with a model (e.g., Hydrology) | [optional] +**has_model_category** | [**list[ModelCategory]**](ModelCategory.md) | Category associated with a model (e.g., Hydrology, etc.) | [optional] **had_primary_source** | **list[object]** | Description not available | [optional] **issue_tracker** | **list[str]** | Description not available | [optional] **has_software_image** | [**list[SoftwareImage]**](SoftwareImage.md) | Description not available | [optional] diff --git a/docs/endpoints/ModelConfigurationSetupApi.md b/docs/endpoints/ModelConfigurationSetupApi.md index 0186c4c..c7d0d6b 100644 --- a/docs/endpoints/ModelConfigurationSetupApi.md +++ b/docs/endpoints/ModelConfigurationSetupApi.md @@ -1,6 +1,6 @@ # modelcatalog.ModelConfigurationSetupApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.ModelConfigurationSetupApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the ModelConfigurationSetup to be retrieved @@ -327,8 +327,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.ModelConfigurationSetupApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the ModelConfigurationSetup to be retrieved @@ -392,8 +392,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.ModelConfigurationSetupApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/NumericalIndexApi.md b/docs/endpoints/NumericalIndexApi.md index 96f94b6..032945d 100644 --- a/docs/endpoints/NumericalIndexApi.md +++ b/docs/endpoints/NumericalIndexApi.md @@ -1,6 +1,6 @@ # modelcatalog.NumericalIndexApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.NumericalIndexApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the NumericalIndex to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.NumericalIndexApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the NumericalIndex to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.NumericalIndexApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/OrganizationApi.md b/docs/endpoints/OrganizationApi.md index 6bc5c82..eb68b1a 100644 --- a/docs/endpoints/OrganizationApi.md +++ b/docs/endpoints/OrganizationApi.md @@ -1,6 +1,6 @@ # modelcatalog.OrganizationApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.OrganizationApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the Organization to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.OrganizationApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the Organization to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.OrganizationApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/Parameter.md b/docs/endpoints/Parameter.md index 355b2c8..9807d7e 100644 --- a/docs/endpoints/Parameter.md +++ b/docs/endpoints/Parameter.md @@ -3,16 +3,16 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**has_default_value** | **list[object]** | Default accepted value of a variable presentation (or a parameter) | [optional] -**has_maximum_accepted_value** | **list[object]** | Maximum accepted value of a variable presentation (or a parameter) | [optional] +**has_default_value** | [**list[AnyOfURIbooleanDateTimefloatintegerstring]**](AnyOfURIbooleanDateTimefloatintegerstring.md) | Default accepted value of a variable presentation (or a parameter) | [optional] +**has_maximum_accepted_value** | [**list[AnyOfDateTimefloatinteger]**](AnyOfDateTimefloatinteger.md) | Maximum accepted value of a variable presentation (or a parameter) | [optional] **description** | **list[str]** | small description | [optional] **has_data_type** | **list[str]** | Property that indicates the data type of a parameter | [optional] -**has_fixed_value** | **list[object]** | Value of a parameter in a software setup. | [optional] +**has_fixed_value** | [**list[AnyOfURIbooleanDateTimefloatintegerstring]**](AnyOfURIbooleanDateTimefloatintegerstring.md) | Value of a parameter in a software setup. | [optional] **has_presentation** | [**list[VariablePresentation]**](VariablePresentation.md) | Property that links an instance of a dataset (or a dataset specification) to the presentation of a variable contained (or expected to be contained) on it. | [optional] **label** | **list[str]** | short description of the resource | [optional] **recommended_increment** | **list[float]** | Value that represents how a parameter should be incremented on each iteration of a software component execution. This value is important when preparing execution ensembles automatically, e.g., simulating crop production varying the parameter \"fertilizer amount\" in increments of 10%. | [optional] **type** | **list[str]** | type of the resource | [optional] -**has_minimum_accepted_value** | **list[object]** | Minimum accepted value of a variable presentation (or a parameter) | [optional] +**has_minimum_accepted_value** | [**list[AnyOfDateTimefloatinteger]**](AnyOfDateTimefloatinteger.md) | Minimum accepted value of a variable presentation (or a parameter) | [optional] **has_accepted_values** | **list[str]** | Property that constraints which values are accepted for a parameter. For example, the name of a crop can only be \"Maize\" or \"Sorghum\" | [optional] **adjusts_variable** | [**list[Variable]**](Variable.md) | Property that links parameter with the variable they adjust. This property can be used when parameters quantify variables without directly representing them. For example, a \"fertilizer percentage adjustment\" parameter can quantify a \"fertilizer price\" variable | [optional] **relevant_for_intervention** | [**list[Intervention]**](Intervention.md) | Description not available | [optional] diff --git a/docs/endpoints/ParameterApi.md b/docs/endpoints/ParameterApi.md index dfb0088..ff7b615 100644 --- a/docs/endpoints/ParameterApi.md +++ b/docs/endpoints/ParameterApi.md @@ -1,6 +1,6 @@ # modelcatalog.ParameterApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.ParameterApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the Parameter to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.ParameterApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the Parameter to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.ParameterApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/Person.md b/docs/endpoints/Person.md index 3458b8c..de2aa5d 100644 --- a/docs/endpoints/Person.md +++ b/docs/endpoints/Person.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **id** | **str** | identifier | [optional] **label** | **list[str]** | short description of the resource | [optional] **type** | **list[str]** | type of the resource | [optional] -**email** | **list[str]** | Description not available | [optional] +**email** | **list[str]** | Email of a person | [optional] [[Back to Model list]](../#documentation-for-models) [[Back to API list]](../#documentation-for-api-endpoints) [[Back to README]](../) diff --git a/docs/endpoints/PersonApi.md b/docs/endpoints/PersonApi.md index 128a479..d004d8c 100644 --- a/docs/endpoints/PersonApi.md +++ b/docs/endpoints/PersonApi.md @@ -1,6 +1,6 @@ # modelcatalog.PersonApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.PersonApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the Person to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.PersonApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the Person to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.PersonApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/PointBasedGrid.md b/docs/endpoints/PointBasedGrid.md index 489e516..e1a8462 100644 --- a/docs/endpoints/PointBasedGrid.md +++ b/docs/endpoints/PointBasedGrid.md @@ -15,6 +15,7 @@ Name | Type | Description | Notes **has_fixed_resource** | [**list[SampleResource]**](SampleResource.md) | Description not available | [optional] **has_coordinate_system** | **list[str]** | Coordinate system used in a grid | [optional] **has_spatial_resolution** | **list[str]** | Spatial resolution of a grid (e.g., 50m) | [optional] +**is_transformed_from** | [**list[DatasetSpecification]**](DatasetSpecification.md) | Description not available | [optional] **has_shape** | **list[str]** | Grids may be: rectangular, triangular, hexagonal, hybrid, unstructured, block structure, etc. | [optional] **has_dimension** | **list[str]** | Dimension of the grid (2D, 3D) | [optional] **has_data_transformation_setup** | [**list[DataTransformationSetup]**](DataTransformationSetup.md) | Description not available | [optional] diff --git a/docs/endpoints/PointBasedGridApi.md b/docs/endpoints/PointBasedGridApi.md index ea16b39..66d98d0 100644 --- a/docs/endpoints/PointBasedGridApi.md +++ b/docs/endpoints/PointBasedGridApi.md @@ -1,6 +1,6 @@ # modelcatalog.PointBasedGridApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.PointBasedGridApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the PointBasedGrid to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.PointBasedGridApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the PointBasedGrid to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.PointBasedGridApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/ProcessApi.md b/docs/endpoints/ProcessApi.md index 5e5dd08..627f543 100644 --- a/docs/endpoints/ProcessApi.md +++ b/docs/endpoints/ProcessApi.md @@ -1,6 +1,6 @@ # modelcatalog.ProcessApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.ProcessApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the Process to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.ProcessApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the Process to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.ProcessApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/Region.md b/docs/endpoints/Region.md index cb4223f..cab4280 100644 --- a/docs/endpoints/Region.md +++ b/docs/endpoints/Region.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**geo** | **list[object]** | Specific coordinates or shape associated with a region | [optional] +**geo** | [**list[AnyOfGeoCoordinatesGeoShape]**](AnyOfGeoCoordinatesGeoShape.md) | Specific coordinates or shape associated with a region | [optional] **part_of** | [**list[Region]**](Region.md) | Indicates whether a region is part of another region | [optional] **description** | **list[str]** | small description | [optional] **id** | **str** | identifier | [optional] diff --git a/docs/endpoints/RegionApi.md b/docs/endpoints/RegionApi.md index d355ba3..1958c66 100644 --- a/docs/endpoints/RegionApi.md +++ b/docs/endpoints/RegionApi.md @@ -1,6 +1,6 @@ # modelcatalog.RegionApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.RegionApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the Region to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.RegionApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the Region to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.RegionApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/SampleCollection.md b/docs/endpoints/SampleCollection.md index d805163..9e948ab 100644 --- a/docs/endpoints/SampleCollection.md +++ b/docs/endpoints/SampleCollection.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **id** | **str** | identifier | [optional] **label** | **list[str]** | short description of the resource | [optional] **type** | **list[str]** | type of the resource | [optional] -**value** | **list[object]** | Value associated to the described entity | [optional] +**value** | [**list[AnyOfURIbooleanDateTimefloatintegerstring]**](AnyOfURIbooleanDateTimefloatintegerstring.md) | Value associated to the described entity | [optional] [[Back to Model list]](../#documentation-for-models) [[Back to API list]](../#documentation-for-api-endpoints) [[Back to README]](../) diff --git a/docs/endpoints/SampleCollectionApi.md b/docs/endpoints/SampleCollectionApi.md index cf1205f..0f7a6e9 100644 --- a/docs/endpoints/SampleCollectionApi.md +++ b/docs/endpoints/SampleCollectionApi.md @@ -1,6 +1,6 @@ # modelcatalog.SampleCollectionApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.SampleCollectionApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the SampleCollection to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.SampleCollectionApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the SampleCollection to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.SampleCollectionApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/SampleExecutionApi.md b/docs/endpoints/SampleExecutionApi.md index d1dc8ec..3b72f90 100644 --- a/docs/endpoints/SampleExecutionApi.md +++ b/docs/endpoints/SampleExecutionApi.md @@ -1,6 +1,6 @@ # modelcatalog.SampleExecutionApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.SampleExecutionApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the SampleExecution to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.SampleExecutionApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the SampleExecution to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.SampleExecutionApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/SampleResource.md b/docs/endpoints/SampleResource.md index e452188..9b82286 100644 --- a/docs/endpoints/SampleResource.md +++ b/docs/endpoints/SampleResource.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **id** | **str** | identifier | [optional] **label** | **list[str]** | short description of the resource | [optional] **type** | **list[str]** | type of the resource | [optional] -**value** | **list[object]** | Value associated to the described entity | [optional] +**value** | [**list[AnyOfURIbooleanDateTimefloatintegerstring]**](AnyOfURIbooleanDateTimefloatintegerstring.md) | Value associated to the described entity | [optional] [[Back to Model list]](../#documentation-for-models) [[Back to API list]](../#documentation-for-api-endpoints) [[Back to README]](../) diff --git a/docs/endpoints/SampleResourceApi.md b/docs/endpoints/SampleResourceApi.md index b2bf185..9ebfaa9 100644 --- a/docs/endpoints/SampleResourceApi.md +++ b/docs/endpoints/SampleResourceApi.md @@ -1,6 +1,6 @@ # modelcatalog.SampleResourceApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.SampleResourceApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the SampleResource to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.SampleResourceApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the SampleResource to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.SampleResourceApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/Software.md b/docs/endpoints/Software.md index 7c90bdc..c653fcd 100644 --- a/docs/endpoints/Software.md +++ b/docs/endpoints/Software.md @@ -8,47 +8,47 @@ Name | Type | Description | Notes **keywords** | **list[str]** | Keywords associated with a software component | [optional] **has_documentation** | **list[str]** | Pointer to the documentation of the model | [optional] **support_details** | **list[str]** | Property to link details, such as mailing lists in case a contact person is not provided | [optional] -**software_requirements** | **list[str]** | Description not available | [optional] -**has_version** | [**list[SoftwareVersion]**](SoftwareVersion.md) | Description not available | [optional] -**has_typical_data_source** | **list[str]** | Description not available | [optional] +**software_requirements** | **list[str]** | Software requirements needed to install a software component | [optional] +**has_version** | [**list[SoftwareVersion]**](SoftwareVersion.md) | Property designed to link a software component with its corresponding versions | [optional] +**has_typical_data_source** | **list[str]** | Typical data sources that are used by a software component | [optional] **has_download_url** | **list[str]** | Download URL where to obtain the source/executable of the software | [optional] **description** | **list[str]** | small description | [optional] **reference_publication** | **list[str]** | Main publication to cite for this software component | [optional] -**screenshot** | [**list[Image]**](Image.md) | Description not available | [optional] +**screenshot** | [**list[Image]**](Image.md) | Image illustrating a snapshot of the target software | [optional] **type** | **list[str]** | type of the resource | [optional] **has_installation_instructions** | **list[str]** | Instructions required to install this particular piece of software. Installation instructions usually are available in a human-readable manner. | [optional] -**had_primary_source** | **list[object]** | had primary source | [optional] +**had_primary_source** | **list[object]** | Property to identify the original source of the information of the annotated resource. It could be a web page, an organization, a person, some experiment notes, etc. | [optional] **issue_tracker** | **list[str]** | Pointer to the issue tracker of a software component | [optional] -**date_created** | **list[datetime]** | Description not available | [optional] -**contributor** | [**list[Person]**](Person.md) | Description not available | [optional] +**date_created** | **list[datetime]** | Date when a software component was created | [optional] **compatible_visualization_software** | [**list[Software]**](Software.md) | Property that links a software component to other useful software that canbe used to visualize its outputs | [optional] -**copyright_holder** | **list[object]** | Description not available | [optional] +**contributor** | [**list[Person]**](Person.md) | Contributor to a software component | [optional] +**copyright_holder** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Copyright holder for a software component | [optional] **has_faq** | **list[str]** | Frequently asked questions about a software | [optional] -**logo** | [**list[Image]**](Image.md) | Description not available | [optional] -**has_contact_person** | **list[object]** | Description not available | [optional] +**logo** | [**list[Image]**](Image.md) | Property that links to the image used as logo for a software component | [optional] +**has_contact_person** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Contact person responsible for a software component | [optional] **has_purpose** | **list[str]** | Objective or main functionality that can be achieved by running this software | [optional] **id** | **str** | identifier | [optional] **has_executable_instructions** | **list[str]** | Instructions that indicate how a software component should be executed. The difference with `hasExecutionCommand` is that the execution instructions aim to be human-readable, and have explanations between the different commands and instructions | [optional] **has_sample_visualization** | [**list[Visualization]**](Visualization.md) | A typical sample visualization of the softwware outputs | [optional] **identifier** | **list[str]** | Identifier of the resource being described | [optional] -**memory_requirements** | **list[str]** | Description not available | [optional] +**memory_requirements** | **list[str]** | Memory requirements of a software | [optional] **website** | **list[str]** | Website of the software | [optional] **citation** | **list[str]** | How to cite this software | [optional] -**author** | **list[object]** | Description not available | [optional] -**processor_requirements** | **list[str]** | Description not available | [optional] +**author** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | The creator of a software component | [optional] +**processor_requirements** | **list[str]** | Processor requirements of a software component | [optional] **has_usage_notes** | **list[str]** | Property that describes the usage considerations of a particular software. These notes capture the rationale of for that software configuration, along with an explanation for sample inputs, things to consider when running the model with data, etc. | [optional] **readme** | **list[str]** | URl to the readme file of a software component | [optional] **has_build_file** | **list[str]** | A file (e.g., Dockerfile) with executable instructions indicating how a Software Image or a Software component is built | [optional] **short_description** | **list[str]** | A summarized description of the resource | [optional] **label** | **list[str]** | short description of the resource | [optional] **has_assumption** | **list[str]** | Assumptions of a software, e.g. the solver being used for a particular model, the source of the data (e.g., all data must have a given resolution), etc. | [optional] -**date_published** | **list[datetime]** | Description not available | [optional] -**operating_systems** | **list[str]** | Description not available | [optional] +**date_published** | **list[datetime]** | Date when a software component was published | [optional] +**operating_systems** | **list[str]** | Operating systems under which a software component can operate | [optional] **license** | **list[str]** | License of a software component or its source code | [optional] -**has_source_code** | [**list[SourceCode]**](SourceCode.md) | Description not available | [optional] +**has_source_code** | [**list[SourceCode]**](SourceCode.md) | Property designed to link a software with its software source code (which may reside in a code repository such as GitHub) | [optional] **has_executable_notebook** | **list[str]** | Property that links a software component with an executable notebook (e.g., Jupyter notebook) that illustrates how to use it in an executable manner. | [optional] **has_example** | **list[str]** | An example explaining a scenario where the software component was used in plain language. | [optional] -**publisher** | **list[object]** | Description not available | [optional] +**publisher** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Publisher organization or person responsible for a software component | [optional] **useful_for_calculating_index** | [**list[NumericalIndex]**](NumericalIndex.md) | Property that indicates that a software component (or any of its outputs) can be used to calculate a particular index. The rationale for this property is that indices are usually calculated by applying post-processing steps to the outputs of a software component. | [optional] **doi** | **list[str]** | Digital Object Identifier associated with a software component | [optional] diff --git a/docs/endpoints/SoftwareApi.md b/docs/endpoints/SoftwareApi.md index 0a9586b..f8aaad5 100644 --- a/docs/endpoints/SoftwareApi.md +++ b/docs/endpoints/SoftwareApi.md @@ -1,6 +1,6 @@ # modelcatalog.SoftwareApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.SoftwareApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the Software to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.SoftwareApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the Software to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.SoftwareApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/SoftwareConfiguration.md b/docs/endpoints/SoftwareConfiguration.md index 5ca421d..da0ff7b 100644 --- a/docs/endpoints/SoftwareConfiguration.md +++ b/docs/endpoints/SoftwareConfiguration.md @@ -7,60 +7,60 @@ Name | Type | Description | Notes **keywords** | **list[str]** | Keywords associated with a software component | [optional] **has_documentation** | **list[str]** | Pointer to the documentation of the model | [optional] **has_implementation_script_location** | **list[str]** | Property that points to the main runnable script for the current function | [optional] -**software_requirements** | **list[str]** | Description not available | [optional] +**software_requirements** | **list[str]** | Software requirements needed to install a software component | [optional] **has_download_url** | **list[str]** | Download URL where to obtain the source/executable of the software | [optional] **type** | **list[str]** | type of the resource | [optional] **has_installation_instructions** | **list[str]** | Instructions required to install this particular piece of software. Installation instructions usually are available in a human-readable manner. | [optional] **compatible_visualization_software** | [**list[Software]**](Software.md) | Property that links a software component to other useful software that canbe used to visualize its outputs | [optional] -**copyright_holder** | **list[object]** | Description not available | [optional] +**copyright_holder** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Copyright holder for a software component | [optional] **has_faq** | **list[str]** | Frequently asked questions about a software | [optional] -**logo** | [**list[Image]**](Image.md) | Description not available | [optional] -**has_contact_person** | **list[object]** | Description not available | [optional] +**logo** | [**list[Image]**](Image.md) | Property that links to the image used as logo for a software component | [optional] +**has_contact_person** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Contact person responsible for a software component | [optional] **tag** | **list[str]** | Tag used to annotate a version or a software configuration. This annotation is useful to show which version is the latest, or which version is deprecated. Supported tags are: \"latest\", \"deprecated\" | [optional] **id** | **str** | identifier | [optional] **identifier** | **list[str]** | Identifier of the resource being described | [optional] -**has_sample_execution** | [**list[SampleExecution]**](SampleExecution.md) | Description not available | [optional] -**has_sample_result** | [**list[SampleResource]**](SampleResource.md) | Description not available | [optional] -**author** | **list[object]** | Description not available | [optional] +**has_sample_execution** | [**list[SampleExecution]**](SampleExecution.md) | Property pointing to a sample execution of a software configuration | [optional] +**has_sample_result** | [**list[SampleResource]**](SampleResource.md) | Property designed to link a software configuration to a sample resource resulting from its execution | [optional] +**author** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | The creator of a software component | [optional] **has_constraint** | **list[str]** | Constraint or rule associated to a variable or software configuration. For example: \"This model accepts only monthly data\", or \"all inputs of this model configuration must share the same location\". More structured restrictions, such as Jena rules or SWRL rules may also be captured with this property | [optional] **has_build_file** | **list[str]** | A file (e.g., Dockerfile) with executable instructions indicating how a Software Image or a Software component is built | [optional] **short_description** | **list[str]** | A summarized description of the resource | [optional] **has_execution_command** | **list[str]** | Execution instructions on how to run the image | [optional] -**date_published** | **list[datetime]** | Description not available | [optional] +**date_published** | **list[datetime]** | Date when a software component was published | [optional] **license** | **list[str]** | License of a software component or its source code | [optional] -**has_source_code** | [**list[SourceCode]**](SourceCode.md) | Description not available | [optional] +**has_source_code** | [**list[SourceCode]**](SourceCode.md) | Property designed to link a software with its software source code (which may reside in a code repository such as GitHub) | [optional] **has_setup** | [**list[ConfigurationSetup]**](ConfigurationSetup.md) | Property used to define configurations with some fixed resources and values. The rationale of this property is to allow predefined configurations | [optional] **has_example** | **list[str]** | An example explaining a scenario where the software component was used in plain language. | [optional] -**publisher** | **list[object]** | Description not available | [optional] +**publisher** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Publisher organization or person responsible for a software component | [optional] **has_output** | [**list[DatasetSpecification]**](DatasetSpecification.md) | Property that expresses what are the outputs of a model | [optional] **doi** | **list[str]** | Digital Object Identifier associated with a software component | [optional] **has_funding** | [**list[FundingInformation]**](FundingInformation.md) | Property that links a software project to its funding information | [optional] **has_component_location** | **list[str]** | Location of the aggregation of all the files needed to execute the component. Usually a zip file including the run script and support scripts, including specification files | [optional] **support_details** | **list[str]** | Property to link details, such as mailing lists in case a contact person is not provided | [optional] -**has_version** | [**list[SoftwareVersion]**](SoftwareVersion.md) | Description not available | [optional] -**has_typical_data_source** | **list[str]** | Description not available | [optional] +**has_version** | [**list[SoftwareVersion]**](SoftwareVersion.md) | Property designed to link a software component with its corresponding versions | [optional] +**has_typical_data_source** | **list[str]** | Typical data sources that are used by a software component | [optional] **description** | **list[str]** | small description | [optional] **reference_publication** | **list[str]** | Main publication to cite for this software component | [optional] -**screenshot** | [**list[Image]**](Image.md) | Description not available | [optional] -**had_primary_source** | **list[object]** | had primary source | [optional] +**screenshot** | [**list[Image]**](Image.md) | Image illustrating a snapshot of the target software | [optional] +**had_primary_source** | **list[object]** | Property to identify the original source of the information of the annotated resource. It could be a web page, an organization, a person, some experiment notes, etc. | [optional] **issue_tracker** | **list[str]** | Pointer to the issue tracker of a software component | [optional] **has_software_image** | [**list[SoftwareImage]**](SoftwareImage.md) | Function to link a function with its corresponding container | [optional] -**date_created** | **list[datetime]** | Description not available | [optional] -**contributor** | [**list[Person]**](Person.md) | Description not available | [optional] +**date_created** | **list[datetime]** | Date when a software component was created | [optional] +**contributor** | [**list[Person]**](Person.md) | Contributor to a software component | [optional] **has_purpose** | **list[str]** | Objective or main functionality that can be achieved by running this software | [optional] **has_executable_instructions** | **list[str]** | Instructions that indicate how a software component should be executed. The difference with `hasExecutionCommand` is that the execution instructions aim to be human-readable, and have explanations between the different commands and instructions | [optional] **has_sample_visualization** | [**list[Visualization]**](Visualization.md) | A typical sample visualization of the softwware outputs | [optional] -**memory_requirements** | **list[str]** | Description not available | [optional] +**memory_requirements** | **list[str]** | Memory requirements of a software | [optional] **website** | **list[str]** | Website of the software | [optional] **citation** | **list[str]** | How to cite this software | [optional] -**processor_requirements** | **list[str]** | Description not available | [optional] +**processor_requirements** | **list[str]** | Processor requirements of a software component | [optional] **has_usage_notes** | **list[str]** | Property that describes the usage considerations of a particular software. These notes capture the rationale of for that software configuration, along with an explanation for sample inputs, things to consider when running the model with data, etc. | [optional] **has_support_script_location** | **list[str]** | Property that links to the location of scripts that may be used from the main runnable script. | [optional] **readme** | **list[str]** | URl to the readme file of a software component | [optional] **label** | **list[str]** | short description of the resource | [optional] **has_assumption** | **list[str]** | Assumptions of a software, e.g. the solver being used for a particular model, the source of the data (e.g., all data must have a given resolution), etc. | [optional] **has_parameter** | [**list[Parameter]**](Parameter.md) | Property that indicates the parameters of a model configuration | [optional] -**operating_systems** | **list[str]** | Description not available | [optional] +**operating_systems** | **list[str]** | Operating systems under which a software component can operate | [optional] **has_executable_notebook** | **list[str]** | Property that links a software component with an executable notebook (e.g., Jupyter notebook) that illustrates how to use it in an executable manner. | [optional] **useful_for_calculating_index** | [**list[NumericalIndex]**](NumericalIndex.md) | Property that indicates that a software component (or any of its outputs) can be used to calculate a particular index. The rationale for this property is that indices are usually calculated by applying post-processing steps to the outputs of a software component. | [optional] **has_input** | [**list[DatasetSpecification]**](DatasetSpecification.md) | Property that links a model configuration to the input types expected by it. | [optional] diff --git a/docs/endpoints/SoftwareConfigurationApi.md b/docs/endpoints/SoftwareConfigurationApi.md index d2a86f0..727c69f 100644 --- a/docs/endpoints/SoftwareConfigurationApi.md +++ b/docs/endpoints/SoftwareConfigurationApi.md @@ -1,6 +1,6 @@ # modelcatalog.SoftwareConfigurationApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.SoftwareConfigurationApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the SoftwareConfiguration to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.SoftwareConfigurationApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the SoftwareConfiguration to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.SoftwareConfigurationApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/SoftwareImage.md b/docs/endpoints/SoftwareImage.md index cc8a185..bf33a38 100644 --- a/docs/endpoints/SoftwareImage.md +++ b/docs/endpoints/SoftwareImage.md @@ -6,50 +6,50 @@ Name | Type | Description | Notes **has_download_instructions** | **list[str]** | Instructions needed to download a software component. The difference with `hasDownloadURL` is that this property captures the human readable instructions required to download software. For example, sometimes an authentication is needed, users need to fill in a form, etc. | [optional] **keywords** | **list[str]** | Keywords associated with a software component | [optional] **has_documentation** | **list[str]** | Pointer to the documentation of the model | [optional] -**software_requirements** | **list[str]** | Description not available | [optional] +**software_requirements** | **list[str]** | Software requirements needed to install a software component | [optional] **has_download_url** | **list[str]** | Download URL where to obtain the source/executable of the software | [optional] **type** | **list[str]** | type of the resource | [optional] **has_installation_instructions** | **list[str]** | Instructions required to install this particular piece of software. Installation instructions usually are available in a human-readable manner. | [optional] **compatible_visualization_software** | [**list[Software]**](Software.md) | Property that links a software component to other useful software that canbe used to visualize its outputs | [optional] -**copyright_holder** | **list[object]** | Description not available | [optional] +**copyright_holder** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Copyright holder for a software component | [optional] **has_faq** | **list[str]** | Frequently asked questions about a software | [optional] -**logo** | [**list[Image]**](Image.md) | Description not available | [optional] -**has_contact_person** | **list[object]** | Description not available | [optional] +**logo** | [**list[Image]**](Image.md) | Property that links to the image used as logo for a software component | [optional] +**has_contact_person** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Contact person responsible for a software component | [optional] **id** | **str** | identifier | [optional] **identifier** | **list[str]** | Identifier of the resource being described | [optional] -**author** | **list[object]** | Description not available | [optional] +**author** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | The creator of a software component | [optional] **has_build_file** | **list[str]** | A file (e.g., Dockerfile) with executable instructions indicating how a Software Image or a Software component is built | [optional] **short_description** | **list[str]** | A summarized description of the resource | [optional] **has_execution_command** | **list[str]** | Execution instructions on how to run the image | [optional] -**date_published** | **list[datetime]** | Description not available | [optional] +**date_published** | **list[datetime]** | Date when a software component was published | [optional] **license** | **list[str]** | License of a software component or its source code | [optional] -**has_source_code** | [**list[SourceCode]**](SourceCode.md) | Description not available | [optional] +**has_source_code** | [**list[SourceCode]**](SourceCode.md) | Property designed to link a software with its software source code (which may reside in a code repository such as GitHub) | [optional] **has_example** | **list[str]** | An example explaining a scenario where the software component was used in plain language. | [optional] -**publisher** | **list[object]** | Description not available | [optional] +**publisher** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Publisher organization or person responsible for a software component | [optional] **doi** | **list[str]** | Digital Object Identifier associated with a software component | [optional] **has_funding** | [**list[FundingInformation]**](FundingInformation.md) | Property that links a software project to its funding information | [optional] **support_details** | **list[str]** | Property to link details, such as mailing lists in case a contact person is not provided | [optional] -**has_version** | [**list[SoftwareVersion]**](SoftwareVersion.md) | Description not available | [optional] -**has_typical_data_source** | **list[str]** | Description not available | [optional] +**has_version** | [**list[SoftwareVersion]**](SoftwareVersion.md) | Property designed to link a software component with its corresponding versions | [optional] +**has_typical_data_source** | **list[str]** | Typical data sources that are used by a software component | [optional] **description** | **list[str]** | small description | [optional] **reference_publication** | **list[str]** | Main publication to cite for this software component | [optional] -**screenshot** | [**list[Image]**](Image.md) | Description not available | [optional] -**had_primary_source** | **list[object]** | had primary source | [optional] +**screenshot** | [**list[Image]**](Image.md) | Image illustrating a snapshot of the target software | [optional] +**had_primary_source** | **list[object]** | Property to identify the original source of the information of the annotated resource. It could be a web page, an organization, a person, some experiment notes, etc. | [optional] **issue_tracker** | **list[str]** | Pointer to the issue tracker of a software component | [optional] -**date_created** | **list[datetime]** | Description not available | [optional] -**contributor** | [**list[Person]**](Person.md) | Description not available | [optional] +**date_created** | **list[datetime]** | Date when a software component was created | [optional] +**contributor** | [**list[Person]**](Person.md) | Contributor to a software component | [optional] **has_purpose** | **list[str]** | Objective or main functionality that can be achieved by running this software | [optional] **has_executable_instructions** | **list[str]** | Instructions that indicate how a software component should be executed. The difference with `hasExecutionCommand` is that the execution instructions aim to be human-readable, and have explanations between the different commands and instructions | [optional] **has_sample_visualization** | [**list[Visualization]**](Visualization.md) | A typical sample visualization of the softwware outputs | [optional] -**memory_requirements** | **list[str]** | Description not available | [optional] +**memory_requirements** | **list[str]** | Memory requirements of a software | [optional] **website** | **list[str]** | Website of the software | [optional] **citation** | **list[str]** | How to cite this software | [optional] -**processor_requirements** | **list[str]** | Description not available | [optional] +**processor_requirements** | **list[str]** | Processor requirements of a software component | [optional] **has_usage_notes** | **list[str]** | Property that describes the usage considerations of a particular software. These notes capture the rationale of for that software configuration, along with an explanation for sample inputs, things to consider when running the model with data, etc. | [optional] **readme** | **list[str]** | URl to the readme file of a software component | [optional] **label** | **list[str]** | short description of the resource | [optional] **has_assumption** | **list[str]** | Assumptions of a software, e.g. the solver being used for a particular model, the source of the data (e.g., all data must have a given resolution), etc. | [optional] -**operating_systems** | **list[str]** | Description not available | [optional] +**operating_systems** | **list[str]** | Operating systems under which a software component can operate | [optional] **has_executable_notebook** | **list[str]** | Property that links a software component with an executable notebook (e.g., Jupyter notebook) that illustrates how to use it in an executable manner. | [optional] **useful_for_calculating_index** | [**list[NumericalIndex]**](NumericalIndex.md) | Property that indicates that a software component (or any of its outputs) can be used to calculate a particular index. The rationale for this property is that indices are usually calculated by applying post-processing steps to the outputs of a software component. | [optional] diff --git a/docs/endpoints/SoftwareImageApi.md b/docs/endpoints/SoftwareImageApi.md index 53043ba..4447e65 100644 --- a/docs/endpoints/SoftwareImageApi.md +++ b/docs/endpoints/SoftwareImageApi.md @@ -1,6 +1,6 @@ # modelcatalog.SoftwareImageApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.SoftwareImageApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the SoftwareImage to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.SoftwareImageApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the SoftwareImage to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.SoftwareImageApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/SoftwareVersion.md b/docs/endpoints/SoftwareVersion.md index 84975c2..73ae84c 100644 --- a/docs/endpoints/SoftwareVersion.md +++ b/docs/endpoints/SoftwareVersion.md @@ -6,51 +6,51 @@ Name | Type | Description | Notes **has_download_instructions** | **list[str]** | Instructions needed to download a software component. The difference with `hasDownloadURL` is that this property captures the human readable instructions required to download software. For example, sometimes an authentication is needed, users need to fill in a form, etc. | [optional] **keywords** | **list[str]** | Keywords associated with a software component | [optional] **has_documentation** | **list[str]** | Pointer to the documentation of the model | [optional] -**software_requirements** | **list[str]** | Description not available | [optional] +**software_requirements** | **list[str]** | Software requirements needed to install a software component | [optional] **has_download_url** | **list[str]** | Download URL where to obtain the source/executable of the software | [optional] **type** | **list[str]** | type of the resource | [optional] **has_installation_instructions** | **list[str]** | Instructions required to install this particular piece of software. Installation instructions usually are available in a human-readable manner. | [optional] **compatible_visualization_software** | [**list[Software]**](Software.md) | Property that links a software component to other useful software that canbe used to visualize its outputs | [optional] -**copyright_holder** | **list[object]** | Description not available | [optional] +**copyright_holder** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Copyright holder for a software component | [optional] **has_faq** | **list[str]** | Frequently asked questions about a software | [optional] -**logo** | [**list[Image]**](Image.md) | Description not available | [optional] -**has_contact_person** | **list[object]** | Description not available | [optional] +**logo** | [**list[Image]**](Image.md) | Property that links to the image used as logo for a software component | [optional] +**has_contact_person** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Contact person responsible for a software component | [optional] **tag** | **list[str]** | Tag used to annotate a version or a software configuration. This annotation is useful to show which version is the latest, or which version is deprecated. Supported tags are: \"latest\", \"deprecated\" | [optional] **id** | **str** | identifier | [optional] **identifier** | **list[str]** | Identifier of the resource being described | [optional] **has_configuration** | [**list[SoftwareConfiguration]**](SoftwareConfiguration.md) | Property that links a model to one of its configurations. A model may have multiple configurations, each of which is unique in terms of the inputs and outputs it uses. | [optional] -**author** | **list[object]** | Description not available | [optional] +**author** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | The creator of a software component | [optional] **has_build_file** | **list[str]** | A file (e.g., Dockerfile) with executable instructions indicating how a Software Image or a Software component is built | [optional] **short_description** | **list[str]** | A summarized description of the resource | [optional] -**date_published** | **list[datetime]** | Description not available | [optional] +**date_published** | **list[datetime]** | Date when a software component was published | [optional] **license** | **list[str]** | License of a software component or its source code | [optional] -**has_source_code** | [**list[SourceCode]**](SourceCode.md) | Description not available | [optional] +**has_source_code** | [**list[SourceCode]**](SourceCode.md) | Property designed to link a software with its software source code (which may reside in a code repository such as GitHub) | [optional] **has_example** | **list[str]** | An example explaining a scenario where the software component was used in plain language. | [optional] -**publisher** | **list[object]** | Description not available | [optional] +**publisher** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Publisher organization or person responsible for a software component | [optional] **doi** | **list[str]** | Digital Object Identifier associated with a software component | [optional] **has_funding** | [**list[FundingInformation]**](FundingInformation.md) | Property that links a software project to its funding information | [optional] **support_details** | **list[str]** | Property to link details, such as mailing lists in case a contact person is not provided | [optional] -**has_version** | [**list[SoftwareVersion]**](SoftwareVersion.md) | Description not available | [optional] -**has_typical_data_source** | **list[str]** | Description not available | [optional] +**has_version** | [**list[SoftwareVersion]**](SoftwareVersion.md) | Property designed to link a software component with its corresponding versions | [optional] +**has_typical_data_source** | **list[str]** | Typical data sources that are used by a software component | [optional] **description** | **list[str]** | small description | [optional] **reference_publication** | **list[str]** | Main publication to cite for this software component | [optional] -**screenshot** | [**list[Image]**](Image.md) | Description not available | [optional] -**had_primary_source** | **list[object]** | had primary source | [optional] +**screenshot** | [**list[Image]**](Image.md) | Image illustrating a snapshot of the target software | [optional] +**had_primary_source** | **list[object]** | Property to identify the original source of the information of the annotated resource. It could be a web page, an organization, a person, some experiment notes, etc. | [optional] **issue_tracker** | **list[str]** | Pointer to the issue tracker of a software component | [optional] -**date_created** | **list[datetime]** | Description not available | [optional] -**contributor** | [**list[Person]**](Person.md) | Description not available | [optional] +**date_created** | **list[datetime]** | Date when a software component was created | [optional] +**contributor** | [**list[Person]**](Person.md) | Contributor to a software component | [optional] **has_purpose** | **list[str]** | Objective or main functionality that can be achieved by running this software | [optional] **has_executable_instructions** | **list[str]** | Instructions that indicate how a software component should be executed. The difference with `hasExecutionCommand` is that the execution instructions aim to be human-readable, and have explanations between the different commands and instructions | [optional] **has_sample_visualization** | [**list[Visualization]**](Visualization.md) | A typical sample visualization of the softwware outputs | [optional] -**memory_requirements** | **list[str]** | Description not available | [optional] +**memory_requirements** | **list[str]** | Memory requirements of a software | [optional] **website** | **list[str]** | Website of the software | [optional] **citation** | **list[str]** | How to cite this software | [optional] -**processor_requirements** | **list[str]** | Description not available | [optional] +**processor_requirements** | **list[str]** | Processor requirements of a software component | [optional] **has_usage_notes** | **list[str]** | Property that describes the usage considerations of a particular software. These notes capture the rationale of for that software configuration, along with an explanation for sample inputs, things to consider when running the model with data, etc. | [optional] **readme** | **list[str]** | URl to the readme file of a software component | [optional] **label** | **list[str]** | short description of the resource | [optional] **has_assumption** | **list[str]** | Assumptions of a software, e.g. the solver being used for a particular model, the source of the data (e.g., all data must have a given resolution), etc. | [optional] -**operating_systems** | **list[str]** | Description not available | [optional] +**operating_systems** | **list[str]** | Operating systems under which a software component can operate | [optional] **has_executable_notebook** | **list[str]** | Property that links a software component with an executable notebook (e.g., Jupyter notebook) that illustrates how to use it in an executable manner. | [optional] **useful_for_calculating_index** | [**list[NumericalIndex]**](NumericalIndex.md) | Property that indicates that a software component (or any of its outputs) can be used to calculate a particular index. The rationale for this property is that indices are usually calculated by applying post-processing steps to the outputs of a software component. | [optional] **has_version_id** | **list[str]** | Identifier of the version of this software | [optional] diff --git a/docs/endpoints/SoftwareVersionApi.md b/docs/endpoints/SoftwareVersionApi.md index c247747..4082eea 100644 --- a/docs/endpoints/SoftwareVersionApi.md +++ b/docs/endpoints/SoftwareVersionApi.md @@ -1,6 +1,6 @@ # modelcatalog.SoftwareVersionApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.SoftwareVersionApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the SoftwareVersion to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.SoftwareVersionApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the SoftwareVersion to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.SoftwareVersionApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/SourceCode.md b/docs/endpoints/SourceCode.md index 5c5e9e5..95f2818 100644 --- a/docs/endpoints/SourceCode.md +++ b/docs/endpoints/SourceCode.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **license** | **list[str]** | License of a software component or its source code | [optional] -**programming_language** | **list[str]** | Description not available | [optional] +**programming_language** | **list[str]** | Language used to code a software component | [optional] **description** | **list[str]** | small description | [optional] **code_repository** | **list[str]** | URL to the code repository of a software component | [optional] **id** | **str** | identifier | [optional] diff --git a/docs/endpoints/SourceCodeApi.md b/docs/endpoints/SourceCodeApi.md index 99c7b03..85c2b72 100644 --- a/docs/endpoints/SourceCodeApi.md +++ b/docs/endpoints/SourceCodeApi.md @@ -1,6 +1,6 @@ # modelcatalog.SourceCodeApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.SourceCodeApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the SourceCode to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.SourceCodeApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the SourceCode to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.SourceCodeApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/SpatialResolutionApi.md b/docs/endpoints/SpatialResolutionApi.md index 6617d8c..71da359 100644 --- a/docs/endpoints/SpatialResolutionApi.md +++ b/docs/endpoints/SpatialResolutionApi.md @@ -1,6 +1,6 @@ # modelcatalog.SpatialResolutionApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.SpatialResolutionApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the SpatialResolution to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.SpatialResolutionApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the SpatialResolution to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.SpatialResolutionApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/SpatiallyDistributedGrid.md b/docs/endpoints/SpatiallyDistributedGrid.md index 5f7b9ea..746bb80 100644 --- a/docs/endpoints/SpatiallyDistributedGrid.md +++ b/docs/endpoints/SpatiallyDistributedGrid.md @@ -15,6 +15,7 @@ Name | Type | Description | Notes **has_fixed_resource** | [**list[SampleResource]**](SampleResource.md) | Description not available | [optional] **has_coordinate_system** | **list[str]** | Coordinate system used in a grid | [optional] **has_spatial_resolution** | **list[str]** | Spatial resolution of a grid (e.g., 50m) | [optional] +**is_transformed_from** | [**list[DatasetSpecification]**](DatasetSpecification.md) | Description not available | [optional] **has_shape** | **list[str]** | Grids may be: rectangular, triangular, hexagonal, hybrid, unstructured, block structure, etc. | [optional] **has_dimension** | **list[str]** | Dimension of the grid (2D, 3D) | [optional] **has_data_transformation_setup** | [**list[DataTransformationSetup]**](DataTransformationSetup.md) | Description not available | [optional] diff --git a/docs/endpoints/SpatiallyDistributedGridApi.md b/docs/endpoints/SpatiallyDistributedGridApi.md index 80c21f5..951b510 100644 --- a/docs/endpoints/SpatiallyDistributedGridApi.md +++ b/docs/endpoints/SpatiallyDistributedGridApi.md @@ -1,6 +1,6 @@ # modelcatalog.SpatiallyDistributedGridApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.SpatiallyDistributedGridApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the SpatiallyDistributedGrid to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.SpatiallyDistributedGridApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the SpatiallyDistributedGrid to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.SpatiallyDistributedGridApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/StandardVariableApi.md b/docs/endpoints/StandardVariableApi.md index 1b0e65d..d7d0d87 100644 --- a/docs/endpoints/StandardVariableApi.md +++ b/docs/endpoints/StandardVariableApi.md @@ -1,6 +1,6 @@ # modelcatalog.StandardVariableApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.StandardVariableApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the StandardVariable to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.StandardVariableApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the StandardVariable to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.StandardVariableApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/TheoryGuidedModel.md b/docs/endpoints/TheoryGuidedModel.md index 13bedbf..f72923a 100644 --- a/docs/endpoints/TheoryGuidedModel.md +++ b/docs/endpoints/TheoryGuidedModel.md @@ -12,13 +12,13 @@ Name | Type | Description | Notes **type** | **list[str]** | type of the resource | [optional] **has_installation_instructions** | **list[str]** | Description not available | [optional] **compatible_visualization_software** | [**list[Software]**](Software.md) | Description not available | [optional] -**copyright_holder** | **list[object]** | Description not available | [optional] +**copyright_holder** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Description not available | [optional] **has_faq** | **list[str]** | Description not available | [optional] **logo** | [**list[Image]**](Image.md) | Description not available | [optional] -**has_contact_person** | **list[object]** | Description not available | [optional] +**has_contact_person** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Description not available | [optional] **id** | **str** | identifier | [optional] **identifier** | **list[str]** | Description not available | [optional] -**author** | **list[object]** | Description not available | [optional] +**author** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Description not available | [optional] **has_build_file** | **list[str]** | Description not available | [optional] **short_description** | **list[str]** | Description not available | [optional] **date_published** | **list[datetime]** | Description not available | [optional] @@ -26,7 +26,7 @@ Name | Type | Description | Notes **has_source_code** | [**list[SourceCode]**](SourceCode.md) | Description not available | [optional] **has_explanation_diagram** | [**list[Image]**](Image.md) | Diagram used to explain the behavior of the model | [optional] **has_example** | **list[str]** | Description not available | [optional] -**publisher** | **list[object]** | Description not available | [optional] +**publisher** | [**list[AnyOfOrganizationPerson]**](AnyOfOrganizationPerson.md) | Description not available | [optional] **doi** | **list[str]** | Description not available | [optional] **has_funding** | [**list[FundingInformation]**](FundingInformation.md) | Description not available | [optional] **support_details** | **list[str]** | Description not available | [optional] @@ -35,7 +35,7 @@ Name | Type | Description | Notes **description** | **list[str]** | small description | [optional] **reference_publication** | **list[str]** | Description not available | [optional] **screenshot** | [**list[Image]**](Image.md) | Description not available | [optional] -**has_model_category** | **list[str]** | Category associated with a model (e.g., Hydrology) | [optional] +**has_model_category** | [**list[ModelCategory]**](ModelCategory.md) | Category associated with a model (e.g., Hydrology, etc.) | [optional] **had_primary_source** | **list[object]** | Description not available | [optional] **issue_tracker** | **list[str]** | Description not available | [optional] **date_created** | **list[datetime]** | Description not available | [optional] diff --git a/docs/endpoints/TheoryGuidedModelApi.md b/docs/endpoints/TheoryGuidedModelApi.md index d719b7a..74c8099 100644 --- a/docs/endpoints/TheoryGuidedModelApi.md +++ b/docs/endpoints/TheoryGuidedModelApi.md @@ -1,6 +1,6 @@ # modelcatalog.TheoryGuidedModelApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.TheoryGuidedModelApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the Theory-GuidedModel to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.TheoryGuidedModelApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the Theory-GuidedModel to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.TheoryGuidedModelApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/TimeInterval.md b/docs/endpoints/TimeInterval.md index c2d988a..8b8e375 100644 --- a/docs/endpoints/TimeInterval.md +++ b/docs/endpoints/TimeInterval.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **id** | **str** | identifier | [optional] **label** | **list[str]** | short description of the resource | [optional] **type** | **list[str]** | type of the resource | [optional] -**interval_value** | **list[object]** | Value used in the time interval of a model (e.g., 1 month, 5 days, 'harvest cycle') | [optional] +**interval_value** | [**list[AnyOfintegerstring]**](AnyOfintegerstring.md) | Value used in the time interval of a model (e.g., 1 month, 5 days, 'harvest cycle') | [optional] [[Back to Model list]](../#documentation-for-models) [[Back to API list]](../#documentation-for-api-endpoints) [[Back to README]](../) diff --git a/docs/endpoints/TimeIntervalApi.md b/docs/endpoints/TimeIntervalApi.md index 6340ac3..b2225e3 100644 --- a/docs/endpoints/TimeIntervalApi.md +++ b/docs/endpoints/TimeIntervalApi.md @@ -1,6 +1,6 @@ # modelcatalog.TimeIntervalApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.TimeIntervalApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the TimeInterval to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.TimeIntervalApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the TimeInterval to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.TimeIntervalApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/UnitApi.md b/docs/endpoints/UnitApi.md index 04e2d6c..f4983ce 100644 --- a/docs/endpoints/UnitApi.md +++ b/docs/endpoints/UnitApi.md @@ -1,6 +1,6 @@ # modelcatalog.UnitApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.UnitApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the Unit to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.UnitApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the Unit to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.UnitApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/VariableApi.md b/docs/endpoints/VariableApi.md index 8dc97c7..6336874 100644 --- a/docs/endpoints/VariableApi.md +++ b/docs/endpoints/VariableApi.md @@ -1,6 +1,6 @@ # modelcatalog.VariableApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.VariableApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the Variable to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.VariableApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the Variable to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.VariableApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/VariablePresentation.md b/docs/endpoints/VariablePresentation.md index 46452c1..7d6ed37 100644 --- a/docs/endpoints/VariablePresentation.md +++ b/docs/endpoints/VariablePresentation.md @@ -3,16 +3,16 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**has_default_value** | **list[object]** | Default accepted value of a variable presentation (or a parameter) | [optional] +**has_default_value** | [**list[AnyOfURIbooleanDateTimefloatintegerstring]**](AnyOfURIbooleanDateTimefloatintegerstring.md) | Default accepted value of a variable presentation (or a parameter) | [optional] **has_standard_variable** | [**list[StandardVariable]**](StandardVariable.md) | the standard name of a variable | [optional] -**has_maximum_accepted_value** | **list[object]** | Maximum accepted value of a variable presentation (or a parameter) | [optional] +**has_maximum_accepted_value** | [**list[AnyOfDateTimefloatinteger]**](AnyOfDateTimefloatinteger.md) | Maximum accepted value of a variable presentation (or a parameter) | [optional] **has_constraint** | **list[str]** | Constraint or rule associated to a variable or software configuration. For example: \"This model accepts only monthly data\", or \"all inputs of this model configuration must share the same location\". More structured restrictions, such as Jena rules or SWRL rules may also be captured with this property | [optional] **description** | **list[str]** | small description | [optional] **label** | **list[str]** | short description of the resource | [optional] **type** | **list[str]** | type of the resource | [optional] **has_long_name** | **list[str]** | Properties that relate the variable representation to its long name. The long name is useful for context (e.g., precipitation is less ambiguous than P) but not as precise as the standard name. | [optional] **has_short_name** | **list[str]** | A short name (e.g., temperature) capturing the high-level concept of the variable | [optional] -**has_minimum_accepted_value** | **list[object]** | Minimum accepted value of a variable presentation (or a parameter) | [optional] +**has_minimum_accepted_value** | [**list[AnyOfDateTimefloatinteger]**](AnyOfDateTimefloatinteger.md) | Minimum accepted value of a variable presentation (or a parameter) | [optional] **part_of_dataset** | [**list[DatasetSpecification]**](DatasetSpecification.md) | Associates a presentation with a dataset where the presentation occurs | [optional] **id** | **str** | identifier | [optional] **uses_unit** | [**list[Unit]**](Unit.md) | Property used to link a variable presentation or time interval to the unit they are represented in | [optional] diff --git a/docs/endpoints/VariablePresentationApi.md b/docs/endpoints/VariablePresentationApi.md index e592043..73024a7 100644 --- a/docs/endpoints/VariablePresentationApi.md +++ b/docs/endpoints/VariablePresentationApi.md @@ -1,6 +1,6 @@ # modelcatalog.VariablePresentationApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.VariablePresentationApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the VariablePresentation to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.VariablePresentationApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the VariablePresentation to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.VariablePresentationApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/docs/endpoints/Visualization.md b/docs/endpoints/Visualization.md index 94214af..911a3d5 100644 --- a/docs/endpoints/Visualization.md +++ b/docs/endpoints/Visualization.md @@ -4,13 +4,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **has_format** | **list[str]** | Format followed by a file. For example, txt, nc, etc. | [optional] -**had_primary_source** | **list[object]** | had primary source | [optional] -**was_derived_from_software** | [**list[Software]**](Software.md) | Description not available | [optional] +**had_primary_source** | **list[object]** | Property to identify the original source of the information of the annotated resource. It could be a web page, an organization, a person, some experiment notes, etc. | [optional] +**was_derived_from_software** | [**list[Software]**](Software.md) | Property that identifies the software used to create a visualization | [optional] **description** | **list[str]** | small description | [optional] **id** | **str** | identifier | [optional] **label** | **list[str]** | short description of the resource | [optional] **type** | **list[str]** | type of the resource | [optional] -**value** | **list[object]** | Value associated to the described entity | [optional] +**value** | [**list[AnyOfURIbooleanDateTimefloatintegerstring]**](AnyOfURIbooleanDateTimefloatintegerstring.md) | Value associated to the described entity | [optional] [[Back to Model list]](../#documentation-for-models) [[Back to API list]](../#documentation-for-api-endpoints) [[Back to README]](../) diff --git a/docs/endpoints/VisualizationApi.md b/docs/endpoints/VisualizationApi.md index 6e7a29d..5661aef 100644 --- a/docs/endpoints/VisualizationApi.md +++ b/docs/endpoints/VisualizationApi.md @@ -1,6 +1,6 @@ # modelcatalog.VisualizationApi -All URIs are relative to *https://api.models.mint.isi.edu/v1.5.0* +All URIs are relative to *https://api.models.mint.isi.edu/v1.6.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -91,8 +91,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.VisualizationApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the Visualization to be retrieved @@ -209,8 +209,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.VisualizationApi(modelcatalog.ApiClient(configuration)) id = 'id_example' # str | The ID of the Visualization to be retrieved @@ -274,8 +274,8 @@ configuration = modelcatalog.Configuration() # Configure Bearer authorization (JWT): BearerAuth configuration.access_token = 'YOUR_BEARER_TOKEN' -# Defining host is optional and default to https://api.models.mint.isi.edu/v1.5.0 -configuration.host = "https://api.models.mint.isi.edu/v1.5.0" +# Defining host is optional and default to https://api.models.mint.isi.edu/v1.6.0 +configuration.host = "https://api.models.mint.isi.edu/v1.6.0" # Create an instance of the API class api_instance = modelcatalog.VisualizationApi(modelcatalog.ApiClient(configuration)) user = 'user_example' # str | Username diff --git a/generate-client-mac.sh b/generate-client-mac.sh new file mode 100644 index 0000000..99b893a --- /dev/null +++ b/generate-client-mac.sh @@ -0,0 +1,37 @@ +set -e +dir=${PWD} +parentdir="$(dirname "$dir")" + +REPO_TAG=$1 +FILE=https://raw.githubusercontent.com/mintproject/model-catalog-api/$REPO_TAG/openapi.yaml +docker run -ti --rm -v ${PWD}:/local openapitools/openapi-generator-cli:v4.1.2 \ + generate \ + -i $FILE \ + -g python \ + -o /local/ \ + -c /local/openapi-config.json \ + --git-repo-id model-catalog-python-api-client \ + --git-user-id mintproject \ + +mv -f docs/ModelconfigurationApi.md docs/ModelConfigurationApi.md + +sed -i '.bk' 's~docs/~docs/endpoints/~g' README.md +rm README.md.bk +mv docs/[A-Z]*.md docs/endpoints/ +pushd docs/endpoints/ +for file in $(ls *.md); do + sed -i '.bk' 's/README.md//g' $file +done +for file in $(ls *.bk); do + rm $file +done +popd + +pushd docs/modelcatalog/models/ +for file in $(ls *.py); do + sed -i '.bk' 's/AnyOf[a-zA-Z]*/object/g' $file +done +for file in $(ls *.bk); do + rm $file +done +popd diff --git a/generate-client.sh b/generate-client.sh index 67872db..40c086f 100644 --- a/generate-client.sh +++ b/generate-client.sh @@ -22,3 +22,9 @@ for file in $(ls *.md); do sed -i 's/README.md//g' $file done popd + +pushd docs/modelcatalog/models/ +for file in $(ls *.py); do + sed -i 's/AnyOf[a-zA-Z]*/object/g' $file +done +popd diff --git a/modelcatalog/__init__.py b/modelcatalog/__init__.py index f881276..32e360d 100644 --- a/modelcatalog/__init__.py +++ b/modelcatalog/__init__.py @@ -7,7 +7,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ @@ -17,8 +17,10 @@ __version__ = "5.0.0" # import apis into sdk package +from modelcatalog.api.catalog_identifier_api import CatalogIdentifierApi from modelcatalog.api.causal_diagram_api import CausalDiagramApi from modelcatalog.api.configuration_setup_api import ConfigurationSetupApi +from modelcatalog.api.coupled_model_api import CoupledModelApi from modelcatalog.api.data_transformation_api import DataTransformationApi from modelcatalog.api.data_transformation_setup_api import DataTransformationSetupApi from modelcatalog.api.dataset_specification_api import DatasetSpecificationApi @@ -33,6 +35,7 @@ from modelcatalog.api.image_api import ImageApi from modelcatalog.api.intervention_api import InterventionApi from modelcatalog.api.model_api import ModelApi +from modelcatalog.api.model_category_api import ModelCategoryApi from modelcatalog.api.model_configuration_api import ModelConfigurationApi from modelcatalog.api.model_configuration_setup_api import ModelConfigurationSetupApi from modelcatalog.api.numerical_index_api import NumericalIndexApi @@ -70,8 +73,10 @@ from modelcatalog.exceptions import ApiKeyError from modelcatalog.exceptions import ApiException # import models into sdk package +from modelcatalog.models.catalog_identifier import CatalogIdentifier from modelcatalog.models.causal_diagram import CausalDiagram from modelcatalog.models.configuration_setup import ConfigurationSetup +from modelcatalog.models.coupled_model import CoupledModel from modelcatalog.models.data_transformation import DataTransformation from modelcatalog.models.data_transformation_setup import DataTransformationSetup from modelcatalog.models.dataset_specification import DatasetSpecification @@ -86,6 +91,7 @@ from modelcatalog.models.image import Image from modelcatalog.models.intervention import Intervention from modelcatalog.models.model import Model +from modelcatalog.models.model_category import ModelCategory from modelcatalog.models.model_configuration import ModelConfiguration from modelcatalog.models.model_configuration_setup import ModelConfigurationSetup from modelcatalog.models.numerical_index import NumericalIndex diff --git a/modelcatalog/api/__init__.py b/modelcatalog/api/__init__.py index 0b71f60..20a6141 100644 --- a/modelcatalog/api/__init__.py +++ b/modelcatalog/api/__init__.py @@ -3,8 +3,10 @@ # flake8: noqa # import apis into api package +from modelcatalog.api.catalog_identifier_api import CatalogIdentifierApi from modelcatalog.api.causal_diagram_api import CausalDiagramApi from modelcatalog.api.configuration_setup_api import ConfigurationSetupApi +from modelcatalog.api.coupled_model_api import CoupledModelApi from modelcatalog.api.data_transformation_api import DataTransformationApi from modelcatalog.api.data_transformation_setup_api import DataTransformationSetupApi from modelcatalog.api.dataset_specification_api import DatasetSpecificationApi @@ -19,6 +21,7 @@ from modelcatalog.api.image_api import ImageApi from modelcatalog.api.intervention_api import InterventionApi from modelcatalog.api.model_api import ModelApi +from modelcatalog.api.model_category_api import ModelCategoryApi from modelcatalog.api.model_configuration_api import ModelConfigurationApi from modelcatalog.api.model_configuration_setup_api import ModelConfigurationSetupApi from modelcatalog.api.numerical_index_api import NumericalIndexApi diff --git a/modelcatalog/api/catalog_identifier_api.py b/modelcatalog/api/catalog_identifier_api.py new file mode 100644 index 0000000..8804b99 --- /dev/null +++ b/modelcatalog/api/catalog_identifier_api.py @@ -0,0 +1,621 @@ +# coding: utf-8 + +""" + Model Catalog + + This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 + + The version of the OpenAPI document: v1.6.0 + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import re # noqa: F401 + +# python 2 and python 3 compatibility library +import six + +from modelcatalog.api_client import ApiClient +from modelcatalog.exceptions import ( + ApiTypeError, + ApiValueError +) + + +class CatalogIdentifierApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def catalogidentifiers_get(self, **kwargs): # noqa: E501 + """List all instances of CatalogIdentifier # noqa: E501 + + Gets a list of all instances of CatalogIdentifier (more information in https://w3id.org/okn/o/sd#CatalogIdentifier) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.catalogidentifiers_get(async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str username: Name of the user graph to query + :param str label: Filter by label + :param int page: Page number + :param int per_page: Items per page + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: list[CatalogIdentifier] + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.catalogidentifiers_get_with_http_info(**kwargs) # noqa: E501 + + def catalogidentifiers_get_with_http_info(self, **kwargs): # noqa: E501 + """List all instances of CatalogIdentifier # noqa: E501 + + Gets a list of all instances of CatalogIdentifier (more information in https://w3id.org/okn/o/sd#CatalogIdentifier) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.catalogidentifiers_get_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str username: Name of the user graph to query + :param str label: Filter by label + :param int page: Page number + :param int per_page: Items per page + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(list[CatalogIdentifier], status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = ['username', 'label', 'page', 'per_page'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method catalogidentifiers_get" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + + if 'per_page' in local_var_params and local_var_params['per_page'] > 200: # noqa: E501 + raise ApiValueError("Invalid value for parameter `per_page` when calling `catalogidentifiers_get`, must be a value less than or equal to `200`") # noqa: E501 + if 'per_page' in local_var_params and local_var_params['per_page'] < 1: # noqa: E501 + raise ApiValueError("Invalid value for parameter `per_page` when calling `catalogidentifiers_get`, must be a value greater than or equal to `1`") # noqa: E501 + collection_formats = {} + + path_params = {} + + query_params = [] + if 'username' in local_var_params: + query_params.append(('username', local_var_params['username'])) # noqa: E501 + if 'label' in local_var_params: + query_params.append(('label', local_var_params['label'])) # noqa: E501 + if 'page' in local_var_params: + query_params.append(('page', local_var_params['page'])) # noqa: E501 + if 'per_page' in local_var_params: + query_params.append(('per_page', local_var_params['per_page'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = [] # noqa: E501 + + return self.api_client.call_api( + '/catalogidentifiers', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='list[CatalogIdentifier]', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def catalogidentifiers_id_delete(self, id, user, **kwargs): # noqa: E501 + """Delete an existing CatalogIdentifier # noqa: E501 + + Delete an existing CatalogIdentifier (more information in https://w3id.org/okn/o/sd#CatalogIdentifier) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.catalogidentifiers_id_delete(id, user, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str id: The ID of the CatalogIdentifier to be retrieved (required) + :param str user: Username (required) + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.catalogidentifiers_id_delete_with_http_info(id, user, **kwargs) # noqa: E501 + + def catalogidentifiers_id_delete_with_http_info(self, id, user, **kwargs): # noqa: E501 + """Delete an existing CatalogIdentifier # noqa: E501 + + Delete an existing CatalogIdentifier (more information in https://w3id.org/okn/o/sd#CatalogIdentifier) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.catalogidentifiers_id_delete_with_http_info(id, user, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str id: The ID of the CatalogIdentifier to be retrieved (required) + :param str user: Username (required) + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = ['id', 'user'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method catalogidentifiers_id_delete" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in local_var_params or + local_var_params['id'] is None): + raise ApiValueError("Missing the required parameter `id` when calling `catalogidentifiers_id_delete`") # noqa: E501 + # verify the required parameter 'user' is set + if ('user' not in local_var_params or + local_var_params['user'] is None): + raise ApiValueError("Missing the required parameter `user` when calling `catalogidentifiers_id_delete`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in local_var_params: + path_params['id'] = local_var_params['id'] # noqa: E501 + if 'user' in local_var_params: + path_params['user'] = local_var_params['user'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['BearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/catalogidentifiers/{id}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def catalogidentifiers_id_get(self, id, **kwargs): # noqa: E501 + """Get a single CatalogIdentifier by its id # noqa: E501 + + Gets the details of a given CatalogIdentifier (more information in https://w3id.org/okn/o/sd#CatalogIdentifier) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.catalogidentifiers_id_get(id, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str id: The ID of the CatalogIdentifier to be retrieved (required) + :param str username: Name of the user graph to query + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: CatalogIdentifier + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.catalogidentifiers_id_get_with_http_info(id, **kwargs) # noqa: E501 + + def catalogidentifiers_id_get_with_http_info(self, id, **kwargs): # noqa: E501 + """Get a single CatalogIdentifier by its id # noqa: E501 + + Gets the details of a given CatalogIdentifier (more information in https://w3id.org/okn/o/sd#CatalogIdentifier) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.catalogidentifiers_id_get_with_http_info(id, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str id: The ID of the CatalogIdentifier to be retrieved (required) + :param str username: Name of the user graph to query + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(CatalogIdentifier, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = ['id', 'username'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method catalogidentifiers_id_get" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in local_var_params or + local_var_params['id'] is None): + raise ApiValueError("Missing the required parameter `id` when calling `catalogidentifiers_id_get`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in local_var_params: + path_params['id'] = local_var_params['id'] # noqa: E501 + + query_params = [] + if 'username' in local_var_params: + query_params.append(('username', local_var_params['username'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = [] # noqa: E501 + + return self.api_client.call_api( + '/catalogidentifiers/{id}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='CatalogIdentifier', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def catalogidentifiers_id_put(self, id, user, **kwargs): # noqa: E501 + """Update an existing CatalogIdentifier # noqa: E501 + + Updates an existing CatalogIdentifier (more information in https://w3id.org/okn/o/sd#CatalogIdentifier) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.catalogidentifiers_id_put(id, user, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str id: The ID of the CatalogIdentifier to be retrieved (required) + :param str user: Username (required) + :param CatalogIdentifier catalog_identifier: An old CatalogIdentifierto be updated + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: CatalogIdentifier + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.catalogidentifiers_id_put_with_http_info(id, user, **kwargs) # noqa: E501 + + def catalogidentifiers_id_put_with_http_info(self, id, user, **kwargs): # noqa: E501 + """Update an existing CatalogIdentifier # noqa: E501 + + Updates an existing CatalogIdentifier (more information in https://w3id.org/okn/o/sd#CatalogIdentifier) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.catalogidentifiers_id_put_with_http_info(id, user, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str id: The ID of the CatalogIdentifier to be retrieved (required) + :param str user: Username (required) + :param CatalogIdentifier catalog_identifier: An old CatalogIdentifierto be updated + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(CatalogIdentifier, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = ['id', 'user', 'catalog_identifier'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method catalogidentifiers_id_put" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in local_var_params or + local_var_params['id'] is None): + raise ApiValueError("Missing the required parameter `id` when calling `catalogidentifiers_id_put`") # noqa: E501 + # verify the required parameter 'user' is set + if ('user' not in local_var_params or + local_var_params['user'] is None): + raise ApiValueError("Missing the required parameter `user` when calling `catalogidentifiers_id_put`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in local_var_params: + path_params['id'] = local_var_params['id'] # noqa: E501 + if 'user' in local_var_params: + path_params['user'] = local_var_params['user'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'catalog_identifier' in local_var_params: + body_params = local_var_params['catalog_identifier'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['BearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/catalogidentifiers/{id}', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='CatalogIdentifier', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def catalogidentifiers_post(self, user, **kwargs): # noqa: E501 + """Create one CatalogIdentifier # noqa: E501 + + Create a new instance of CatalogIdentifier (more information in https://w3id.org/okn/o/sd#CatalogIdentifier) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.catalogidentifiers_post(user, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str user: Username (required) + :param CatalogIdentifier catalog_identifier: Information about the CatalogIdentifierto be created + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: CatalogIdentifier + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.catalogidentifiers_post_with_http_info(user, **kwargs) # noqa: E501 + + def catalogidentifiers_post_with_http_info(self, user, **kwargs): # noqa: E501 + """Create one CatalogIdentifier # noqa: E501 + + Create a new instance of CatalogIdentifier (more information in https://w3id.org/okn/o/sd#CatalogIdentifier) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.catalogidentifiers_post_with_http_info(user, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str user: Username (required) + :param CatalogIdentifier catalog_identifier: Information about the CatalogIdentifierto be created + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(CatalogIdentifier, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = ['user', 'catalog_identifier'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method catalogidentifiers_post" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'user' is set + if ('user' not in local_var_params or + local_var_params['user'] is None): + raise ApiValueError("Missing the required parameter `user` when calling `catalogidentifiers_post`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'user' in local_var_params: + path_params['user'] = local_var_params['user'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'catalog_identifier' in local_var_params: + body_params = local_var_params['catalog_identifier'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['BearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/catalogidentifiers', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='CatalogIdentifier', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/modelcatalog/api/causal_diagram_api.py b/modelcatalog/api/causal_diagram_api.py index 77a8317..f568a47 100644 --- a/modelcatalog/api/causal_diagram_api.py +++ b/modelcatalog/api/causal_diagram_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/configuration_setup_api.py b/modelcatalog/api/configuration_setup_api.py index a3bc139..d31d648 100644 --- a/modelcatalog/api/configuration_setup_api.py +++ b/modelcatalog/api/configuration_setup_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/coupled_model_api.py b/modelcatalog/api/coupled_model_api.py new file mode 100644 index 0000000..3da6e35 --- /dev/null +++ b/modelcatalog/api/coupled_model_api.py @@ -0,0 +1,621 @@ +# coding: utf-8 + +""" + Model Catalog + + This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 + + The version of the OpenAPI document: v1.6.0 + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import re # noqa: F401 + +# python 2 and python 3 compatibility library +import six + +from modelcatalog.api_client import ApiClient +from modelcatalog.exceptions import ( + ApiTypeError, + ApiValueError +) + + +class CoupledModelApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def coupledmodels_get(self, **kwargs): # noqa: E501 + """List all instances of CoupledModel # noqa: E501 + + Gets a list of all instances of CoupledModel (more information in https://w3id.org/okn/o/sdm#CoupledModel) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.coupledmodels_get(async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str username: Name of the user graph to query + :param str label: Filter by label + :param int page: Page number + :param int per_page: Items per page + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: list[CoupledModel] + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.coupledmodels_get_with_http_info(**kwargs) # noqa: E501 + + def coupledmodels_get_with_http_info(self, **kwargs): # noqa: E501 + """List all instances of CoupledModel # noqa: E501 + + Gets a list of all instances of CoupledModel (more information in https://w3id.org/okn/o/sdm#CoupledModel) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.coupledmodels_get_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str username: Name of the user graph to query + :param str label: Filter by label + :param int page: Page number + :param int per_page: Items per page + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(list[CoupledModel], status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = ['username', 'label', 'page', 'per_page'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method coupledmodels_get" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + + if 'per_page' in local_var_params and local_var_params['per_page'] > 200: # noqa: E501 + raise ApiValueError("Invalid value for parameter `per_page` when calling `coupledmodels_get`, must be a value less than or equal to `200`") # noqa: E501 + if 'per_page' in local_var_params and local_var_params['per_page'] < 1: # noqa: E501 + raise ApiValueError("Invalid value for parameter `per_page` when calling `coupledmodels_get`, must be a value greater than or equal to `1`") # noqa: E501 + collection_formats = {} + + path_params = {} + + query_params = [] + if 'username' in local_var_params: + query_params.append(('username', local_var_params['username'])) # noqa: E501 + if 'label' in local_var_params: + query_params.append(('label', local_var_params['label'])) # noqa: E501 + if 'page' in local_var_params: + query_params.append(('page', local_var_params['page'])) # noqa: E501 + if 'per_page' in local_var_params: + query_params.append(('per_page', local_var_params['per_page'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = [] # noqa: E501 + + return self.api_client.call_api( + '/coupledmodels', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='list[CoupledModel]', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def coupledmodels_id_delete(self, id, user, **kwargs): # noqa: E501 + """Delete an existing CoupledModel # noqa: E501 + + Delete an existing CoupledModel (more information in https://w3id.org/okn/o/sdm#CoupledModel) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.coupledmodels_id_delete(id, user, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str id: The ID of the CoupledModel to be retrieved (required) + :param str user: Username (required) + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.coupledmodels_id_delete_with_http_info(id, user, **kwargs) # noqa: E501 + + def coupledmodels_id_delete_with_http_info(self, id, user, **kwargs): # noqa: E501 + """Delete an existing CoupledModel # noqa: E501 + + Delete an existing CoupledModel (more information in https://w3id.org/okn/o/sdm#CoupledModel) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.coupledmodels_id_delete_with_http_info(id, user, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str id: The ID of the CoupledModel to be retrieved (required) + :param str user: Username (required) + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = ['id', 'user'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method coupledmodels_id_delete" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in local_var_params or + local_var_params['id'] is None): + raise ApiValueError("Missing the required parameter `id` when calling `coupledmodels_id_delete`") # noqa: E501 + # verify the required parameter 'user' is set + if ('user' not in local_var_params or + local_var_params['user'] is None): + raise ApiValueError("Missing the required parameter `user` when calling `coupledmodels_id_delete`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in local_var_params: + path_params['id'] = local_var_params['id'] # noqa: E501 + if 'user' in local_var_params: + path_params['user'] = local_var_params['user'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['BearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/coupledmodels/{id}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def coupledmodels_id_get(self, id, **kwargs): # noqa: E501 + """Get a single CoupledModel by its id # noqa: E501 + + Gets the details of a given CoupledModel (more information in https://w3id.org/okn/o/sdm#CoupledModel) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.coupledmodels_id_get(id, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str id: The ID of the CoupledModel to be retrieved (required) + :param str username: Name of the user graph to query + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: CoupledModel + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.coupledmodels_id_get_with_http_info(id, **kwargs) # noqa: E501 + + def coupledmodels_id_get_with_http_info(self, id, **kwargs): # noqa: E501 + """Get a single CoupledModel by its id # noqa: E501 + + Gets the details of a given CoupledModel (more information in https://w3id.org/okn/o/sdm#CoupledModel) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.coupledmodels_id_get_with_http_info(id, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str id: The ID of the CoupledModel to be retrieved (required) + :param str username: Name of the user graph to query + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(CoupledModel, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = ['id', 'username'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method coupledmodels_id_get" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in local_var_params or + local_var_params['id'] is None): + raise ApiValueError("Missing the required parameter `id` when calling `coupledmodels_id_get`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in local_var_params: + path_params['id'] = local_var_params['id'] # noqa: E501 + + query_params = [] + if 'username' in local_var_params: + query_params.append(('username', local_var_params['username'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = [] # noqa: E501 + + return self.api_client.call_api( + '/coupledmodels/{id}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='CoupledModel', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def coupledmodels_id_put(self, id, user, **kwargs): # noqa: E501 + """Update an existing CoupledModel # noqa: E501 + + Updates an existing CoupledModel (more information in https://w3id.org/okn/o/sdm#CoupledModel) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.coupledmodels_id_put(id, user, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str id: The ID of the CoupledModel to be retrieved (required) + :param str user: Username (required) + :param CoupledModel coupled_model: An old CoupledModelto be updated + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: CoupledModel + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.coupledmodels_id_put_with_http_info(id, user, **kwargs) # noqa: E501 + + def coupledmodels_id_put_with_http_info(self, id, user, **kwargs): # noqa: E501 + """Update an existing CoupledModel # noqa: E501 + + Updates an existing CoupledModel (more information in https://w3id.org/okn/o/sdm#CoupledModel) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.coupledmodels_id_put_with_http_info(id, user, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str id: The ID of the CoupledModel to be retrieved (required) + :param str user: Username (required) + :param CoupledModel coupled_model: An old CoupledModelto be updated + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(CoupledModel, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = ['id', 'user', 'coupled_model'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method coupledmodels_id_put" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in local_var_params or + local_var_params['id'] is None): + raise ApiValueError("Missing the required parameter `id` when calling `coupledmodels_id_put`") # noqa: E501 + # verify the required parameter 'user' is set + if ('user' not in local_var_params or + local_var_params['user'] is None): + raise ApiValueError("Missing the required parameter `user` when calling `coupledmodels_id_put`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in local_var_params: + path_params['id'] = local_var_params['id'] # noqa: E501 + if 'user' in local_var_params: + path_params['user'] = local_var_params['user'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'coupled_model' in local_var_params: + body_params = local_var_params['coupled_model'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['BearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/coupledmodels/{id}', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='CoupledModel', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def coupledmodels_post(self, user, **kwargs): # noqa: E501 + """Create one CoupledModel # noqa: E501 + + Create a new instance of CoupledModel (more information in https://w3id.org/okn/o/sdm#CoupledModel) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.coupledmodels_post(user, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str user: Username (required) + :param CoupledModel coupled_model: Information about the CoupledModelto be created + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: CoupledModel + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.coupledmodels_post_with_http_info(user, **kwargs) # noqa: E501 + + def coupledmodels_post_with_http_info(self, user, **kwargs): # noqa: E501 + """Create one CoupledModel # noqa: E501 + + Create a new instance of CoupledModel (more information in https://w3id.org/okn/o/sdm#CoupledModel) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.coupledmodels_post_with_http_info(user, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str user: Username (required) + :param CoupledModel coupled_model: Information about the CoupledModelto be created + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(CoupledModel, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = ['user', 'coupled_model'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method coupledmodels_post" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'user' is set + if ('user' not in local_var_params or + local_var_params['user'] is None): + raise ApiValueError("Missing the required parameter `user` when calling `coupledmodels_post`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'user' in local_var_params: + path_params['user'] = local_var_params['user'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'coupled_model' in local_var_params: + body_params = local_var_params['coupled_model'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['BearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/coupledmodels', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='CoupledModel', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/modelcatalog/api/data_transformation_api.py b/modelcatalog/api/data_transformation_api.py index 5c063fc..20e5b7d 100644 --- a/modelcatalog/api/data_transformation_api.py +++ b/modelcatalog/api/data_transformation_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ @@ -36,122 +36,6 @@ def __init__(self, api_client=None): api_client = ApiClient() self.api_client = api_client - def custom_dataspecifications_id_datatransformations_get(self, id, **kwargs): # noqa: E501 - """Gets a list of data transformations related a dataset # noqa: E501 - - Gets a list of data transformations related a dataset # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.custom_dataspecifications_id_datatransformations_get(id, async_req=True) - >>> result = thread.get() - - :param async_req bool: execute request asynchronously - :param str id: The ID of the dataspecification (required) - :param str custom_query_name: Name of the custom query - :param str username: Username to query - :param _preload_content: if False, the urllib3.HTTPResponse object will - be returned without reading/decoding response - data. Default is True. - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: list[DataTransformation] - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - return self.custom_dataspecifications_id_datatransformations_get_with_http_info(id, **kwargs) # noqa: E501 - - def custom_dataspecifications_id_datatransformations_get_with_http_info(self, id, **kwargs): # noqa: E501 - """Gets a list of data transformations related a dataset # noqa: E501 - - Gets a list of data transformations related a dataset # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.custom_dataspecifications_id_datatransformations_get_with_http_info(id, async_req=True) - >>> result = thread.get() - - :param async_req bool: execute request asynchronously - :param str id: The ID of the dataspecification (required) - :param str custom_query_name: Name of the custom query - :param str username: Username to query - :param _return_http_data_only: response data without head status code - and headers - :param _preload_content: if False, the urllib3.HTTPResponse object will - be returned without reading/decoding response - data. Default is True. - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: tuple(list[DataTransformation], status_code(int), headers(HTTPHeaderDict)) - If the method is called asynchronously, - returns the request thread. - """ - - local_var_params = locals() - - all_params = ['id', 'custom_query_name', 'username'] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method custom_dataspecifications_id_datatransformations_get" % key - ) - local_var_params[key] = val - del local_var_params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in local_var_params or - local_var_params['id'] is None): - raise ApiValueError("Missing the required parameter `id` when calling `custom_dataspecifications_id_datatransformations_get`") # noqa: E501 - - collection_formats = {} - - path_params = {} - if 'id' in local_var_params: - path_params['id'] = local_var_params['id'] # noqa: E501 - - query_params = [] - if 'custom_query_name' in local_var_params: - query_params.append(('custom_query_name', local_var_params['custom_query_name'])) # noqa: E501 - if 'username' in local_var_params: - query_params.append(('username', local_var_params['username'])) # noqa: E501 - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # Authentication setting - auth_settings = [] # noqa: E501 - - return self.api_client.call_api( - '/custom/dataspecifications/{id}/datatransformations', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='list[DataTransformation]', # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _request_timeout=local_var_params.get('_request_timeout'), - collection_formats=collection_formats) - def datatransformations_get(self, **kwargs): # noqa: E501 """List all instances of DataTransformation # noqa: E501 diff --git a/modelcatalog/api/data_transformation_setup_api.py b/modelcatalog/api/data_transformation_setup_api.py index eee36b2..e3047d1 100644 --- a/modelcatalog/api/data_transformation_setup_api.py +++ b/modelcatalog/api/data_transformation_setup_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/dataset_specification_api.py b/modelcatalog/api/dataset_specification_api.py index 5fa1890..c81811e 100644 --- a/modelcatalog/api/dataset_specification_api.py +++ b/modelcatalog/api/dataset_specification_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/default_api.py b/modelcatalog/api/default_api.py index aedfff3..b111e29 100644 --- a/modelcatalog/api/default_api.py +++ b/modelcatalog/api/default_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/empirical_model_api.py b/modelcatalog/api/empirical_model_api.py index d6fc94e..fe8c09d 100644 --- a/modelcatalog/api/empirical_model_api.py +++ b/modelcatalog/api/empirical_model_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/emulator_api.py b/modelcatalog/api/emulator_api.py index 30388c8..51d26f1 100644 --- a/modelcatalog/api/emulator_api.py +++ b/modelcatalog/api/emulator_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/equation_api.py b/modelcatalog/api/equation_api.py index 8d3eb22..852fa00 100644 --- a/modelcatalog/api/equation_api.py +++ b/modelcatalog/api/equation_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/funding_information_api.py b/modelcatalog/api/funding_information_api.py index 0708bad..d0c390f 100644 --- a/modelcatalog/api/funding_information_api.py +++ b/modelcatalog/api/funding_information_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/geo_coordinates_api.py b/modelcatalog/api/geo_coordinates_api.py index 5d85fda..8d58f90 100644 --- a/modelcatalog/api/geo_coordinates_api.py +++ b/modelcatalog/api/geo_coordinates_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/geo_shape_api.py b/modelcatalog/api/geo_shape_api.py index a85de3e..c0107b9 100644 --- a/modelcatalog/api/geo_shape_api.py +++ b/modelcatalog/api/geo_shape_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/grid_api.py b/modelcatalog/api/grid_api.py index 6b93738..5c50f80 100644 --- a/modelcatalog/api/grid_api.py +++ b/modelcatalog/api/grid_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/hybrid_model_api.py b/modelcatalog/api/hybrid_model_api.py index bcf8420..2af4b9c 100644 --- a/modelcatalog/api/hybrid_model_api.py +++ b/modelcatalog/api/hybrid_model_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/image_api.py b/modelcatalog/api/image_api.py index 0e4db2e..a5e9668 100644 --- a/modelcatalog/api/image_api.py +++ b/modelcatalog/api/image_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/intervention_api.py b/modelcatalog/api/intervention_api.py index 6ee72ce..3a40b4b 100644 --- a/modelcatalog/api/intervention_api.py +++ b/modelcatalog/api/intervention_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/model_api.py b/modelcatalog/api/model_api.py index 780e8d3..84745c2 100644 --- a/modelcatalog/api/model_api.py +++ b/modelcatalog/api/model_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/model_category_api.py b/modelcatalog/api/model_category_api.py new file mode 100644 index 0000000..7633ffe --- /dev/null +++ b/modelcatalog/api/model_category_api.py @@ -0,0 +1,621 @@ +# coding: utf-8 + +""" + Model Catalog + + This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 + + The version of the OpenAPI document: v1.6.0 + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import re # noqa: F401 + +# python 2 and python 3 compatibility library +import six + +from modelcatalog.api_client import ApiClient +from modelcatalog.exceptions import ( + ApiTypeError, + ApiValueError +) + + +class ModelCategoryApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def modelcategorys_get(self, **kwargs): # noqa: E501 + """List all instances of ModelCategory # noqa: E501 + + Gets a list of all instances of ModelCategory (more information in https://w3id.org/okn/o/sdm#ModelCategory) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.modelcategorys_get(async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str username: Name of the user graph to query + :param str label: Filter by label + :param int page: Page number + :param int per_page: Items per page + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: list[ModelCategory] + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.modelcategorys_get_with_http_info(**kwargs) # noqa: E501 + + def modelcategorys_get_with_http_info(self, **kwargs): # noqa: E501 + """List all instances of ModelCategory # noqa: E501 + + Gets a list of all instances of ModelCategory (more information in https://w3id.org/okn/o/sdm#ModelCategory) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.modelcategorys_get_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str username: Name of the user graph to query + :param str label: Filter by label + :param int page: Page number + :param int per_page: Items per page + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(list[ModelCategory], status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = ['username', 'label', 'page', 'per_page'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method modelcategorys_get" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + + if 'per_page' in local_var_params and local_var_params['per_page'] > 200: # noqa: E501 + raise ApiValueError("Invalid value for parameter `per_page` when calling `modelcategorys_get`, must be a value less than or equal to `200`") # noqa: E501 + if 'per_page' in local_var_params and local_var_params['per_page'] < 1: # noqa: E501 + raise ApiValueError("Invalid value for parameter `per_page` when calling `modelcategorys_get`, must be a value greater than or equal to `1`") # noqa: E501 + collection_formats = {} + + path_params = {} + + query_params = [] + if 'username' in local_var_params: + query_params.append(('username', local_var_params['username'])) # noqa: E501 + if 'label' in local_var_params: + query_params.append(('label', local_var_params['label'])) # noqa: E501 + if 'page' in local_var_params: + query_params.append(('page', local_var_params['page'])) # noqa: E501 + if 'per_page' in local_var_params: + query_params.append(('per_page', local_var_params['per_page'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = [] # noqa: E501 + + return self.api_client.call_api( + '/modelcategorys', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='list[ModelCategory]', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def modelcategorys_id_delete(self, id, user, **kwargs): # noqa: E501 + """Delete an existing ModelCategory # noqa: E501 + + Delete an existing ModelCategory (more information in https://w3id.org/okn/o/sdm#ModelCategory) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.modelcategorys_id_delete(id, user, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str id: The ID of the ModelCategory to be retrieved (required) + :param str user: Username (required) + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.modelcategorys_id_delete_with_http_info(id, user, **kwargs) # noqa: E501 + + def modelcategorys_id_delete_with_http_info(self, id, user, **kwargs): # noqa: E501 + """Delete an existing ModelCategory # noqa: E501 + + Delete an existing ModelCategory (more information in https://w3id.org/okn/o/sdm#ModelCategory) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.modelcategorys_id_delete_with_http_info(id, user, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str id: The ID of the ModelCategory to be retrieved (required) + :param str user: Username (required) + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = ['id', 'user'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method modelcategorys_id_delete" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in local_var_params or + local_var_params['id'] is None): + raise ApiValueError("Missing the required parameter `id` when calling `modelcategorys_id_delete`") # noqa: E501 + # verify the required parameter 'user' is set + if ('user' not in local_var_params or + local_var_params['user'] is None): + raise ApiValueError("Missing the required parameter `user` when calling `modelcategorys_id_delete`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in local_var_params: + path_params['id'] = local_var_params['id'] # noqa: E501 + if 'user' in local_var_params: + path_params['user'] = local_var_params['user'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['BearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/modelcategorys/{id}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def modelcategorys_id_get(self, id, **kwargs): # noqa: E501 + """Get a single ModelCategory by its id # noqa: E501 + + Gets the details of a given ModelCategory (more information in https://w3id.org/okn/o/sdm#ModelCategory) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.modelcategorys_id_get(id, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str id: The ID of the ModelCategory to be retrieved (required) + :param str username: Name of the user graph to query + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: ModelCategory + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.modelcategorys_id_get_with_http_info(id, **kwargs) # noqa: E501 + + def modelcategorys_id_get_with_http_info(self, id, **kwargs): # noqa: E501 + """Get a single ModelCategory by its id # noqa: E501 + + Gets the details of a given ModelCategory (more information in https://w3id.org/okn/o/sdm#ModelCategory) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.modelcategorys_id_get_with_http_info(id, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str id: The ID of the ModelCategory to be retrieved (required) + :param str username: Name of the user graph to query + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(ModelCategory, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = ['id', 'username'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method modelcategorys_id_get" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in local_var_params or + local_var_params['id'] is None): + raise ApiValueError("Missing the required parameter `id` when calling `modelcategorys_id_get`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in local_var_params: + path_params['id'] = local_var_params['id'] # noqa: E501 + + query_params = [] + if 'username' in local_var_params: + query_params.append(('username', local_var_params['username'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = [] # noqa: E501 + + return self.api_client.call_api( + '/modelcategorys/{id}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ModelCategory', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def modelcategorys_id_put(self, id, user, **kwargs): # noqa: E501 + """Update an existing ModelCategory # noqa: E501 + + Updates an existing ModelCategory (more information in https://w3id.org/okn/o/sdm#ModelCategory) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.modelcategorys_id_put(id, user, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str id: The ID of the ModelCategory to be retrieved (required) + :param str user: Username (required) + :param ModelCategory model_category: An old ModelCategoryto be updated + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: ModelCategory + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.modelcategorys_id_put_with_http_info(id, user, **kwargs) # noqa: E501 + + def modelcategorys_id_put_with_http_info(self, id, user, **kwargs): # noqa: E501 + """Update an existing ModelCategory # noqa: E501 + + Updates an existing ModelCategory (more information in https://w3id.org/okn/o/sdm#ModelCategory) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.modelcategorys_id_put_with_http_info(id, user, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str id: The ID of the ModelCategory to be retrieved (required) + :param str user: Username (required) + :param ModelCategory model_category: An old ModelCategoryto be updated + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(ModelCategory, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = ['id', 'user', 'model_category'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method modelcategorys_id_put" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in local_var_params or + local_var_params['id'] is None): + raise ApiValueError("Missing the required parameter `id` when calling `modelcategorys_id_put`") # noqa: E501 + # verify the required parameter 'user' is set + if ('user' not in local_var_params or + local_var_params['user'] is None): + raise ApiValueError("Missing the required parameter `user` when calling `modelcategorys_id_put`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in local_var_params: + path_params['id'] = local_var_params['id'] # noqa: E501 + if 'user' in local_var_params: + path_params['user'] = local_var_params['user'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'model_category' in local_var_params: + body_params = local_var_params['model_category'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['BearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/modelcategorys/{id}', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ModelCategory', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def modelcategorys_post(self, user, **kwargs): # noqa: E501 + """Create one ModelCategory # noqa: E501 + + Create a new instance of ModelCategory (more information in https://w3id.org/okn/o/sdm#ModelCategory) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.modelcategorys_post(user, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str user: Username (required) + :param ModelCategory model_category: Information about the ModelCategoryto be created + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: ModelCategory + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.modelcategorys_post_with_http_info(user, **kwargs) # noqa: E501 + + def modelcategorys_post_with_http_info(self, user, **kwargs): # noqa: E501 + """Create one ModelCategory # noqa: E501 + + Create a new instance of ModelCategory (more information in https://w3id.org/okn/o/sdm#ModelCategory) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.modelcategorys_post_with_http_info(user, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str user: Username (required) + :param ModelCategory model_category: Information about the ModelCategoryto be created + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(ModelCategory, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = ['user', 'model_category'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method modelcategorys_post" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'user' is set + if ('user' not in local_var_params or + local_var_params['user'] is None): + raise ApiValueError("Missing the required parameter `user` when calling `modelcategorys_post`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'user' in local_var_params: + path_params['user'] = local_var_params['user'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'model_category' in local_var_params: + body_params = local_var_params['model_category'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['BearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/modelcategorys', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ModelCategory', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/modelcatalog/api/model_configuration_api.py b/modelcatalog/api/model_configuration_api.py index 4f5c8e2..794106c 100644 --- a/modelcatalog/api/model_configuration_api.py +++ b/modelcatalog/api/model_configuration_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/model_configuration_setup_api.py b/modelcatalog/api/model_configuration_setup_api.py index 6f77ca1..419b79a 100644 --- a/modelcatalog/api/model_configuration_setup_api.py +++ b/modelcatalog/api/model_configuration_setup_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/numerical_index_api.py b/modelcatalog/api/numerical_index_api.py index 362a012..2178b74 100644 --- a/modelcatalog/api/numerical_index_api.py +++ b/modelcatalog/api/numerical_index_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/organization_api.py b/modelcatalog/api/organization_api.py index f75c9c1..010e2e4 100644 --- a/modelcatalog/api/organization_api.py +++ b/modelcatalog/api/organization_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/parameter_api.py b/modelcatalog/api/parameter_api.py index b0840d2..61262c0 100644 --- a/modelcatalog/api/parameter_api.py +++ b/modelcatalog/api/parameter_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/person_api.py b/modelcatalog/api/person_api.py index 1a64a42..025bdf6 100644 --- a/modelcatalog/api/person_api.py +++ b/modelcatalog/api/person_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/point_based_grid_api.py b/modelcatalog/api/point_based_grid_api.py index a980c1d..4533c84 100644 --- a/modelcatalog/api/point_based_grid_api.py +++ b/modelcatalog/api/point_based_grid_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/process_api.py b/modelcatalog/api/process_api.py index 33254fb..42d13d2 100644 --- a/modelcatalog/api/process_api.py +++ b/modelcatalog/api/process_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/region_api.py b/modelcatalog/api/region_api.py index 37e705d..ce09505 100644 --- a/modelcatalog/api/region_api.py +++ b/modelcatalog/api/region_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/sample_collection_api.py b/modelcatalog/api/sample_collection_api.py index 0c02178..45008d2 100644 --- a/modelcatalog/api/sample_collection_api.py +++ b/modelcatalog/api/sample_collection_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/sample_execution_api.py b/modelcatalog/api/sample_execution_api.py index 44f3940..76e592c 100644 --- a/modelcatalog/api/sample_execution_api.py +++ b/modelcatalog/api/sample_execution_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/sample_resource_api.py b/modelcatalog/api/sample_resource_api.py index c1e39f3..32955e7 100644 --- a/modelcatalog/api/sample_resource_api.py +++ b/modelcatalog/api/sample_resource_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/software_api.py b/modelcatalog/api/software_api.py index b8df44a..ba2e94c 100644 --- a/modelcatalog/api/software_api.py +++ b/modelcatalog/api/software_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/software_configuration_api.py b/modelcatalog/api/software_configuration_api.py index 4b56883..094c707 100644 --- a/modelcatalog/api/software_configuration_api.py +++ b/modelcatalog/api/software_configuration_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/software_image_api.py b/modelcatalog/api/software_image_api.py index d730c73..1eb0cf0 100644 --- a/modelcatalog/api/software_image_api.py +++ b/modelcatalog/api/software_image_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/software_version_api.py b/modelcatalog/api/software_version_api.py index 46e2111..7fa3ac2 100644 --- a/modelcatalog/api/software_version_api.py +++ b/modelcatalog/api/software_version_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/source_code_api.py b/modelcatalog/api/source_code_api.py index 33af7aa..d8548f5 100644 --- a/modelcatalog/api/source_code_api.py +++ b/modelcatalog/api/source_code_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/spatial_resolution_api.py b/modelcatalog/api/spatial_resolution_api.py index 5232d51..d8ee441 100644 --- a/modelcatalog/api/spatial_resolution_api.py +++ b/modelcatalog/api/spatial_resolution_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/spatially_distributed_grid_api.py b/modelcatalog/api/spatially_distributed_grid_api.py index 500254a..53f4180 100644 --- a/modelcatalog/api/spatially_distributed_grid_api.py +++ b/modelcatalog/api/spatially_distributed_grid_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/standard_variable_api.py b/modelcatalog/api/standard_variable_api.py index 8a61bd1..711e999 100644 --- a/modelcatalog/api/standard_variable_api.py +++ b/modelcatalog/api/standard_variable_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/theory_guided_model_api.py b/modelcatalog/api/theory_guided_model_api.py index 0f9e6f4..8709f5c 100644 --- a/modelcatalog/api/theory_guided_model_api.py +++ b/modelcatalog/api/theory_guided_model_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/time_interval_api.py b/modelcatalog/api/time_interval_api.py index 65cff53..9688f08 100644 --- a/modelcatalog/api/time_interval_api.py +++ b/modelcatalog/api/time_interval_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/unit_api.py b/modelcatalog/api/unit_api.py index b5026b1..ec4de77 100644 --- a/modelcatalog/api/unit_api.py +++ b/modelcatalog/api/unit_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/variable_api.py b/modelcatalog/api/variable_api.py index e9d3a7d..fbee9f2 100644 --- a/modelcatalog/api/variable_api.py +++ b/modelcatalog/api/variable_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/variable_presentation_api.py b/modelcatalog/api/variable_presentation_api.py index d1a8166..3cf7fea 100644 --- a/modelcatalog/api/variable_presentation_api.py +++ b/modelcatalog/api/variable_presentation_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api/visualization_api.py b/modelcatalog/api/visualization_api.py index 47006b2..e9bd6a7 100644 --- a/modelcatalog/api/visualization_api.py +++ b/modelcatalog/api/visualization_api.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/api_client.py b/modelcatalog/api_client.py index fae2c4d..dbfe38f 100644 --- a/modelcatalog/api_client.py +++ b/modelcatalog/api_client.py @@ -4,7 +4,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/configuration.py b/modelcatalog/configuration.py index 976e39a..20552d4 100644 --- a/modelcatalog/configuration.py +++ b/modelcatalog/configuration.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ @@ -49,7 +49,7 @@ class Configuration(six.with_metaclass(TypeWithDefault, object)): :param password: Password for HTTP basic authentication """ - def __init__(self, host="https://api.models.mint.isi.edu/v1.5.0", + def __init__(self, host="https://api.models.mint.isi.edu/v1.6.0", api_key={}, api_key_prefix={}, username="", password=""): """Constructor @@ -273,7 +273,7 @@ def to_debug_report(self): return "Python SDK Debug Report:\n"\ "OS: {env}\n"\ "Python Version: {pyversion}\n"\ - "Version of the API: v1.5.0\n"\ + "Version of the API: v1.6.0\n"\ "SDK Package Version: 5.0.0".\ format(env=sys.platform, pyversion=sys.version) @@ -284,15 +284,15 @@ def get_host_settings(self): """ return [ { - 'url': "https://api.models.mint.isi.edu/v1.5.0", + 'url': "https://api.models.mint.isi.edu/v1.6.0", 'description': "No description provided", }, { - 'url': "https://dev.api.models.mint.isi.edu/v1.5.0", + 'url': "https://dev.api.models.mint.isi.edu/v1.6.0", 'description': "No description provided", }, { - 'url': "http://localhost:8080/v1.5.0", + 'url': "http://localhost:8080/v1.6.0", 'description': "No description provided", } ] diff --git a/modelcatalog/exceptions.py b/modelcatalog/exceptions.py index 233e7d6..1570ec2 100644 --- a/modelcatalog/exceptions.py +++ b/modelcatalog/exceptions.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/models/__init__.py b/modelcatalog/models/__init__.py index 33c40db..7a9d60e 100644 --- a/modelcatalog/models/__init__.py +++ b/modelcatalog/models/__init__.py @@ -6,7 +6,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ @@ -14,8 +14,10 @@ from __future__ import absolute_import # import models into model package +from modelcatalog.models.catalog_identifier import CatalogIdentifier from modelcatalog.models.causal_diagram import CausalDiagram from modelcatalog.models.configuration_setup import ConfigurationSetup +from modelcatalog.models.coupled_model import CoupledModel from modelcatalog.models.data_transformation import DataTransformation from modelcatalog.models.data_transformation_setup import DataTransformationSetup from modelcatalog.models.dataset_specification import DatasetSpecification @@ -30,6 +32,7 @@ from modelcatalog.models.image import Image from modelcatalog.models.intervention import Intervention from modelcatalog.models.model import Model +from modelcatalog.models.model_category import ModelCategory from modelcatalog.models.model_configuration import ModelConfiguration from modelcatalog.models.model_configuration_setup import ModelConfigurationSetup from modelcatalog.models.numerical_index import NumericalIndex diff --git a/modelcatalog/models/catalog_identifier.py b/modelcatalog/models/catalog_identifier.py new file mode 100644 index 0000000..64365ba --- /dev/null +++ b/modelcatalog/models/catalog_identifier.py @@ -0,0 +1,546 @@ +# coding: utf-8 + +""" + Model Catalog + + This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 + + The version of the OpenAPI document: v1.6.0 + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + + +class CatalogIdentifier(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'has_default_value': 'list[object]', + 'has_maximum_accepted_value': 'list[object]', + 'description': 'list[str]', + 'has_data_type': 'list[str]', + 'has_fixed_value': 'list[object]', + 'has_presentation': 'list[VariablePresentation]', + 'label': 'list[str]', + 'recommended_increment': 'list[float]', + 'type': 'list[str]', + 'has_minimum_accepted_value': 'list[object]', + 'has_accepted_values': 'list[str]', + 'adjusts_variable': 'list[Variable]', + 'relevant_for_intervention': 'list[Intervention]', + 'position': 'list[int]', + 'id': 'str', + 'uses_unit': 'list[Unit]', + 'has_step_size': 'list[float]' + } + + attribute_map = { + 'has_default_value': 'hasDefaultValue', + 'has_maximum_accepted_value': 'hasMaximumAcceptedValue', + 'description': 'description', + 'has_data_type': 'hasDataType', + 'has_fixed_value': 'hasFixedValue', + 'has_presentation': 'hasPresentation', + 'label': 'label', + 'recommended_increment': 'recommendedIncrement', + 'type': 'type', + 'has_minimum_accepted_value': 'hasMinimumAcceptedValue', + 'has_accepted_values': 'hasAcceptedValues', + 'adjusts_variable': 'adjustsVariable', + 'relevant_for_intervention': 'relevantForIntervention', + 'position': 'position', + 'id': 'id', + 'uses_unit': 'usesUnit', + 'has_step_size': 'hasStepSize' + } + + def __init__(self, has_default_value=None, has_maximum_accepted_value=None, description=None, has_data_type=None, has_fixed_value=None, has_presentation=None, label=None, recommended_increment=None, type=None, has_minimum_accepted_value=None, has_accepted_values=None, adjusts_variable=None, relevant_for_intervention=None, position=None, id=None, uses_unit=None, has_step_size=None): # noqa: E501 + """CatalogIdentifier - a model defined in OpenAPI""" # noqa: E501 + + self._has_default_value = None + self._has_maximum_accepted_value = None + self._description = None + self._has_data_type = None + self._has_fixed_value = None + self._has_presentation = None + self._label = None + self._recommended_increment = None + self._type = None + self._has_minimum_accepted_value = None + self._has_accepted_values = None + self._adjusts_variable = None + self._relevant_for_intervention = None + self._position = None + self._id = None + self._uses_unit = None + self._has_step_size = None + self.discriminator = None + + self.has_default_value = has_default_value + self.has_maximum_accepted_value = has_maximum_accepted_value + self.description = description + self.has_data_type = has_data_type + self.has_fixed_value = has_fixed_value + self.has_presentation = has_presentation + self.label = label + self.recommended_increment = recommended_increment + self.type = type + self.has_minimum_accepted_value = has_minimum_accepted_value + self.has_accepted_values = has_accepted_values + self.adjusts_variable = adjusts_variable + self.relevant_for_intervention = relevant_for_intervention + self.position = position + if id is not None: + self.id = id + self.uses_unit = uses_unit + self.has_step_size = has_step_size + + @property + def has_default_value(self): + """Gets the has_default_value of this CatalogIdentifier. # noqa: E501 + + Default accepted value of a variable presentation (or a parameter) # noqa: E501 + + :return: The has_default_value of this CatalogIdentifier. # noqa: E501 + :rtype: list[object] + """ + return self._has_default_value + + @has_default_value.setter + def has_default_value(self, has_default_value): + """Sets the has_default_value of this CatalogIdentifier. + + Default accepted value of a variable presentation (or a parameter) # noqa: E501 + + :param has_default_value: The has_default_value of this CatalogIdentifier. # noqa: E501 + :type: list[object] + """ + + self._has_default_value = has_default_value + + @property + def has_maximum_accepted_value(self): + """Gets the has_maximum_accepted_value of this CatalogIdentifier. # noqa: E501 + + Maximum accepted value of a variable presentation (or a parameter) # noqa: E501 + + :return: The has_maximum_accepted_value of this CatalogIdentifier. # noqa: E501 + :rtype: list[object] + """ + return self._has_maximum_accepted_value + + @has_maximum_accepted_value.setter + def has_maximum_accepted_value(self, has_maximum_accepted_value): + """Sets the has_maximum_accepted_value of this CatalogIdentifier. + + Maximum accepted value of a variable presentation (or a parameter) # noqa: E501 + + :param has_maximum_accepted_value: The has_maximum_accepted_value of this CatalogIdentifier. # noqa: E501 + :type: list[object] + """ + + self._has_maximum_accepted_value = has_maximum_accepted_value + + @property + def description(self): + """Gets the description of this CatalogIdentifier. # noqa: E501 + + small description # noqa: E501 + + :return: The description of this CatalogIdentifier. # noqa: E501 + :rtype: list[str] + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this CatalogIdentifier. + + small description # noqa: E501 + + :param description: The description of this CatalogIdentifier. # noqa: E501 + :type: list[str] + """ + + self._description = description + + @property + def has_data_type(self): + """Gets the has_data_type of this CatalogIdentifier. # noqa: E501 + + Property that indicates the data type of a parameter # noqa: E501 + + :return: The has_data_type of this CatalogIdentifier. # noqa: E501 + :rtype: list[str] + """ + return self._has_data_type + + @has_data_type.setter + def has_data_type(self, has_data_type): + """Sets the has_data_type of this CatalogIdentifier. + + Property that indicates the data type of a parameter # noqa: E501 + + :param has_data_type: The has_data_type of this CatalogIdentifier. # noqa: E501 + :type: list[str] + """ + + self._has_data_type = has_data_type + + @property + def has_fixed_value(self): + """Gets the has_fixed_value of this CatalogIdentifier. # noqa: E501 + + Value of a parameter in a software setup. # noqa: E501 + + :return: The has_fixed_value of this CatalogIdentifier. # noqa: E501 + :rtype: list[object] + """ + return self._has_fixed_value + + @has_fixed_value.setter + def has_fixed_value(self, has_fixed_value): + """Sets the has_fixed_value of this CatalogIdentifier. + + Value of a parameter in a software setup. # noqa: E501 + + :param has_fixed_value: The has_fixed_value of this CatalogIdentifier. # noqa: E501 + :type: list[object] + """ + + self._has_fixed_value = has_fixed_value + + @property + def has_presentation(self): + """Gets the has_presentation of this CatalogIdentifier. # noqa: E501 + + Property that links an instance of a dataset (or a dataset specification) to the presentation of a variable contained (or expected to be contained) on it. # noqa: E501 + + :return: The has_presentation of this CatalogIdentifier. # noqa: E501 + :rtype: list[VariablePresentation] + """ + return self._has_presentation + + @has_presentation.setter + def has_presentation(self, has_presentation): + """Sets the has_presentation of this CatalogIdentifier. + + Property that links an instance of a dataset (or a dataset specification) to the presentation of a variable contained (or expected to be contained) on it. # noqa: E501 + + :param has_presentation: The has_presentation of this CatalogIdentifier. # noqa: E501 + :type: list[VariablePresentation] + """ + + self._has_presentation = has_presentation + + @property + def label(self): + """Gets the label of this CatalogIdentifier. # noqa: E501 + + short description of the resource # noqa: E501 + + :return: The label of this CatalogIdentifier. # noqa: E501 + :rtype: list[str] + """ + return self._label + + @label.setter + def label(self, label): + """Sets the label of this CatalogIdentifier. + + short description of the resource # noqa: E501 + + :param label: The label of this CatalogIdentifier. # noqa: E501 + :type: list[str] + """ + + self._label = label + + @property + def recommended_increment(self): + """Gets the recommended_increment of this CatalogIdentifier. # noqa: E501 + + Value that represents how a parameter should be incremented on each iteration of a software component execution. This value is important when preparing execution ensembles automatically, e.g., simulating crop production varying the parameter \"fertilizer amount\" in increments of 10%. # noqa: E501 + + :return: The recommended_increment of this CatalogIdentifier. # noqa: E501 + :rtype: list[float] + """ + return self._recommended_increment + + @recommended_increment.setter + def recommended_increment(self, recommended_increment): + """Sets the recommended_increment of this CatalogIdentifier. + + Value that represents how a parameter should be incremented on each iteration of a software component execution. This value is important when preparing execution ensembles automatically, e.g., simulating crop production varying the parameter \"fertilizer amount\" in increments of 10%. # noqa: E501 + + :param recommended_increment: The recommended_increment of this CatalogIdentifier. # noqa: E501 + :type: list[float] + """ + + self._recommended_increment = recommended_increment + + @property + def type(self): + """Gets the type of this CatalogIdentifier. # noqa: E501 + + type of the resource # noqa: E501 + + :return: The type of this CatalogIdentifier. # noqa: E501 + :rtype: list[str] + """ + return self._type + + @type.setter + def type(self, type): + """Sets the type of this CatalogIdentifier. + + type of the resource # noqa: E501 + + :param type: The type of this CatalogIdentifier. # noqa: E501 + :type: list[str] + """ + + self._type = type + + @property + def has_minimum_accepted_value(self): + """Gets the has_minimum_accepted_value of this CatalogIdentifier. # noqa: E501 + + Minimum accepted value of a variable presentation (or a parameter) # noqa: E501 + + :return: The has_minimum_accepted_value of this CatalogIdentifier. # noqa: E501 + :rtype: list[object] + """ + return self._has_minimum_accepted_value + + @has_minimum_accepted_value.setter + def has_minimum_accepted_value(self, has_minimum_accepted_value): + """Sets the has_minimum_accepted_value of this CatalogIdentifier. + + Minimum accepted value of a variable presentation (or a parameter) # noqa: E501 + + :param has_minimum_accepted_value: The has_minimum_accepted_value of this CatalogIdentifier. # noqa: E501 + :type: list[object] + """ + + self._has_minimum_accepted_value = has_minimum_accepted_value + + @property + def has_accepted_values(self): + """Gets the has_accepted_values of this CatalogIdentifier. # noqa: E501 + + Property that constraints which values are accepted for a parameter. For example, the name of a crop can only be \"Maize\" or \"Sorghum\" # noqa: E501 + + :return: The has_accepted_values of this CatalogIdentifier. # noqa: E501 + :rtype: list[str] + """ + return self._has_accepted_values + + @has_accepted_values.setter + def has_accepted_values(self, has_accepted_values): + """Sets the has_accepted_values of this CatalogIdentifier. + + Property that constraints which values are accepted for a parameter. For example, the name of a crop can only be \"Maize\" or \"Sorghum\" # noqa: E501 + + :param has_accepted_values: The has_accepted_values of this CatalogIdentifier. # noqa: E501 + :type: list[str] + """ + + self._has_accepted_values = has_accepted_values + + @property + def adjusts_variable(self): + """Gets the adjusts_variable of this CatalogIdentifier. # noqa: E501 + + Property that links parameter with the variable they adjust. This property can be used when parameters quantify variables without directly representing them. For example, a \"fertilizer percentage adjustment\" parameter can quantify a \"fertilizer price\" variable # noqa: E501 + + :return: The adjusts_variable of this CatalogIdentifier. # noqa: E501 + :rtype: list[Variable] + """ + return self._adjusts_variable + + @adjusts_variable.setter + def adjusts_variable(self, adjusts_variable): + """Sets the adjusts_variable of this CatalogIdentifier. + + Property that links parameter with the variable they adjust. This property can be used when parameters quantify variables without directly representing them. For example, a \"fertilizer percentage adjustment\" parameter can quantify a \"fertilizer price\" variable # noqa: E501 + + :param adjusts_variable: The adjusts_variable of this CatalogIdentifier. # noqa: E501 + :type: list[Variable] + """ + + self._adjusts_variable = adjusts_variable + + @property + def relevant_for_intervention(self): + """Gets the relevant_for_intervention of this CatalogIdentifier. # noqa: E501 + + Description not available # noqa: E501 + + :return: The relevant_for_intervention of this CatalogIdentifier. # noqa: E501 + :rtype: list[Intervention] + """ + return self._relevant_for_intervention + + @relevant_for_intervention.setter + def relevant_for_intervention(self, relevant_for_intervention): + """Sets the relevant_for_intervention of this CatalogIdentifier. + + Description not available # noqa: E501 + + :param relevant_for_intervention: The relevant_for_intervention of this CatalogIdentifier. # noqa: E501 + :type: list[Intervention] + """ + + self._relevant_for_intervention = relevant_for_intervention + + @property + def position(self): + """Gets the position of this CatalogIdentifier. # noqa: E501 + + Position of the parameter or input/output in the model configuration. This property is needed to know how to organize the I/O of the component on execution # noqa: E501 + + :return: The position of this CatalogIdentifier. # noqa: E501 + :rtype: list[int] + """ + return self._position + + @position.setter + def position(self, position): + """Sets the position of this CatalogIdentifier. + + Position of the parameter or input/output in the model configuration. This property is needed to know how to organize the I/O of the component on execution # noqa: E501 + + :param position: The position of this CatalogIdentifier. # noqa: E501 + :type: list[int] + """ + + self._position = position + + @property + def id(self): + """Gets the id of this CatalogIdentifier. # noqa: E501 + + identifier # noqa: E501 + + :return: The id of this CatalogIdentifier. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this CatalogIdentifier. + + identifier # noqa: E501 + + :param id: The id of this CatalogIdentifier. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def uses_unit(self): + """Gets the uses_unit of this CatalogIdentifier. # noqa: E501 + + Property used to link a variable presentation or time interval to the unit they are represented in # noqa: E501 + + :return: The uses_unit of this CatalogIdentifier. # noqa: E501 + :rtype: list[Unit] + """ + return self._uses_unit + + @uses_unit.setter + def uses_unit(self, uses_unit): + """Sets the uses_unit of this CatalogIdentifier. + + Property used to link a variable presentation or time interval to the unit they are represented in # noqa: E501 + + :param uses_unit: The uses_unit of this CatalogIdentifier. # noqa: E501 + :type: list[Unit] + """ + + self._uses_unit = uses_unit + + @property + def has_step_size(self): + """Gets the has_step_size of this CatalogIdentifier. # noqa: E501 + + Property that determines what are the increments (step size) that are commonly used to vary a parameter. This is commonly used for automatically setting up software tests. For example, if I want to set up a model and try 30 reasonable values on a parameter, I may use the default value and the step size to create the appropriate increments. If the step size is 0.1 and the default value is 0, then I will will be able to create setups: 0, 0.1, 0.2...2.9,3 # noqa: E501 + + :return: The has_step_size of this CatalogIdentifier. # noqa: E501 + :rtype: list[float] + """ + return self._has_step_size + + @has_step_size.setter + def has_step_size(self, has_step_size): + """Sets the has_step_size of this CatalogIdentifier. + + Property that determines what are the increments (step size) that are commonly used to vary a parameter. This is commonly used for automatically setting up software tests. For example, if I want to set up a model and try 30 reasonable values on a parameter, I may use the default value and the step size to create the appropriate increments. If the step size is 0.1 and the default value is 0, then I will will be able to create setups: 0, 0.1, 0.2...2.9,3 # noqa: E501 + + :param has_step_size: The has_step_size of this CatalogIdentifier. # noqa: E501 + :type: list[float] + """ + + self._has_step_size = has_step_size + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CatalogIdentifier): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/modelcatalog/models/causal_diagram.py b/modelcatalog/models/causal_diagram.py index a742d66..545f9b0 100644 --- a/modelcatalog/models/causal_diagram.py +++ b/modelcatalog/models/causal_diagram.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/models/configuration_setup.py b/modelcatalog/models/configuration_setup.py index 015c289..869469c 100644 --- a/modelcatalog/models/configuration_setup.py +++ b/modelcatalog/models/configuration_setup.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ @@ -50,6 +50,7 @@ class ConfigurationSetup(object): 'has_sample_execution': 'list[SampleExecution]', 'has_sample_result': 'list[SampleResource]', 'author': 'list[object]', + 'was_derived_from_setup': 'list[ConfigurationSetup]', 'has_constraint': 'list[str]', 'has_build_file': 'list[str]', 'short_description': 'list[str]', @@ -61,6 +62,7 @@ class ConfigurationSetup(object): 'has_example': 'list[str]', 'publisher': 'list[object]', 'has_output': 'list[DatasetSpecification]', + 'status': 'list[str]', 'doi': 'list[str]', 'has_funding': 'list[FundingInformation]', 'has_component_location': 'list[str]', @@ -115,6 +117,7 @@ class ConfigurationSetup(object): 'has_sample_execution': 'hasSampleExecution', 'has_sample_result': 'hasSampleResult', 'author': 'author', + 'was_derived_from_setup': 'wasDerivedFromSetup', 'has_constraint': 'hasConstraint', 'has_build_file': 'hasBuildFile', 'short_description': 'shortDescription', @@ -126,6 +129,7 @@ class ConfigurationSetup(object): 'has_example': 'hasExample', 'publisher': 'publisher', 'has_output': 'hasOutput', + 'status': 'status', 'doi': 'doi', 'has_funding': 'hasFunding', 'has_component_location': 'hasComponentLocation', @@ -160,7 +164,7 @@ class ConfigurationSetup(object): 'has_input': 'hasInput' } - def __init__(self, has_download_instructions=None, keywords=None, has_documentation=None, has_implementation_script_location=None, software_requirements=None, has_download_url=None, type=None, has_installation_instructions=None, compatible_visualization_software=None, copyright_holder=None, has_faq=None, logo=None, has_contact_person=None, tag=None, id=None, identifier=None, has_sample_execution=None, has_sample_result=None, author=None, has_constraint=None, has_build_file=None, short_description=None, has_execution_command=None, date_published=None, license=None, has_source_code=None, has_setup=None, has_example=None, publisher=None, has_output=None, doi=None, has_funding=None, has_component_location=None, support_details=None, has_version=None, has_typical_data_source=None, description=None, reference_publication=None, screenshot=None, had_primary_source=None, issue_tracker=None, has_software_image=None, date_created=None, contributor=None, has_purpose=None, has_executable_instructions=None, has_sample_visualization=None, memory_requirements=None, website=None, citation=None, processor_requirements=None, adjustable_parameter=None, has_usage_notes=None, has_support_script_location=None, readme=None, label=None, has_assumption=None, has_parameter=None, operating_systems=None, has_executable_notebook=None, useful_for_calculating_index=None, has_input=None): # noqa: E501 + def __init__(self, has_download_instructions=None, keywords=None, has_documentation=None, has_implementation_script_location=None, software_requirements=None, has_download_url=None, type=None, has_installation_instructions=None, compatible_visualization_software=None, copyright_holder=None, has_faq=None, logo=None, has_contact_person=None, tag=None, id=None, identifier=None, has_sample_execution=None, has_sample_result=None, author=None, was_derived_from_setup=None, has_constraint=None, has_build_file=None, short_description=None, has_execution_command=None, date_published=None, license=None, has_source_code=None, has_setup=None, has_example=None, publisher=None, has_output=None, status=None, doi=None, has_funding=None, has_component_location=None, support_details=None, has_version=None, has_typical_data_source=None, description=None, reference_publication=None, screenshot=None, had_primary_source=None, issue_tracker=None, has_software_image=None, date_created=None, contributor=None, has_purpose=None, has_executable_instructions=None, has_sample_visualization=None, memory_requirements=None, website=None, citation=None, processor_requirements=None, adjustable_parameter=None, has_usage_notes=None, has_support_script_location=None, readme=None, label=None, has_assumption=None, has_parameter=None, operating_systems=None, has_executable_notebook=None, useful_for_calculating_index=None, has_input=None): # noqa: E501 """ConfigurationSetup - a model defined in OpenAPI""" # noqa: E501 self._has_download_instructions = None @@ -182,6 +186,7 @@ def __init__(self, has_download_instructions=None, keywords=None, has_documentat self._has_sample_execution = None self._has_sample_result = None self._author = None + self._was_derived_from_setup = None self._has_constraint = None self._has_build_file = None self._short_description = None @@ -193,6 +198,7 @@ def __init__(self, has_download_instructions=None, keywords=None, has_documentat self._has_example = None self._publisher = None self._has_output = None + self._status = None self._doi = None self._has_funding = None self._has_component_location = None @@ -247,6 +253,7 @@ def __init__(self, has_download_instructions=None, keywords=None, has_documentat self.has_sample_execution = has_sample_execution self.has_sample_result = has_sample_result self.author = author + self.was_derived_from_setup = was_derived_from_setup self.has_constraint = has_constraint self.has_build_file = has_build_file self.short_description = short_description @@ -258,6 +265,7 @@ def __init__(self, has_download_instructions=None, keywords=None, has_documentat self.has_example = has_example self.publisher = publisher self.has_output = has_output + self.status = status self.doi = doi self.has_funding = has_funding self.has_component_location = has_component_location @@ -387,7 +395,7 @@ def has_implementation_script_location(self, has_implementation_script_location) def software_requirements(self): """Gets the software_requirements of this ConfigurationSetup. # noqa: E501 - Description not available # noqa: E501 + Software requirements needed to install a software component # noqa: E501 :return: The software_requirements of this ConfigurationSetup. # noqa: E501 :rtype: list[str] @@ -398,7 +406,7 @@ def software_requirements(self): def software_requirements(self, software_requirements): """Sets the software_requirements of this ConfigurationSetup. - Description not available # noqa: E501 + Software requirements needed to install a software component # noqa: E501 :param software_requirements: The software_requirements of this ConfigurationSetup. # noqa: E501 :type: list[str] @@ -502,7 +510,7 @@ def compatible_visualization_software(self, compatible_visualization_software): def copyright_holder(self): """Gets the copyright_holder of this ConfigurationSetup. # noqa: E501 - Description not available # noqa: E501 + Copyright holder for a software component # noqa: E501 :return: The copyright_holder of this ConfigurationSetup. # noqa: E501 :rtype: list[object] @@ -513,7 +521,7 @@ def copyright_holder(self): def copyright_holder(self, copyright_holder): """Sets the copyright_holder of this ConfigurationSetup. - Description not available # noqa: E501 + Copyright holder for a software component # noqa: E501 :param copyright_holder: The copyright_holder of this ConfigurationSetup. # noqa: E501 :type: list[object] @@ -548,7 +556,7 @@ def has_faq(self, has_faq): def logo(self): """Gets the logo of this ConfigurationSetup. # noqa: E501 - Description not available # noqa: E501 + Property that links to the image used as logo for a software component # noqa: E501 :return: The logo of this ConfigurationSetup. # noqa: E501 :rtype: list[Image] @@ -559,7 +567,7 @@ def logo(self): def logo(self, logo): """Sets the logo of this ConfigurationSetup. - Description not available # noqa: E501 + Property that links to the image used as logo for a software component # noqa: E501 :param logo: The logo of this ConfigurationSetup. # noqa: E501 :type: list[Image] @@ -571,7 +579,7 @@ def logo(self, logo): def has_contact_person(self): """Gets the has_contact_person of this ConfigurationSetup. # noqa: E501 - Description not available # noqa: E501 + Contact person responsible for a software component # noqa: E501 :return: The has_contact_person of this ConfigurationSetup. # noqa: E501 :rtype: list[object] @@ -582,7 +590,7 @@ def has_contact_person(self): def has_contact_person(self, has_contact_person): """Sets the has_contact_person of this ConfigurationSetup. - Description not available # noqa: E501 + Contact person responsible for a software component # noqa: E501 :param has_contact_person: The has_contact_person of this ConfigurationSetup. # noqa: E501 :type: list[object] @@ -663,7 +671,7 @@ def identifier(self, identifier): def has_sample_execution(self): """Gets the has_sample_execution of this ConfigurationSetup. # noqa: E501 - Description not available # noqa: E501 + Property pointing to a sample execution of a software configuration # noqa: E501 :return: The has_sample_execution of this ConfigurationSetup. # noqa: E501 :rtype: list[SampleExecution] @@ -674,7 +682,7 @@ def has_sample_execution(self): def has_sample_execution(self, has_sample_execution): """Sets the has_sample_execution of this ConfigurationSetup. - Description not available # noqa: E501 + Property pointing to a sample execution of a software configuration # noqa: E501 :param has_sample_execution: The has_sample_execution of this ConfigurationSetup. # noqa: E501 :type: list[SampleExecution] @@ -686,7 +694,7 @@ def has_sample_execution(self, has_sample_execution): def has_sample_result(self): """Gets the has_sample_result of this ConfigurationSetup. # noqa: E501 - Description not available # noqa: E501 + Property designed to link a software configuration to a sample resource resulting from its execution # noqa: E501 :return: The has_sample_result of this ConfigurationSetup. # noqa: E501 :rtype: list[SampleResource] @@ -697,7 +705,7 @@ def has_sample_result(self): def has_sample_result(self, has_sample_result): """Sets the has_sample_result of this ConfigurationSetup. - Description not available # noqa: E501 + Property designed to link a software configuration to a sample resource resulting from its execution # noqa: E501 :param has_sample_result: The has_sample_result of this ConfigurationSetup. # noqa: E501 :type: list[SampleResource] @@ -709,7 +717,7 @@ def has_sample_result(self, has_sample_result): def author(self): """Gets the author of this ConfigurationSetup. # noqa: E501 - Description not available # noqa: E501 + The creator of a software component # noqa: E501 :return: The author of this ConfigurationSetup. # noqa: E501 :rtype: list[object] @@ -720,7 +728,7 @@ def author(self): def author(self, author): """Sets the author of this ConfigurationSetup. - Description not available # noqa: E501 + The creator of a software component # noqa: E501 :param author: The author of this ConfigurationSetup. # noqa: E501 :type: list[object] @@ -728,6 +736,29 @@ def author(self, author): self._author = author + @property + def was_derived_from_setup(self): + """Gets the was_derived_from_setup of this ConfigurationSetup. # noqa: E501 + + Property that links a setup to a previous version of that setup. This property is needed (for example) when creating snapshots of setups. # noqa: E501 + + :return: The was_derived_from_setup of this ConfigurationSetup. # noqa: E501 + :rtype: list[ConfigurationSetup] + """ + return self._was_derived_from_setup + + @was_derived_from_setup.setter + def was_derived_from_setup(self, was_derived_from_setup): + """Sets the was_derived_from_setup of this ConfigurationSetup. + + Property that links a setup to a previous version of that setup. This property is needed (for example) when creating snapshots of setups. # noqa: E501 + + :param was_derived_from_setup: The was_derived_from_setup of this ConfigurationSetup. # noqa: E501 + :type: list[ConfigurationSetup] + """ + + self._was_derived_from_setup = was_derived_from_setup + @property def has_constraint(self): """Gets the has_constraint of this ConfigurationSetup. # noqa: E501 @@ -824,7 +855,7 @@ def has_execution_command(self, has_execution_command): def date_published(self): """Gets the date_published of this ConfigurationSetup. # noqa: E501 - Description not available # noqa: E501 + Date when a software component was published # noqa: E501 :return: The date_published of this ConfigurationSetup. # noqa: E501 :rtype: list[datetime] @@ -835,7 +866,7 @@ def date_published(self): def date_published(self, date_published): """Sets the date_published of this ConfigurationSetup. - Description not available # noqa: E501 + Date when a software component was published # noqa: E501 :param date_published: The date_published of this ConfigurationSetup. # noqa: E501 :type: list[datetime] @@ -870,7 +901,7 @@ def license(self, license): def has_source_code(self): """Gets the has_source_code of this ConfigurationSetup. # noqa: E501 - Description not available # noqa: E501 + Property designed to link a software with its software source code (which may reside in a code repository such as GitHub) # noqa: E501 :return: The has_source_code of this ConfigurationSetup. # noqa: E501 :rtype: list[SourceCode] @@ -881,7 +912,7 @@ def has_source_code(self): def has_source_code(self, has_source_code): """Sets the has_source_code of this ConfigurationSetup. - Description not available # noqa: E501 + Property designed to link a software with its software source code (which may reside in a code repository such as GitHub) # noqa: E501 :param has_source_code: The has_source_code of this ConfigurationSetup. # noqa: E501 :type: list[SourceCode] @@ -939,7 +970,7 @@ def has_example(self, has_example): def publisher(self): """Gets the publisher of this ConfigurationSetup. # noqa: E501 - Description not available # noqa: E501 + Publisher organization or person responsible for a software component # noqa: E501 :return: The publisher of this ConfigurationSetup. # noqa: E501 :rtype: list[object] @@ -950,7 +981,7 @@ def publisher(self): def publisher(self, publisher): """Sets the publisher of this ConfigurationSetup. - Description not available # noqa: E501 + Publisher organization or person responsible for a software component # noqa: E501 :param publisher: The publisher of this ConfigurationSetup. # noqa: E501 :type: list[object] @@ -981,6 +1012,29 @@ def has_output(self, has_output): self._has_output = has_output + @property + def status(self): + """Gets the status of this ConfigurationSetup. # noqa: E501 + + Data property to indicate the status of a configuration setups. For example, to indicate that a setup has been executed in a platform, that the setup should notbe shown to users (it's an auxiliary setup), etc. # noqa: E501 + + :return: The status of this ConfigurationSetup. # noqa: E501 + :rtype: list[str] + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this ConfigurationSetup. + + Data property to indicate the status of a configuration setups. For example, to indicate that a setup has been executed in a platform, that the setup should notbe shown to users (it's an auxiliary setup), etc. # noqa: E501 + + :param status: The status of this ConfigurationSetup. # noqa: E501 + :type: list[str] + """ + + self._status = status + @property def doi(self): """Gets the doi of this ConfigurationSetup. # noqa: E501 @@ -1077,7 +1131,7 @@ def support_details(self, support_details): def has_version(self): """Gets the has_version of this ConfigurationSetup. # noqa: E501 - Description not available # noqa: E501 + Property designed to link a software component with its corresponding versions # noqa: E501 :return: The has_version of this ConfigurationSetup. # noqa: E501 :rtype: list[SoftwareVersion] @@ -1088,7 +1142,7 @@ def has_version(self): def has_version(self, has_version): """Sets the has_version of this ConfigurationSetup. - Description not available # noqa: E501 + Property designed to link a software component with its corresponding versions # noqa: E501 :param has_version: The has_version of this ConfigurationSetup. # noqa: E501 :type: list[SoftwareVersion] @@ -1100,7 +1154,7 @@ def has_version(self, has_version): def has_typical_data_source(self): """Gets the has_typical_data_source of this ConfigurationSetup. # noqa: E501 - Description not available # noqa: E501 + Typical data sources that are used by a software component # noqa: E501 :return: The has_typical_data_source of this ConfigurationSetup. # noqa: E501 :rtype: list[str] @@ -1111,7 +1165,7 @@ def has_typical_data_source(self): def has_typical_data_source(self, has_typical_data_source): """Sets the has_typical_data_source of this ConfigurationSetup. - Description not available # noqa: E501 + Typical data sources that are used by a software component # noqa: E501 :param has_typical_data_source: The has_typical_data_source of this ConfigurationSetup. # noqa: E501 :type: list[str] @@ -1169,7 +1223,7 @@ def reference_publication(self, reference_publication): def screenshot(self): """Gets the screenshot of this ConfigurationSetup. # noqa: E501 - Description not available # noqa: E501 + Image illustrating a snapshot of the target software # noqa: E501 :return: The screenshot of this ConfigurationSetup. # noqa: E501 :rtype: list[Image] @@ -1180,7 +1234,7 @@ def screenshot(self): def screenshot(self, screenshot): """Sets the screenshot of this ConfigurationSetup. - Description not available # noqa: E501 + Image illustrating a snapshot of the target software # noqa: E501 :param screenshot: The screenshot of this ConfigurationSetup. # noqa: E501 :type: list[Image] @@ -1192,7 +1246,7 @@ def screenshot(self, screenshot): def had_primary_source(self): """Gets the had_primary_source of this ConfigurationSetup. # noqa: E501 - had primary source # noqa: E501 + Property to identify the original source of the information of the annotated resource. It could be a web page, an organization, a person, some experiment notes, etc. # noqa: E501 :return: The had_primary_source of this ConfigurationSetup. # noqa: E501 :rtype: list[object] @@ -1203,7 +1257,7 @@ def had_primary_source(self): def had_primary_source(self, had_primary_source): """Sets the had_primary_source of this ConfigurationSetup. - had primary source # noqa: E501 + Property to identify the original source of the information of the annotated resource. It could be a web page, an organization, a person, some experiment notes, etc. # noqa: E501 :param had_primary_source: The had_primary_source of this ConfigurationSetup. # noqa: E501 :type: list[object] @@ -1261,7 +1315,7 @@ def has_software_image(self, has_software_image): def date_created(self): """Gets the date_created of this ConfigurationSetup. # noqa: E501 - Description not available # noqa: E501 + Date when a software component was created # noqa: E501 :return: The date_created of this ConfigurationSetup. # noqa: E501 :rtype: list[datetime] @@ -1272,7 +1326,7 @@ def date_created(self): def date_created(self, date_created): """Sets the date_created of this ConfigurationSetup. - Description not available # noqa: E501 + Date when a software component was created # noqa: E501 :param date_created: The date_created of this ConfigurationSetup. # noqa: E501 :type: list[datetime] @@ -1284,7 +1338,7 @@ def date_created(self, date_created): def contributor(self): """Gets the contributor of this ConfigurationSetup. # noqa: E501 - Description not available # noqa: E501 + Contributor to a software component # noqa: E501 :return: The contributor of this ConfigurationSetup. # noqa: E501 :rtype: list[Person] @@ -1295,7 +1349,7 @@ def contributor(self): def contributor(self, contributor): """Sets the contributor of this ConfigurationSetup. - Description not available # noqa: E501 + Contributor to a software component # noqa: E501 :param contributor: The contributor of this ConfigurationSetup. # noqa: E501 :type: list[Person] @@ -1376,7 +1430,7 @@ def has_sample_visualization(self, has_sample_visualization): def memory_requirements(self): """Gets the memory_requirements of this ConfigurationSetup. # noqa: E501 - Description not available # noqa: E501 + Memory requirements of a software # noqa: E501 :return: The memory_requirements of this ConfigurationSetup. # noqa: E501 :rtype: list[str] @@ -1387,7 +1441,7 @@ def memory_requirements(self): def memory_requirements(self, memory_requirements): """Sets the memory_requirements of this ConfigurationSetup. - Description not available # noqa: E501 + Memory requirements of a software # noqa: E501 :param memory_requirements: The memory_requirements of this ConfigurationSetup. # noqa: E501 :type: list[str] @@ -1445,7 +1499,7 @@ def citation(self, citation): def processor_requirements(self): """Gets the processor_requirements of this ConfigurationSetup. # noqa: E501 - Description not available # noqa: E501 + Processor requirements of a software component # noqa: E501 :return: The processor_requirements of this ConfigurationSetup. # noqa: E501 :rtype: list[str] @@ -1456,7 +1510,7 @@ def processor_requirements(self): def processor_requirements(self, processor_requirements): """Sets the processor_requirements of this ConfigurationSetup. - Description not available # noqa: E501 + Processor requirements of a software component # noqa: E501 :param processor_requirements: The processor_requirements of this ConfigurationSetup. # noqa: E501 :type: list[str] @@ -1629,7 +1683,7 @@ def has_parameter(self, has_parameter): def operating_systems(self): """Gets the operating_systems of this ConfigurationSetup. # noqa: E501 - Description not available # noqa: E501 + Operating systems under which a software component can operate # noqa: E501 :return: The operating_systems of this ConfigurationSetup. # noqa: E501 :rtype: list[str] @@ -1640,7 +1694,7 @@ def operating_systems(self): def operating_systems(self, operating_systems): """Sets the operating_systems of this ConfigurationSetup. - Description not available # noqa: E501 + Operating systems under which a software component can operate # noqa: E501 :param operating_systems: The operating_systems of this ConfigurationSetup. # noqa: E501 :type: list[str] diff --git a/modelcatalog/models/coupled_model.py b/modelcatalog/models/coupled_model.py new file mode 100644 index 0000000..7dbe7b0 --- /dev/null +++ b/modelcatalog/models/coupled_model.py @@ -0,0 +1,1518 @@ +# coding: utf-8 + +""" + Model Catalog + + This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 + + The version of the OpenAPI document: v1.6.0 + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + + +class CoupledModel(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'has_download_instructions': 'list[str]', + 'keywords': 'list[str]', + 'has_documentation': 'list[str]', + 'has_grid': 'list[Grid]', + 'software_requirements': 'list[str]', + 'has_download_url': 'list[str]', + 'type': 'list[str]', + 'has_installation_instructions': 'list[str]', + 'compatible_visualization_software': 'list[Software]', + 'copyright_holder': 'list[object]', + 'has_faq': 'list[str]', + 'logo': 'list[Image]', + 'has_contact_person': 'list[object]', + 'id': 'str', + 'identifier': 'list[str]', + 'author': 'list[object]', + 'has_build_file': 'list[str]', + 'short_description': 'list[str]', + 'date_published': 'list[datetime]', + 'license': 'list[str]', + 'has_source_code': 'list[SourceCode]', + 'has_explanation_diagram': 'list[Image]', + 'has_example': 'list[str]', + 'publisher': 'list[object]', + 'doi': 'list[str]', + 'has_funding': 'list[FundingInformation]', + 'support_details': 'list[str]', + 'has_version': 'list[SoftwareVersion]', + 'has_typical_data_source': 'list[str]', + 'description': 'list[str]', + 'reference_publication': 'list[str]', + 'screenshot': 'list[Image]', + 'uses_model': 'list[Model]', + 'has_model_category': 'list[ModelCategory]', + 'had_primary_source': 'list[object]', + 'issue_tracker': 'list[str]', + 'date_created': 'list[datetime]', + 'contributor': 'list[Person]', + 'has_purpose': 'list[str]', + 'has_executable_instructions': 'list[str]', + 'has_sample_visualization': 'list[Visualization]', + 'memory_requirements': 'list[str]', + 'website': 'list[str]', + 'citation': 'list[str]', + 'processor_requirements': 'list[str]', + 'has_usage_notes': 'list[str]', + 'readme': 'list[str]', + 'label': 'list[str]', + 'has_assumption': 'list[str]', + 'operating_systems': 'list[str]', + 'has_executable_notebook': 'list[str]', + 'has_equation': 'list[Equation]', + 'useful_for_calculating_index': 'list[NumericalIndex]' + } + + attribute_map = { + 'has_download_instructions': 'hasDownloadInstructions', + 'keywords': 'keywords', + 'has_documentation': 'hasDocumentation', + 'has_grid': 'hasGrid', + 'software_requirements': 'softwareRequirements', + 'has_download_url': 'hasDownloadURL', + 'type': 'type', + 'has_installation_instructions': 'hasInstallationInstructions', + 'compatible_visualization_software': 'compatibleVisualizationSoftware', + 'copyright_holder': 'copyrightHolder', + 'has_faq': 'hasFAQ', + 'logo': 'logo', + 'has_contact_person': 'hasContactPerson', + 'id': 'id', + 'identifier': 'identifier', + 'author': 'author', + 'has_build_file': 'hasBuildFile', + 'short_description': 'shortDescription', + 'date_published': 'datePublished', + 'license': 'license', + 'has_source_code': 'hasSourceCode', + 'has_explanation_diagram': 'hasExplanationDiagram', + 'has_example': 'hasExample', + 'publisher': 'publisher', + 'doi': 'doi', + 'has_funding': 'hasFunding', + 'support_details': 'supportDetails', + 'has_version': 'hasVersion', + 'has_typical_data_source': 'hasTypicalDataSource', + 'description': 'description', + 'reference_publication': 'referencePublication', + 'screenshot': 'screenshot', + 'uses_model': 'usesModel', + 'has_model_category': 'hasModelCategory', + 'had_primary_source': 'hadPrimarySource', + 'issue_tracker': 'issueTracker', + 'date_created': 'dateCreated', + 'contributor': 'contributor', + 'has_purpose': 'hasPurpose', + 'has_executable_instructions': 'hasExecutableInstructions', + 'has_sample_visualization': 'hasSampleVisualization', + 'memory_requirements': 'memoryRequirements', + 'website': 'website', + 'citation': 'citation', + 'processor_requirements': 'processorRequirements', + 'has_usage_notes': 'hasUsageNotes', + 'readme': 'readme', + 'label': 'label', + 'has_assumption': 'hasAssumption', + 'operating_systems': 'operatingSystems', + 'has_executable_notebook': 'hasExecutableNotebook', + 'has_equation': 'hasEquation', + 'useful_for_calculating_index': 'usefulForCalculatingIndex' + } + + def __init__(self, has_download_instructions=None, keywords=None, has_documentation=None, has_grid=None, software_requirements=None, has_download_url=None, type=None, has_installation_instructions=None, compatible_visualization_software=None, copyright_holder=None, has_faq=None, logo=None, has_contact_person=None, id=None, identifier=None, author=None, has_build_file=None, short_description=None, date_published=None, license=None, has_source_code=None, has_explanation_diagram=None, has_example=None, publisher=None, doi=None, has_funding=None, support_details=None, has_version=None, has_typical_data_source=None, description=None, reference_publication=None, screenshot=None, uses_model=None, has_model_category=None, had_primary_source=None, issue_tracker=None, date_created=None, contributor=None, has_purpose=None, has_executable_instructions=None, has_sample_visualization=None, memory_requirements=None, website=None, citation=None, processor_requirements=None, has_usage_notes=None, readme=None, label=None, has_assumption=None, operating_systems=None, has_executable_notebook=None, has_equation=None, useful_for_calculating_index=None): # noqa: E501 + """CoupledModel - a model defined in OpenAPI""" # noqa: E501 + + self._has_download_instructions = None + self._keywords = None + self._has_documentation = None + self._has_grid = None + self._software_requirements = None + self._has_download_url = None + self._type = None + self._has_installation_instructions = None + self._compatible_visualization_software = None + self._copyright_holder = None + self._has_faq = None + self._logo = None + self._has_contact_person = None + self._id = None + self._identifier = None + self._author = None + self._has_build_file = None + self._short_description = None + self._date_published = None + self._license = None + self._has_source_code = None + self._has_explanation_diagram = None + self._has_example = None + self._publisher = None + self._doi = None + self._has_funding = None + self._support_details = None + self._has_version = None + self._has_typical_data_source = None + self._description = None + self._reference_publication = None + self._screenshot = None + self._uses_model = None + self._has_model_category = None + self._had_primary_source = None + self._issue_tracker = None + self._date_created = None + self._contributor = None + self._has_purpose = None + self._has_executable_instructions = None + self._has_sample_visualization = None + self._memory_requirements = None + self._website = None + self._citation = None + self._processor_requirements = None + self._has_usage_notes = None + self._readme = None + self._label = None + self._has_assumption = None + self._operating_systems = None + self._has_executable_notebook = None + self._has_equation = None + self._useful_for_calculating_index = None + self.discriminator = None + + self.has_download_instructions = has_download_instructions + self.keywords = keywords + self.has_documentation = has_documentation + self.has_grid = has_grid + self.software_requirements = software_requirements + self.has_download_url = has_download_url + self.type = type + self.has_installation_instructions = has_installation_instructions + self.compatible_visualization_software = compatible_visualization_software + self.copyright_holder = copyright_holder + self.has_faq = has_faq + self.logo = logo + self.has_contact_person = has_contact_person + if id is not None: + self.id = id + self.identifier = identifier + self.author = author + self.has_build_file = has_build_file + self.short_description = short_description + self.date_published = date_published + self.license = license + self.has_source_code = has_source_code + self.has_explanation_diagram = has_explanation_diagram + self.has_example = has_example + self.publisher = publisher + self.doi = doi + self.has_funding = has_funding + self.support_details = support_details + self.has_version = has_version + self.has_typical_data_source = has_typical_data_source + self.description = description + self.reference_publication = reference_publication + self.screenshot = screenshot + self.uses_model = uses_model + self.has_model_category = has_model_category + self.had_primary_source = had_primary_source + self.issue_tracker = issue_tracker + self.date_created = date_created + self.contributor = contributor + self.has_purpose = has_purpose + self.has_executable_instructions = has_executable_instructions + self.has_sample_visualization = has_sample_visualization + self.memory_requirements = memory_requirements + self.website = website + self.citation = citation + self.processor_requirements = processor_requirements + self.has_usage_notes = has_usage_notes + self.readme = readme + self.label = label + self.has_assumption = has_assumption + self.operating_systems = operating_systems + self.has_executable_notebook = has_executable_notebook + self.has_equation = has_equation + self.useful_for_calculating_index = useful_for_calculating_index + + @property + def has_download_instructions(self): + """Gets the has_download_instructions of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The has_download_instructions of this CoupledModel. # noqa: E501 + :rtype: list[str] + """ + return self._has_download_instructions + + @has_download_instructions.setter + def has_download_instructions(self, has_download_instructions): + """Sets the has_download_instructions of this CoupledModel. + + Description not available # noqa: E501 + + :param has_download_instructions: The has_download_instructions of this CoupledModel. # noqa: E501 + :type: list[str] + """ + + self._has_download_instructions = has_download_instructions + + @property + def keywords(self): + """Gets the keywords of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The keywords of this CoupledModel. # noqa: E501 + :rtype: list[str] + """ + return self._keywords + + @keywords.setter + def keywords(self, keywords): + """Sets the keywords of this CoupledModel. + + Description not available # noqa: E501 + + :param keywords: The keywords of this CoupledModel. # noqa: E501 + :type: list[str] + """ + + self._keywords = keywords + + @property + def has_documentation(self): + """Gets the has_documentation of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The has_documentation of this CoupledModel. # noqa: E501 + :rtype: list[str] + """ + return self._has_documentation + + @has_documentation.setter + def has_documentation(self, has_documentation): + """Sets the has_documentation of this CoupledModel. + + Description not available # noqa: E501 + + :param has_documentation: The has_documentation of this CoupledModel. # noqa: E501 + :type: list[str] + """ + + self._has_documentation = has_documentation + + @property + def has_grid(self): + """Gets the has_grid of this CoupledModel. # noqa: E501 + + Grid information about the model # noqa: E501 + + :return: The has_grid of this CoupledModel. # noqa: E501 + :rtype: list[Grid] + """ + return self._has_grid + + @has_grid.setter + def has_grid(self, has_grid): + """Sets the has_grid of this CoupledModel. + + Grid information about the model # noqa: E501 + + :param has_grid: The has_grid of this CoupledModel. # noqa: E501 + :type: list[Grid] + """ + + self._has_grid = has_grid + + @property + def software_requirements(self): + """Gets the software_requirements of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The software_requirements of this CoupledModel. # noqa: E501 + :rtype: list[str] + """ + return self._software_requirements + + @software_requirements.setter + def software_requirements(self, software_requirements): + """Sets the software_requirements of this CoupledModel. + + Description not available # noqa: E501 + + :param software_requirements: The software_requirements of this CoupledModel. # noqa: E501 + :type: list[str] + """ + + self._software_requirements = software_requirements + + @property + def has_download_url(self): + """Gets the has_download_url of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The has_download_url of this CoupledModel. # noqa: E501 + :rtype: list[str] + """ + return self._has_download_url + + @has_download_url.setter + def has_download_url(self, has_download_url): + """Sets the has_download_url of this CoupledModel. + + Description not available # noqa: E501 + + :param has_download_url: The has_download_url of this CoupledModel. # noqa: E501 + :type: list[str] + """ + + self._has_download_url = has_download_url + + @property + def type(self): + """Gets the type of this CoupledModel. # noqa: E501 + + type of the resource # noqa: E501 + + :return: The type of this CoupledModel. # noqa: E501 + :rtype: list[str] + """ + return self._type + + @type.setter + def type(self, type): + """Sets the type of this CoupledModel. + + type of the resource # noqa: E501 + + :param type: The type of this CoupledModel. # noqa: E501 + :type: list[str] + """ + + self._type = type + + @property + def has_installation_instructions(self): + """Gets the has_installation_instructions of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The has_installation_instructions of this CoupledModel. # noqa: E501 + :rtype: list[str] + """ + return self._has_installation_instructions + + @has_installation_instructions.setter + def has_installation_instructions(self, has_installation_instructions): + """Sets the has_installation_instructions of this CoupledModel. + + Description not available # noqa: E501 + + :param has_installation_instructions: The has_installation_instructions of this CoupledModel. # noqa: E501 + :type: list[str] + """ + + self._has_installation_instructions = has_installation_instructions + + @property + def compatible_visualization_software(self): + """Gets the compatible_visualization_software of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The compatible_visualization_software of this CoupledModel. # noqa: E501 + :rtype: list[Software] + """ + return self._compatible_visualization_software + + @compatible_visualization_software.setter + def compatible_visualization_software(self, compatible_visualization_software): + """Sets the compatible_visualization_software of this CoupledModel. + + Description not available # noqa: E501 + + :param compatible_visualization_software: The compatible_visualization_software of this CoupledModel. # noqa: E501 + :type: list[Software] + """ + + self._compatible_visualization_software = compatible_visualization_software + + @property + def copyright_holder(self): + """Gets the copyright_holder of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The copyright_holder of this CoupledModel. # noqa: E501 + :rtype: list[object] + """ + return self._copyright_holder + + @copyright_holder.setter + def copyright_holder(self, copyright_holder): + """Sets the copyright_holder of this CoupledModel. + + Description not available # noqa: E501 + + :param copyright_holder: The copyright_holder of this CoupledModel. # noqa: E501 + :type: list[object] + """ + + self._copyright_holder = copyright_holder + + @property + def has_faq(self): + """Gets the has_faq of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The has_faq of this CoupledModel. # noqa: E501 + :rtype: list[str] + """ + return self._has_faq + + @has_faq.setter + def has_faq(self, has_faq): + """Sets the has_faq of this CoupledModel. + + Description not available # noqa: E501 + + :param has_faq: The has_faq of this CoupledModel. # noqa: E501 + :type: list[str] + """ + + self._has_faq = has_faq + + @property + def logo(self): + """Gets the logo of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The logo of this CoupledModel. # noqa: E501 + :rtype: list[Image] + """ + return self._logo + + @logo.setter + def logo(self, logo): + """Sets the logo of this CoupledModel. + + Description not available # noqa: E501 + + :param logo: The logo of this CoupledModel. # noqa: E501 + :type: list[Image] + """ + + self._logo = logo + + @property + def has_contact_person(self): + """Gets the has_contact_person of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The has_contact_person of this CoupledModel. # noqa: E501 + :rtype: list[object] + """ + return self._has_contact_person + + @has_contact_person.setter + def has_contact_person(self, has_contact_person): + """Sets the has_contact_person of this CoupledModel. + + Description not available # noqa: E501 + + :param has_contact_person: The has_contact_person of this CoupledModel. # noqa: E501 + :type: list[object] + """ + + self._has_contact_person = has_contact_person + + @property + def id(self): + """Gets the id of this CoupledModel. # noqa: E501 + + identifier # noqa: E501 + + :return: The id of this CoupledModel. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this CoupledModel. + + identifier # noqa: E501 + + :param id: The id of this CoupledModel. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def identifier(self): + """Gets the identifier of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The identifier of this CoupledModel. # noqa: E501 + :rtype: list[str] + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """Sets the identifier of this CoupledModel. + + Description not available # noqa: E501 + + :param identifier: The identifier of this CoupledModel. # noqa: E501 + :type: list[str] + """ + + self._identifier = identifier + + @property + def author(self): + """Gets the author of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The author of this CoupledModel. # noqa: E501 + :rtype: list[object] + """ + return self._author + + @author.setter + def author(self, author): + """Sets the author of this CoupledModel. + + Description not available # noqa: E501 + + :param author: The author of this CoupledModel. # noqa: E501 + :type: list[object] + """ + + self._author = author + + @property + def has_build_file(self): + """Gets the has_build_file of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The has_build_file of this CoupledModel. # noqa: E501 + :rtype: list[str] + """ + return self._has_build_file + + @has_build_file.setter + def has_build_file(self, has_build_file): + """Sets the has_build_file of this CoupledModel. + + Description not available # noqa: E501 + + :param has_build_file: The has_build_file of this CoupledModel. # noqa: E501 + :type: list[str] + """ + + self._has_build_file = has_build_file + + @property + def short_description(self): + """Gets the short_description of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The short_description of this CoupledModel. # noqa: E501 + :rtype: list[str] + """ + return self._short_description + + @short_description.setter + def short_description(self, short_description): + """Sets the short_description of this CoupledModel. + + Description not available # noqa: E501 + + :param short_description: The short_description of this CoupledModel. # noqa: E501 + :type: list[str] + """ + + self._short_description = short_description + + @property + def date_published(self): + """Gets the date_published of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The date_published of this CoupledModel. # noqa: E501 + :rtype: list[datetime] + """ + return self._date_published + + @date_published.setter + def date_published(self, date_published): + """Sets the date_published of this CoupledModel. + + Description not available # noqa: E501 + + :param date_published: The date_published of this CoupledModel. # noqa: E501 + :type: list[datetime] + """ + + self._date_published = date_published + + @property + def license(self): + """Gets the license of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The license of this CoupledModel. # noqa: E501 + :rtype: list[str] + """ + return self._license + + @license.setter + def license(self, license): + """Sets the license of this CoupledModel. + + Description not available # noqa: E501 + + :param license: The license of this CoupledModel. # noqa: E501 + :type: list[str] + """ + + self._license = license + + @property + def has_source_code(self): + """Gets the has_source_code of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The has_source_code of this CoupledModel. # noqa: E501 + :rtype: list[SourceCode] + """ + return self._has_source_code + + @has_source_code.setter + def has_source_code(self, has_source_code): + """Sets the has_source_code of this CoupledModel. + + Description not available # noqa: E501 + + :param has_source_code: The has_source_code of this CoupledModel. # noqa: E501 + :type: list[SourceCode] + """ + + self._has_source_code = has_source_code + + @property + def has_explanation_diagram(self): + """Gets the has_explanation_diagram of this CoupledModel. # noqa: E501 + + Diagram used to explain the behavior of the model # noqa: E501 + + :return: The has_explanation_diagram of this CoupledModel. # noqa: E501 + :rtype: list[Image] + """ + return self._has_explanation_diagram + + @has_explanation_diagram.setter + def has_explanation_diagram(self, has_explanation_diagram): + """Sets the has_explanation_diagram of this CoupledModel. + + Diagram used to explain the behavior of the model # noqa: E501 + + :param has_explanation_diagram: The has_explanation_diagram of this CoupledModel. # noqa: E501 + :type: list[Image] + """ + + self._has_explanation_diagram = has_explanation_diagram + + @property + def has_example(self): + """Gets the has_example of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The has_example of this CoupledModel. # noqa: E501 + :rtype: list[str] + """ + return self._has_example + + @has_example.setter + def has_example(self, has_example): + """Sets the has_example of this CoupledModel. + + Description not available # noqa: E501 + + :param has_example: The has_example of this CoupledModel. # noqa: E501 + :type: list[str] + """ + + self._has_example = has_example + + @property + def publisher(self): + """Gets the publisher of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The publisher of this CoupledModel. # noqa: E501 + :rtype: list[object] + """ + return self._publisher + + @publisher.setter + def publisher(self, publisher): + """Sets the publisher of this CoupledModel. + + Description not available # noqa: E501 + + :param publisher: The publisher of this CoupledModel. # noqa: E501 + :type: list[object] + """ + + self._publisher = publisher + + @property + def doi(self): + """Gets the doi of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The doi of this CoupledModel. # noqa: E501 + :rtype: list[str] + """ + return self._doi + + @doi.setter + def doi(self, doi): + """Sets the doi of this CoupledModel. + + Description not available # noqa: E501 + + :param doi: The doi of this CoupledModel. # noqa: E501 + :type: list[str] + """ + + self._doi = doi + + @property + def has_funding(self): + """Gets the has_funding of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The has_funding of this CoupledModel. # noqa: E501 + :rtype: list[FundingInformation] + """ + return self._has_funding + + @has_funding.setter + def has_funding(self, has_funding): + """Sets the has_funding of this CoupledModel. + + Description not available # noqa: E501 + + :param has_funding: The has_funding of this CoupledModel. # noqa: E501 + :type: list[FundingInformation] + """ + + self._has_funding = has_funding + + @property + def support_details(self): + """Gets the support_details of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The support_details of this CoupledModel. # noqa: E501 + :rtype: list[str] + """ + return self._support_details + + @support_details.setter + def support_details(self, support_details): + """Sets the support_details of this CoupledModel. + + Description not available # noqa: E501 + + :param support_details: The support_details of this CoupledModel. # noqa: E501 + :type: list[str] + """ + + self._support_details = support_details + + @property + def has_version(self): + """Gets the has_version of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The has_version of this CoupledModel. # noqa: E501 + :rtype: list[SoftwareVersion] + """ + return self._has_version + + @has_version.setter + def has_version(self, has_version): + """Sets the has_version of this CoupledModel. + + Description not available # noqa: E501 + + :param has_version: The has_version of this CoupledModel. # noqa: E501 + :type: list[SoftwareVersion] + """ + + self._has_version = has_version + + @property + def has_typical_data_source(self): + """Gets the has_typical_data_source of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The has_typical_data_source of this CoupledModel. # noqa: E501 + :rtype: list[str] + """ + return self._has_typical_data_source + + @has_typical_data_source.setter + def has_typical_data_source(self, has_typical_data_source): + """Sets the has_typical_data_source of this CoupledModel. + + Description not available # noqa: E501 + + :param has_typical_data_source: The has_typical_data_source of this CoupledModel. # noqa: E501 + :type: list[str] + """ + + self._has_typical_data_source = has_typical_data_source + + @property + def description(self): + """Gets the description of this CoupledModel. # noqa: E501 + + small description # noqa: E501 + + :return: The description of this CoupledModel. # noqa: E501 + :rtype: list[str] + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this CoupledModel. + + small description # noqa: E501 + + :param description: The description of this CoupledModel. # noqa: E501 + :type: list[str] + """ + + self._description = description + + @property + def reference_publication(self): + """Gets the reference_publication of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The reference_publication of this CoupledModel. # noqa: E501 + :rtype: list[str] + """ + return self._reference_publication + + @reference_publication.setter + def reference_publication(self, reference_publication): + """Sets the reference_publication of this CoupledModel. + + Description not available # noqa: E501 + + :param reference_publication: The reference_publication of this CoupledModel. # noqa: E501 + :type: list[str] + """ + + self._reference_publication = reference_publication + + @property + def screenshot(self): + """Gets the screenshot of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The screenshot of this CoupledModel. # noqa: E501 + :rtype: list[Image] + """ + return self._screenshot + + @screenshot.setter + def screenshot(self, screenshot): + """Sets the screenshot of this CoupledModel. + + Description not available # noqa: E501 + + :param screenshot: The screenshot of this CoupledModel. # noqa: E501 + :type: list[Image] + """ + + self._screenshot = screenshot + + @property + def uses_model(self): + """Gets the uses_model of this CoupledModel. # noqa: E501 + + Property that describes which models are used by a coupled model # noqa: E501 + + :return: The uses_model of this CoupledModel. # noqa: E501 + :rtype: list[Model] + """ + return self._uses_model + + @uses_model.setter + def uses_model(self, uses_model): + """Sets the uses_model of this CoupledModel. + + Property that describes which models are used by a coupled model # noqa: E501 + + :param uses_model: The uses_model of this CoupledModel. # noqa: E501 + :type: list[Model] + """ + + self._uses_model = uses_model + + @property + def has_model_category(self): + """Gets the has_model_category of this CoupledModel. # noqa: E501 + + Category associated with a model (e.g., Hydrology, etc.) # noqa: E501 + + :return: The has_model_category of this CoupledModel. # noqa: E501 + :rtype: list[ModelCategory] + """ + return self._has_model_category + + @has_model_category.setter + def has_model_category(self, has_model_category): + """Sets the has_model_category of this CoupledModel. + + Category associated with a model (e.g., Hydrology, etc.) # noqa: E501 + + :param has_model_category: The has_model_category of this CoupledModel. # noqa: E501 + :type: list[ModelCategory] + """ + + self._has_model_category = has_model_category + + @property + def had_primary_source(self): + """Gets the had_primary_source of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The had_primary_source of this CoupledModel. # noqa: E501 + :rtype: list[object] + """ + return self._had_primary_source + + @had_primary_source.setter + def had_primary_source(self, had_primary_source): + """Sets the had_primary_source of this CoupledModel. + + Description not available # noqa: E501 + + :param had_primary_source: The had_primary_source of this CoupledModel. # noqa: E501 + :type: list[object] + """ + + self._had_primary_source = had_primary_source + + @property + def issue_tracker(self): + """Gets the issue_tracker of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The issue_tracker of this CoupledModel. # noqa: E501 + :rtype: list[str] + """ + return self._issue_tracker + + @issue_tracker.setter + def issue_tracker(self, issue_tracker): + """Sets the issue_tracker of this CoupledModel. + + Description not available # noqa: E501 + + :param issue_tracker: The issue_tracker of this CoupledModel. # noqa: E501 + :type: list[str] + """ + + self._issue_tracker = issue_tracker + + @property + def date_created(self): + """Gets the date_created of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The date_created of this CoupledModel. # noqa: E501 + :rtype: list[datetime] + """ + return self._date_created + + @date_created.setter + def date_created(self, date_created): + """Sets the date_created of this CoupledModel. + + Description not available # noqa: E501 + + :param date_created: The date_created of this CoupledModel. # noqa: E501 + :type: list[datetime] + """ + + self._date_created = date_created + + @property + def contributor(self): + """Gets the contributor of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The contributor of this CoupledModel. # noqa: E501 + :rtype: list[Person] + """ + return self._contributor + + @contributor.setter + def contributor(self, contributor): + """Sets the contributor of this CoupledModel. + + Description not available # noqa: E501 + + :param contributor: The contributor of this CoupledModel. # noqa: E501 + :type: list[Person] + """ + + self._contributor = contributor + + @property + def has_purpose(self): + """Gets the has_purpose of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The has_purpose of this CoupledModel. # noqa: E501 + :rtype: list[str] + """ + return self._has_purpose + + @has_purpose.setter + def has_purpose(self, has_purpose): + """Sets the has_purpose of this CoupledModel. + + Description not available # noqa: E501 + + :param has_purpose: The has_purpose of this CoupledModel. # noqa: E501 + :type: list[str] + """ + + self._has_purpose = has_purpose + + @property + def has_executable_instructions(self): + """Gets the has_executable_instructions of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The has_executable_instructions of this CoupledModel. # noqa: E501 + :rtype: list[str] + """ + return self._has_executable_instructions + + @has_executable_instructions.setter + def has_executable_instructions(self, has_executable_instructions): + """Sets the has_executable_instructions of this CoupledModel. + + Description not available # noqa: E501 + + :param has_executable_instructions: The has_executable_instructions of this CoupledModel. # noqa: E501 + :type: list[str] + """ + + self._has_executable_instructions = has_executable_instructions + + @property + def has_sample_visualization(self): + """Gets the has_sample_visualization of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The has_sample_visualization of this CoupledModel. # noqa: E501 + :rtype: list[Visualization] + """ + return self._has_sample_visualization + + @has_sample_visualization.setter + def has_sample_visualization(self, has_sample_visualization): + """Sets the has_sample_visualization of this CoupledModel. + + Description not available # noqa: E501 + + :param has_sample_visualization: The has_sample_visualization of this CoupledModel. # noqa: E501 + :type: list[Visualization] + """ + + self._has_sample_visualization = has_sample_visualization + + @property + def memory_requirements(self): + """Gets the memory_requirements of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The memory_requirements of this CoupledModel. # noqa: E501 + :rtype: list[str] + """ + return self._memory_requirements + + @memory_requirements.setter + def memory_requirements(self, memory_requirements): + """Sets the memory_requirements of this CoupledModel. + + Description not available # noqa: E501 + + :param memory_requirements: The memory_requirements of this CoupledModel. # noqa: E501 + :type: list[str] + """ + + self._memory_requirements = memory_requirements + + @property + def website(self): + """Gets the website of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The website of this CoupledModel. # noqa: E501 + :rtype: list[str] + """ + return self._website + + @website.setter + def website(self, website): + """Sets the website of this CoupledModel. + + Description not available # noqa: E501 + + :param website: The website of this CoupledModel. # noqa: E501 + :type: list[str] + """ + + self._website = website + + @property + def citation(self): + """Gets the citation of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The citation of this CoupledModel. # noqa: E501 + :rtype: list[str] + """ + return self._citation + + @citation.setter + def citation(self, citation): + """Sets the citation of this CoupledModel. + + Description not available # noqa: E501 + + :param citation: The citation of this CoupledModel. # noqa: E501 + :type: list[str] + """ + + self._citation = citation + + @property + def processor_requirements(self): + """Gets the processor_requirements of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The processor_requirements of this CoupledModel. # noqa: E501 + :rtype: list[str] + """ + return self._processor_requirements + + @processor_requirements.setter + def processor_requirements(self, processor_requirements): + """Sets the processor_requirements of this CoupledModel. + + Description not available # noqa: E501 + + :param processor_requirements: The processor_requirements of this CoupledModel. # noqa: E501 + :type: list[str] + """ + + self._processor_requirements = processor_requirements + + @property + def has_usage_notes(self): + """Gets the has_usage_notes of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The has_usage_notes of this CoupledModel. # noqa: E501 + :rtype: list[str] + """ + return self._has_usage_notes + + @has_usage_notes.setter + def has_usage_notes(self, has_usage_notes): + """Sets the has_usage_notes of this CoupledModel. + + Description not available # noqa: E501 + + :param has_usage_notes: The has_usage_notes of this CoupledModel. # noqa: E501 + :type: list[str] + """ + + self._has_usage_notes = has_usage_notes + + @property + def readme(self): + """Gets the readme of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The readme of this CoupledModel. # noqa: E501 + :rtype: list[str] + """ + return self._readme + + @readme.setter + def readme(self, readme): + """Sets the readme of this CoupledModel. + + Description not available # noqa: E501 + + :param readme: The readme of this CoupledModel. # noqa: E501 + :type: list[str] + """ + + self._readme = readme + + @property + def label(self): + """Gets the label of this CoupledModel. # noqa: E501 + + short description of the resource # noqa: E501 + + :return: The label of this CoupledModel. # noqa: E501 + :rtype: list[str] + """ + return self._label + + @label.setter + def label(self, label): + """Sets the label of this CoupledModel. + + short description of the resource # noqa: E501 + + :param label: The label of this CoupledModel. # noqa: E501 + :type: list[str] + """ + + self._label = label + + @property + def has_assumption(self): + """Gets the has_assumption of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The has_assumption of this CoupledModel. # noqa: E501 + :rtype: list[str] + """ + return self._has_assumption + + @has_assumption.setter + def has_assumption(self, has_assumption): + """Sets the has_assumption of this CoupledModel. + + Description not available # noqa: E501 + + :param has_assumption: The has_assumption of this CoupledModel. # noqa: E501 + :type: list[str] + """ + + self._has_assumption = has_assumption + + @property + def operating_systems(self): + """Gets the operating_systems of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The operating_systems of this CoupledModel. # noqa: E501 + :rtype: list[str] + """ + return self._operating_systems + + @operating_systems.setter + def operating_systems(self, operating_systems): + """Sets the operating_systems of this CoupledModel. + + Description not available # noqa: E501 + + :param operating_systems: The operating_systems of this CoupledModel. # noqa: E501 + :type: list[str] + """ + + self._operating_systems = operating_systems + + @property + def has_executable_notebook(self): + """Gets the has_executable_notebook of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The has_executable_notebook of this CoupledModel. # noqa: E501 + :rtype: list[str] + """ + return self._has_executable_notebook + + @has_executable_notebook.setter + def has_executable_notebook(self, has_executable_notebook): + """Sets the has_executable_notebook of this CoupledModel. + + Description not available # noqa: E501 + + :param has_executable_notebook: The has_executable_notebook of this CoupledModel. # noqa: E501 + :type: list[str] + """ + + self._has_executable_notebook = has_executable_notebook + + @property + def has_equation(self): + """Gets the has_equation of this CoupledModel. # noqa: E501 + + Equations used in the model # noqa: E501 + + :return: The has_equation of this CoupledModel. # noqa: E501 + :rtype: list[Equation] + """ + return self._has_equation + + @has_equation.setter + def has_equation(self, has_equation): + """Sets the has_equation of this CoupledModel. + + Equations used in the model # noqa: E501 + + :param has_equation: The has_equation of this CoupledModel. # noqa: E501 + :type: list[Equation] + """ + + self._has_equation = has_equation + + @property + def useful_for_calculating_index(self): + """Gets the useful_for_calculating_index of this CoupledModel. # noqa: E501 + + Description not available # noqa: E501 + + :return: The useful_for_calculating_index of this CoupledModel. # noqa: E501 + :rtype: list[NumericalIndex] + """ + return self._useful_for_calculating_index + + @useful_for_calculating_index.setter + def useful_for_calculating_index(self, useful_for_calculating_index): + """Sets the useful_for_calculating_index of this CoupledModel. + + Description not available # noqa: E501 + + :param useful_for_calculating_index: The useful_for_calculating_index of this CoupledModel. # noqa: E501 + :type: list[NumericalIndex] + """ + + self._useful_for_calculating_index = useful_for_calculating_index + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CoupledModel): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/modelcatalog/models/data_transformation.py b/modelcatalog/models/data_transformation.py index a9d2500..3a3f121 100644 --- a/modelcatalog/models/data_transformation.py +++ b/modelcatalog/models/data_transformation.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ @@ -383,7 +383,7 @@ def has_implementation_script_location(self, has_implementation_script_location) def software_requirements(self): """Gets the software_requirements of this DataTransformation. # noqa: E501 - Description not available # noqa: E501 + Software requirements needed to install a software component # noqa: E501 :return: The software_requirements of this DataTransformation. # noqa: E501 :rtype: list[str] @@ -394,7 +394,7 @@ def software_requirements(self): def software_requirements(self, software_requirements): """Sets the software_requirements of this DataTransformation. - Description not available # noqa: E501 + Software requirements needed to install a software component # noqa: E501 :param software_requirements: The software_requirements of this DataTransformation. # noqa: E501 :type: list[str] @@ -498,7 +498,7 @@ def compatible_visualization_software(self, compatible_visualization_software): def copyright_holder(self): """Gets the copyright_holder of this DataTransformation. # noqa: E501 - Description not available # noqa: E501 + Copyright holder for a software component # noqa: E501 :return: The copyright_holder of this DataTransformation. # noqa: E501 :rtype: list[object] @@ -509,7 +509,7 @@ def copyright_holder(self): def copyright_holder(self, copyright_holder): """Sets the copyright_holder of this DataTransformation. - Description not available # noqa: E501 + Copyright holder for a software component # noqa: E501 :param copyright_holder: The copyright_holder of this DataTransformation. # noqa: E501 :type: list[object] @@ -544,7 +544,7 @@ def has_faq(self, has_faq): def logo(self): """Gets the logo of this DataTransformation. # noqa: E501 - Description not available # noqa: E501 + Property that links to the image used as logo for a software component # noqa: E501 :return: The logo of this DataTransformation. # noqa: E501 :rtype: list[Image] @@ -555,7 +555,7 @@ def logo(self): def logo(self, logo): """Sets the logo of this DataTransformation. - Description not available # noqa: E501 + Property that links to the image used as logo for a software component # noqa: E501 :param logo: The logo of this DataTransformation. # noqa: E501 :type: list[Image] @@ -567,7 +567,7 @@ def logo(self, logo): def has_contact_person(self): """Gets the has_contact_person of this DataTransformation. # noqa: E501 - Description not available # noqa: E501 + Contact person responsible for a software component # noqa: E501 :return: The has_contact_person of this DataTransformation. # noqa: E501 :rtype: list[object] @@ -578,7 +578,7 @@ def has_contact_person(self): def has_contact_person(self, has_contact_person): """Sets the has_contact_person of this DataTransformation. - Description not available # noqa: E501 + Contact person responsible for a software component # noqa: E501 :param has_contact_person: The has_contact_person of this DataTransformation. # noqa: E501 :type: list[object] @@ -659,7 +659,7 @@ def identifier(self, identifier): def has_sample_execution(self): """Gets the has_sample_execution of this DataTransformation. # noqa: E501 - Description not available # noqa: E501 + Property pointing to a sample execution of a software configuration # noqa: E501 :return: The has_sample_execution of this DataTransformation. # noqa: E501 :rtype: list[SampleExecution] @@ -670,7 +670,7 @@ def has_sample_execution(self): def has_sample_execution(self, has_sample_execution): """Sets the has_sample_execution of this DataTransformation. - Description not available # noqa: E501 + Property pointing to a sample execution of a software configuration # noqa: E501 :param has_sample_execution: The has_sample_execution of this DataTransformation. # noqa: E501 :type: list[SampleExecution] @@ -682,7 +682,7 @@ def has_sample_execution(self, has_sample_execution): def has_sample_result(self): """Gets the has_sample_result of this DataTransformation. # noqa: E501 - Description not available # noqa: E501 + Property designed to link a software configuration to a sample resource resulting from its execution # noqa: E501 :return: The has_sample_result of this DataTransformation. # noqa: E501 :rtype: list[SampleResource] @@ -693,7 +693,7 @@ def has_sample_result(self): def has_sample_result(self, has_sample_result): """Sets the has_sample_result of this DataTransformation. - Description not available # noqa: E501 + Property designed to link a software configuration to a sample resource resulting from its execution # noqa: E501 :param has_sample_result: The has_sample_result of this DataTransformation. # noqa: E501 :type: list[SampleResource] @@ -705,7 +705,7 @@ def has_sample_result(self, has_sample_result): def author(self): """Gets the author of this DataTransformation. # noqa: E501 - Description not available # noqa: E501 + The creator of a software component # noqa: E501 :return: The author of this DataTransformation. # noqa: E501 :rtype: list[object] @@ -716,7 +716,7 @@ def author(self): def author(self, author): """Sets the author of this DataTransformation. - Description not available # noqa: E501 + The creator of a software component # noqa: E501 :param author: The author of this DataTransformation. # noqa: E501 :type: list[object] @@ -820,7 +820,7 @@ def has_execution_command(self, has_execution_command): def date_published(self): """Gets the date_published of this DataTransformation. # noqa: E501 - Description not available # noqa: E501 + Date when a software component was published # noqa: E501 :return: The date_published of this DataTransformation. # noqa: E501 :rtype: list[datetime] @@ -831,7 +831,7 @@ def date_published(self): def date_published(self, date_published): """Sets the date_published of this DataTransformation. - Description not available # noqa: E501 + Date when a software component was published # noqa: E501 :param date_published: The date_published of this DataTransformation. # noqa: E501 :type: list[datetime] @@ -866,7 +866,7 @@ def license(self, license): def has_source_code(self): """Gets the has_source_code of this DataTransformation. # noqa: E501 - Description not available # noqa: E501 + Property designed to link a software with its software source code (which may reside in a code repository such as GitHub) # noqa: E501 :return: The has_source_code of this DataTransformation. # noqa: E501 :rtype: list[SourceCode] @@ -877,7 +877,7 @@ def has_source_code(self): def has_source_code(self, has_source_code): """Sets the has_source_code of this DataTransformation. - Description not available # noqa: E501 + Property designed to link a software with its software source code (which may reside in a code repository such as GitHub) # noqa: E501 :param has_source_code: The has_source_code of this DataTransformation. # noqa: E501 :type: list[SourceCode] @@ -935,7 +935,7 @@ def has_example(self, has_example): def publisher(self): """Gets the publisher of this DataTransformation. # noqa: E501 - Description not available # noqa: E501 + Publisher organization or person responsible for a software component # noqa: E501 :return: The publisher of this DataTransformation. # noqa: E501 :rtype: list[object] @@ -946,7 +946,7 @@ def publisher(self): def publisher(self, publisher): """Sets the publisher of this DataTransformation. - Description not available # noqa: E501 + Publisher organization or person responsible for a software component # noqa: E501 :param publisher: The publisher of this DataTransformation. # noqa: E501 :type: list[object] @@ -1073,7 +1073,7 @@ def support_details(self, support_details): def has_version(self): """Gets the has_version of this DataTransformation. # noqa: E501 - Description not available # noqa: E501 + Property designed to link a software component with its corresponding versions # noqa: E501 :return: The has_version of this DataTransformation. # noqa: E501 :rtype: list[SoftwareVersion] @@ -1084,7 +1084,7 @@ def has_version(self): def has_version(self, has_version): """Sets the has_version of this DataTransformation. - Description not available # noqa: E501 + Property designed to link a software component with its corresponding versions # noqa: E501 :param has_version: The has_version of this DataTransformation. # noqa: E501 :type: list[SoftwareVersion] @@ -1096,7 +1096,7 @@ def has_version(self, has_version): def has_typical_data_source(self): """Gets the has_typical_data_source of this DataTransformation. # noqa: E501 - Description not available # noqa: E501 + Typical data sources that are used by a software component # noqa: E501 :return: The has_typical_data_source of this DataTransformation. # noqa: E501 :rtype: list[str] @@ -1107,7 +1107,7 @@ def has_typical_data_source(self): def has_typical_data_source(self, has_typical_data_source): """Sets the has_typical_data_source of this DataTransformation. - Description not available # noqa: E501 + Typical data sources that are used by a software component # noqa: E501 :param has_typical_data_source: The has_typical_data_source of this DataTransformation. # noqa: E501 :type: list[str] @@ -1165,7 +1165,7 @@ def reference_publication(self, reference_publication): def screenshot(self): """Gets the screenshot of this DataTransformation. # noqa: E501 - Description not available # noqa: E501 + Image illustrating a snapshot of the target software # noqa: E501 :return: The screenshot of this DataTransformation. # noqa: E501 :rtype: list[Image] @@ -1176,7 +1176,7 @@ def screenshot(self): def screenshot(self, screenshot): """Sets the screenshot of this DataTransformation. - Description not available # noqa: E501 + Image illustrating a snapshot of the target software # noqa: E501 :param screenshot: The screenshot of this DataTransformation. # noqa: E501 :type: list[Image] @@ -1188,7 +1188,7 @@ def screenshot(self, screenshot): def had_primary_source(self): """Gets the had_primary_source of this DataTransformation. # noqa: E501 - had primary source # noqa: E501 + Property to identify the original source of the information of the annotated resource. It could be a web page, an organization, a person, some experiment notes, etc. # noqa: E501 :return: The had_primary_source of this DataTransformation. # noqa: E501 :rtype: list[object] @@ -1199,7 +1199,7 @@ def had_primary_source(self): def had_primary_source(self, had_primary_source): """Sets the had_primary_source of this DataTransformation. - had primary source # noqa: E501 + Property to identify the original source of the information of the annotated resource. It could be a web page, an organization, a person, some experiment notes, etc. # noqa: E501 :param had_primary_source: The had_primary_source of this DataTransformation. # noqa: E501 :type: list[object] @@ -1257,7 +1257,7 @@ def has_software_image(self, has_software_image): def date_created(self): """Gets the date_created of this DataTransformation. # noqa: E501 - Description not available # noqa: E501 + Date when a software component was created # noqa: E501 :return: The date_created of this DataTransformation. # noqa: E501 :rtype: list[datetime] @@ -1268,7 +1268,7 @@ def date_created(self): def date_created(self, date_created): """Sets the date_created of this DataTransformation. - Description not available # noqa: E501 + Date when a software component was created # noqa: E501 :param date_created: The date_created of this DataTransformation. # noqa: E501 :type: list[datetime] @@ -1280,7 +1280,7 @@ def date_created(self, date_created): def contributor(self): """Gets the contributor of this DataTransformation. # noqa: E501 - Description not available # noqa: E501 + Contributor to a software component # noqa: E501 :return: The contributor of this DataTransformation. # noqa: E501 :rtype: list[Person] @@ -1291,7 +1291,7 @@ def contributor(self): def contributor(self, contributor): """Sets the contributor of this DataTransformation. - Description not available # noqa: E501 + Contributor to a software component # noqa: E501 :param contributor: The contributor of this DataTransformation. # noqa: E501 :type: list[Person] @@ -1372,7 +1372,7 @@ def has_sample_visualization(self, has_sample_visualization): def memory_requirements(self): """Gets the memory_requirements of this DataTransformation. # noqa: E501 - Description not available # noqa: E501 + Memory requirements of a software # noqa: E501 :return: The memory_requirements of this DataTransformation. # noqa: E501 :rtype: list[str] @@ -1383,7 +1383,7 @@ def memory_requirements(self): def memory_requirements(self, memory_requirements): """Sets the memory_requirements of this DataTransformation. - Description not available # noqa: E501 + Memory requirements of a software # noqa: E501 :param memory_requirements: The memory_requirements of this DataTransformation. # noqa: E501 :type: list[str] @@ -1441,7 +1441,7 @@ def citation(self, citation): def processor_requirements(self): """Gets the processor_requirements of this DataTransformation. # noqa: E501 - Description not available # noqa: E501 + Processor requirements of a software component # noqa: E501 :return: The processor_requirements of this DataTransformation. # noqa: E501 :rtype: list[str] @@ -1452,7 +1452,7 @@ def processor_requirements(self): def processor_requirements(self, processor_requirements): """Sets the processor_requirements of this DataTransformation. - Description not available # noqa: E501 + Processor requirements of a software component # noqa: E501 :param processor_requirements: The processor_requirements of this DataTransformation. # noqa: E501 :type: list[str] @@ -1602,7 +1602,7 @@ def has_parameter(self, has_parameter): def operating_systems(self): """Gets the operating_systems of this DataTransformation. # noqa: E501 - Description not available # noqa: E501 + Operating systems under which a software component can operate # noqa: E501 :return: The operating_systems of this DataTransformation. # noqa: E501 :rtype: list[str] @@ -1613,7 +1613,7 @@ def operating_systems(self): def operating_systems(self, operating_systems): """Sets the operating_systems of this DataTransformation. - Description not available # noqa: E501 + Operating systems under which a software component can operate # noqa: E501 :param operating_systems: The operating_systems of this DataTransformation. # noqa: E501 :type: list[str] diff --git a/modelcatalog/models/data_transformation_setup.py b/modelcatalog/models/data_transformation_setup.py index f704546..ac07d3d 100644 --- a/modelcatalog/models/data_transformation_setup.py +++ b/modelcatalog/models/data_transformation_setup.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ @@ -50,6 +50,7 @@ class DataTransformationSetup(object): 'has_sample_execution': 'list[SampleExecution]', 'has_sample_result': 'list[SampleResource]', 'author': 'list[object]', + 'was_derived_from_setup': 'list[ConfigurationSetup]', 'has_constraint': 'list[str]', 'has_build_file': 'list[str]', 'short_description': 'list[str]', @@ -61,6 +62,7 @@ class DataTransformationSetup(object): 'has_example': 'list[str]', 'publisher': 'list[object]', 'has_output': 'list[DatasetSpecification]', + 'status': 'list[str]', 'doi': 'list[str]', 'has_funding': 'list[FundingInformation]', 'has_component_location': 'list[str]', @@ -115,6 +117,7 @@ class DataTransformationSetup(object): 'has_sample_execution': 'hasSampleExecution', 'has_sample_result': 'hasSampleResult', 'author': 'author', + 'was_derived_from_setup': 'wasDerivedFromSetup', 'has_constraint': 'hasConstraint', 'has_build_file': 'hasBuildFile', 'short_description': 'shortDescription', @@ -126,6 +129,7 @@ class DataTransformationSetup(object): 'has_example': 'hasExample', 'publisher': 'publisher', 'has_output': 'hasOutput', + 'status': 'status', 'doi': 'doi', 'has_funding': 'hasFunding', 'has_component_location': 'hasComponentLocation', @@ -160,7 +164,7 @@ class DataTransformationSetup(object): 'has_input': 'hasInput' } - def __init__(self, has_download_instructions=None, keywords=None, has_documentation=None, has_implementation_script_location=None, software_requirements=None, has_download_url=None, type=None, has_installation_instructions=None, compatible_visualization_software=None, copyright_holder=None, has_faq=None, logo=None, has_contact_person=None, tag=None, id=None, identifier=None, has_sample_execution=None, has_sample_result=None, author=None, has_constraint=None, has_build_file=None, short_description=None, has_execution_command=None, date_published=None, license=None, has_source_code=None, has_setup=None, has_example=None, publisher=None, has_output=None, doi=None, has_funding=None, has_component_location=None, support_details=None, has_version=None, has_typical_data_source=None, description=None, reference_publication=None, screenshot=None, had_primary_source=None, issue_tracker=None, has_software_image=None, date_created=None, contributor=None, has_purpose=None, has_executable_instructions=None, has_sample_visualization=None, memory_requirements=None, website=None, citation=None, processor_requirements=None, adjustable_parameter=None, has_usage_notes=None, has_support_script_location=None, readme=None, label=None, has_assumption=None, has_parameter=None, operating_systems=None, has_executable_notebook=None, useful_for_calculating_index=None, has_input=None): # noqa: E501 + def __init__(self, has_download_instructions=None, keywords=None, has_documentation=None, has_implementation_script_location=None, software_requirements=None, has_download_url=None, type=None, has_installation_instructions=None, compatible_visualization_software=None, copyright_holder=None, has_faq=None, logo=None, has_contact_person=None, tag=None, id=None, identifier=None, has_sample_execution=None, has_sample_result=None, author=None, was_derived_from_setup=None, has_constraint=None, has_build_file=None, short_description=None, has_execution_command=None, date_published=None, license=None, has_source_code=None, has_setup=None, has_example=None, publisher=None, has_output=None, status=None, doi=None, has_funding=None, has_component_location=None, support_details=None, has_version=None, has_typical_data_source=None, description=None, reference_publication=None, screenshot=None, had_primary_source=None, issue_tracker=None, has_software_image=None, date_created=None, contributor=None, has_purpose=None, has_executable_instructions=None, has_sample_visualization=None, memory_requirements=None, website=None, citation=None, processor_requirements=None, adjustable_parameter=None, has_usage_notes=None, has_support_script_location=None, readme=None, label=None, has_assumption=None, has_parameter=None, operating_systems=None, has_executable_notebook=None, useful_for_calculating_index=None, has_input=None): # noqa: E501 """DataTransformationSetup - a model defined in OpenAPI""" # noqa: E501 self._has_download_instructions = None @@ -182,6 +186,7 @@ def __init__(self, has_download_instructions=None, keywords=None, has_documentat self._has_sample_execution = None self._has_sample_result = None self._author = None + self._was_derived_from_setup = None self._has_constraint = None self._has_build_file = None self._short_description = None @@ -193,6 +198,7 @@ def __init__(self, has_download_instructions=None, keywords=None, has_documentat self._has_example = None self._publisher = None self._has_output = None + self._status = None self._doi = None self._has_funding = None self._has_component_location = None @@ -247,6 +253,7 @@ def __init__(self, has_download_instructions=None, keywords=None, has_documentat self.has_sample_execution = has_sample_execution self.has_sample_result = has_sample_result self.author = author + self.was_derived_from_setup = was_derived_from_setup self.has_constraint = has_constraint self.has_build_file = has_build_file self.short_description = short_description @@ -258,6 +265,7 @@ def __init__(self, has_download_instructions=None, keywords=None, has_documentat self.has_example = has_example self.publisher = publisher self.has_output = has_output + self.status = status self.doi = doi self.has_funding = has_funding self.has_component_location = has_component_location @@ -387,7 +395,7 @@ def has_implementation_script_location(self, has_implementation_script_location) def software_requirements(self): """Gets the software_requirements of this DataTransformationSetup. # noqa: E501 - Description not available # noqa: E501 + Software requirements needed to install a software component # noqa: E501 :return: The software_requirements of this DataTransformationSetup. # noqa: E501 :rtype: list[str] @@ -398,7 +406,7 @@ def software_requirements(self): def software_requirements(self, software_requirements): """Sets the software_requirements of this DataTransformationSetup. - Description not available # noqa: E501 + Software requirements needed to install a software component # noqa: E501 :param software_requirements: The software_requirements of this DataTransformationSetup. # noqa: E501 :type: list[str] @@ -502,7 +510,7 @@ def compatible_visualization_software(self, compatible_visualization_software): def copyright_holder(self): """Gets the copyright_holder of this DataTransformationSetup. # noqa: E501 - Description not available # noqa: E501 + Copyright holder for a software component # noqa: E501 :return: The copyright_holder of this DataTransformationSetup. # noqa: E501 :rtype: list[object] @@ -513,7 +521,7 @@ def copyright_holder(self): def copyright_holder(self, copyright_holder): """Sets the copyright_holder of this DataTransformationSetup. - Description not available # noqa: E501 + Copyright holder for a software component # noqa: E501 :param copyright_holder: The copyright_holder of this DataTransformationSetup. # noqa: E501 :type: list[object] @@ -548,7 +556,7 @@ def has_faq(self, has_faq): def logo(self): """Gets the logo of this DataTransformationSetup. # noqa: E501 - Description not available # noqa: E501 + Property that links to the image used as logo for a software component # noqa: E501 :return: The logo of this DataTransformationSetup. # noqa: E501 :rtype: list[Image] @@ -559,7 +567,7 @@ def logo(self): def logo(self, logo): """Sets the logo of this DataTransformationSetup. - Description not available # noqa: E501 + Property that links to the image used as logo for a software component # noqa: E501 :param logo: The logo of this DataTransformationSetup. # noqa: E501 :type: list[Image] @@ -571,7 +579,7 @@ def logo(self, logo): def has_contact_person(self): """Gets the has_contact_person of this DataTransformationSetup. # noqa: E501 - Description not available # noqa: E501 + Contact person responsible for a software component # noqa: E501 :return: The has_contact_person of this DataTransformationSetup. # noqa: E501 :rtype: list[object] @@ -582,7 +590,7 @@ def has_contact_person(self): def has_contact_person(self, has_contact_person): """Sets the has_contact_person of this DataTransformationSetup. - Description not available # noqa: E501 + Contact person responsible for a software component # noqa: E501 :param has_contact_person: The has_contact_person of this DataTransformationSetup. # noqa: E501 :type: list[object] @@ -663,7 +671,7 @@ def identifier(self, identifier): def has_sample_execution(self): """Gets the has_sample_execution of this DataTransformationSetup. # noqa: E501 - Description not available # noqa: E501 + Property pointing to a sample execution of a software configuration # noqa: E501 :return: The has_sample_execution of this DataTransformationSetup. # noqa: E501 :rtype: list[SampleExecution] @@ -674,7 +682,7 @@ def has_sample_execution(self): def has_sample_execution(self, has_sample_execution): """Sets the has_sample_execution of this DataTransformationSetup. - Description not available # noqa: E501 + Property pointing to a sample execution of a software configuration # noqa: E501 :param has_sample_execution: The has_sample_execution of this DataTransformationSetup. # noqa: E501 :type: list[SampleExecution] @@ -686,7 +694,7 @@ def has_sample_execution(self, has_sample_execution): def has_sample_result(self): """Gets the has_sample_result of this DataTransformationSetup. # noqa: E501 - Description not available # noqa: E501 + Property designed to link a software configuration to a sample resource resulting from its execution # noqa: E501 :return: The has_sample_result of this DataTransformationSetup. # noqa: E501 :rtype: list[SampleResource] @@ -697,7 +705,7 @@ def has_sample_result(self): def has_sample_result(self, has_sample_result): """Sets the has_sample_result of this DataTransformationSetup. - Description not available # noqa: E501 + Property designed to link a software configuration to a sample resource resulting from its execution # noqa: E501 :param has_sample_result: The has_sample_result of this DataTransformationSetup. # noqa: E501 :type: list[SampleResource] @@ -709,7 +717,7 @@ def has_sample_result(self, has_sample_result): def author(self): """Gets the author of this DataTransformationSetup. # noqa: E501 - Description not available # noqa: E501 + The creator of a software component # noqa: E501 :return: The author of this DataTransformationSetup. # noqa: E501 :rtype: list[object] @@ -720,7 +728,7 @@ def author(self): def author(self, author): """Sets the author of this DataTransformationSetup. - Description not available # noqa: E501 + The creator of a software component # noqa: E501 :param author: The author of this DataTransformationSetup. # noqa: E501 :type: list[object] @@ -728,6 +736,29 @@ def author(self, author): self._author = author + @property + def was_derived_from_setup(self): + """Gets the was_derived_from_setup of this DataTransformationSetup. # noqa: E501 + + Property that links a setup to a previous version of that setup. This property is needed (for example) when creating snapshots of setups. # noqa: E501 + + :return: The was_derived_from_setup of this DataTransformationSetup. # noqa: E501 + :rtype: list[ConfigurationSetup] + """ + return self._was_derived_from_setup + + @was_derived_from_setup.setter + def was_derived_from_setup(self, was_derived_from_setup): + """Sets the was_derived_from_setup of this DataTransformationSetup. + + Property that links a setup to a previous version of that setup. This property is needed (for example) when creating snapshots of setups. # noqa: E501 + + :param was_derived_from_setup: The was_derived_from_setup of this DataTransformationSetup. # noqa: E501 + :type: list[ConfigurationSetup] + """ + + self._was_derived_from_setup = was_derived_from_setup + @property def has_constraint(self): """Gets the has_constraint of this DataTransformationSetup. # noqa: E501 @@ -824,7 +855,7 @@ def has_execution_command(self, has_execution_command): def date_published(self): """Gets the date_published of this DataTransformationSetup. # noqa: E501 - Description not available # noqa: E501 + Date when a software component was published # noqa: E501 :return: The date_published of this DataTransformationSetup. # noqa: E501 :rtype: list[datetime] @@ -835,7 +866,7 @@ def date_published(self): def date_published(self, date_published): """Sets the date_published of this DataTransformationSetup. - Description not available # noqa: E501 + Date when a software component was published # noqa: E501 :param date_published: The date_published of this DataTransformationSetup. # noqa: E501 :type: list[datetime] @@ -870,7 +901,7 @@ def license(self, license): def has_source_code(self): """Gets the has_source_code of this DataTransformationSetup. # noqa: E501 - Description not available # noqa: E501 + Property designed to link a software with its software source code (which may reside in a code repository such as GitHub) # noqa: E501 :return: The has_source_code of this DataTransformationSetup. # noqa: E501 :rtype: list[SourceCode] @@ -881,7 +912,7 @@ def has_source_code(self): def has_source_code(self, has_source_code): """Sets the has_source_code of this DataTransformationSetup. - Description not available # noqa: E501 + Property designed to link a software with its software source code (which may reside in a code repository such as GitHub) # noqa: E501 :param has_source_code: The has_source_code of this DataTransformationSetup. # noqa: E501 :type: list[SourceCode] @@ -939,7 +970,7 @@ def has_example(self, has_example): def publisher(self): """Gets the publisher of this DataTransformationSetup. # noqa: E501 - Description not available # noqa: E501 + Publisher organization or person responsible for a software component # noqa: E501 :return: The publisher of this DataTransformationSetup. # noqa: E501 :rtype: list[object] @@ -950,7 +981,7 @@ def publisher(self): def publisher(self, publisher): """Sets the publisher of this DataTransformationSetup. - Description not available # noqa: E501 + Publisher organization or person responsible for a software component # noqa: E501 :param publisher: The publisher of this DataTransformationSetup. # noqa: E501 :type: list[object] @@ -981,6 +1012,29 @@ def has_output(self, has_output): self._has_output = has_output + @property + def status(self): + """Gets the status of this DataTransformationSetup. # noqa: E501 + + Data property to indicate the status of a configuration setups. For example, to indicate that a setup has been executed in a platform, that the setup should notbe shown to users (it's an auxiliary setup), etc. # noqa: E501 + + :return: The status of this DataTransformationSetup. # noqa: E501 + :rtype: list[str] + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this DataTransformationSetup. + + Data property to indicate the status of a configuration setups. For example, to indicate that a setup has been executed in a platform, that the setup should notbe shown to users (it's an auxiliary setup), etc. # noqa: E501 + + :param status: The status of this DataTransformationSetup. # noqa: E501 + :type: list[str] + """ + + self._status = status + @property def doi(self): """Gets the doi of this DataTransformationSetup. # noqa: E501 @@ -1077,7 +1131,7 @@ def support_details(self, support_details): def has_version(self): """Gets the has_version of this DataTransformationSetup. # noqa: E501 - Description not available # noqa: E501 + Property designed to link a software component with its corresponding versions # noqa: E501 :return: The has_version of this DataTransformationSetup. # noqa: E501 :rtype: list[SoftwareVersion] @@ -1088,7 +1142,7 @@ def has_version(self): def has_version(self, has_version): """Sets the has_version of this DataTransformationSetup. - Description not available # noqa: E501 + Property designed to link a software component with its corresponding versions # noqa: E501 :param has_version: The has_version of this DataTransformationSetup. # noqa: E501 :type: list[SoftwareVersion] @@ -1100,7 +1154,7 @@ def has_version(self, has_version): def has_typical_data_source(self): """Gets the has_typical_data_source of this DataTransformationSetup. # noqa: E501 - Description not available # noqa: E501 + Typical data sources that are used by a software component # noqa: E501 :return: The has_typical_data_source of this DataTransformationSetup. # noqa: E501 :rtype: list[str] @@ -1111,7 +1165,7 @@ def has_typical_data_source(self): def has_typical_data_source(self, has_typical_data_source): """Sets the has_typical_data_source of this DataTransformationSetup. - Description not available # noqa: E501 + Typical data sources that are used by a software component # noqa: E501 :param has_typical_data_source: The has_typical_data_source of this DataTransformationSetup. # noqa: E501 :type: list[str] @@ -1169,7 +1223,7 @@ def reference_publication(self, reference_publication): def screenshot(self): """Gets the screenshot of this DataTransformationSetup. # noqa: E501 - Description not available # noqa: E501 + Image illustrating a snapshot of the target software # noqa: E501 :return: The screenshot of this DataTransformationSetup. # noqa: E501 :rtype: list[Image] @@ -1180,7 +1234,7 @@ def screenshot(self): def screenshot(self, screenshot): """Sets the screenshot of this DataTransformationSetup. - Description not available # noqa: E501 + Image illustrating a snapshot of the target software # noqa: E501 :param screenshot: The screenshot of this DataTransformationSetup. # noqa: E501 :type: list[Image] @@ -1192,7 +1246,7 @@ def screenshot(self, screenshot): def had_primary_source(self): """Gets the had_primary_source of this DataTransformationSetup. # noqa: E501 - had primary source # noqa: E501 + Property to identify the original source of the information of the annotated resource. It could be a web page, an organization, a person, some experiment notes, etc. # noqa: E501 :return: The had_primary_source of this DataTransformationSetup. # noqa: E501 :rtype: list[object] @@ -1203,7 +1257,7 @@ def had_primary_source(self): def had_primary_source(self, had_primary_source): """Sets the had_primary_source of this DataTransformationSetup. - had primary source # noqa: E501 + Property to identify the original source of the information of the annotated resource. It could be a web page, an organization, a person, some experiment notes, etc. # noqa: E501 :param had_primary_source: The had_primary_source of this DataTransformationSetup. # noqa: E501 :type: list[object] @@ -1261,7 +1315,7 @@ def has_software_image(self, has_software_image): def date_created(self): """Gets the date_created of this DataTransformationSetup. # noqa: E501 - Description not available # noqa: E501 + Date when a software component was created # noqa: E501 :return: The date_created of this DataTransformationSetup. # noqa: E501 :rtype: list[datetime] @@ -1272,7 +1326,7 @@ def date_created(self): def date_created(self, date_created): """Sets the date_created of this DataTransformationSetup. - Description not available # noqa: E501 + Date when a software component was created # noqa: E501 :param date_created: The date_created of this DataTransformationSetup. # noqa: E501 :type: list[datetime] @@ -1284,7 +1338,7 @@ def date_created(self, date_created): def contributor(self): """Gets the contributor of this DataTransformationSetup. # noqa: E501 - Description not available # noqa: E501 + Contributor to a software component # noqa: E501 :return: The contributor of this DataTransformationSetup. # noqa: E501 :rtype: list[Person] @@ -1295,7 +1349,7 @@ def contributor(self): def contributor(self, contributor): """Sets the contributor of this DataTransformationSetup. - Description not available # noqa: E501 + Contributor to a software component # noqa: E501 :param contributor: The contributor of this DataTransformationSetup. # noqa: E501 :type: list[Person] @@ -1376,7 +1430,7 @@ def has_sample_visualization(self, has_sample_visualization): def memory_requirements(self): """Gets the memory_requirements of this DataTransformationSetup. # noqa: E501 - Description not available # noqa: E501 + Memory requirements of a software # noqa: E501 :return: The memory_requirements of this DataTransformationSetup. # noqa: E501 :rtype: list[str] @@ -1387,7 +1441,7 @@ def memory_requirements(self): def memory_requirements(self, memory_requirements): """Sets the memory_requirements of this DataTransformationSetup. - Description not available # noqa: E501 + Memory requirements of a software # noqa: E501 :param memory_requirements: The memory_requirements of this DataTransformationSetup. # noqa: E501 :type: list[str] @@ -1445,7 +1499,7 @@ def citation(self, citation): def processor_requirements(self): """Gets the processor_requirements of this DataTransformationSetup. # noqa: E501 - Description not available # noqa: E501 + Processor requirements of a software component # noqa: E501 :return: The processor_requirements of this DataTransformationSetup. # noqa: E501 :rtype: list[str] @@ -1456,7 +1510,7 @@ def processor_requirements(self): def processor_requirements(self, processor_requirements): """Sets the processor_requirements of this DataTransformationSetup. - Description not available # noqa: E501 + Processor requirements of a software component # noqa: E501 :param processor_requirements: The processor_requirements of this DataTransformationSetup. # noqa: E501 :type: list[str] @@ -1629,7 +1683,7 @@ def has_parameter(self, has_parameter): def operating_systems(self): """Gets the operating_systems of this DataTransformationSetup. # noqa: E501 - Description not available # noqa: E501 + Operating systems under which a software component can operate # noqa: E501 :return: The operating_systems of this DataTransformationSetup. # noqa: E501 :rtype: list[str] @@ -1640,7 +1694,7 @@ def operating_systems(self): def operating_systems(self, operating_systems): """Sets the operating_systems of this DataTransformationSetup. - Description not available # noqa: E501 + Operating systems under which a software component can operate # noqa: E501 :param operating_systems: The operating_systems of this DataTransformationSetup. # noqa: E501 :type: list[str] diff --git a/modelcatalog/models/dataset_specification.py b/modelcatalog/models/dataset_specification.py index 26ebb19..27dbb66 100644 --- a/modelcatalog/models/dataset_specification.py +++ b/modelcatalog/models/dataset_specification.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ @@ -41,6 +41,7 @@ class DatasetSpecification(object): 'label': 'list[str]', 'type': 'list[str]', 'has_fixed_resource': 'list[SampleResource]', + 'is_transformed_from': 'list[DatasetSpecification]', 'has_data_transformation_setup': 'list[DataTransformationSetup]', 'position': 'list[int]', 'id': 'str' @@ -57,12 +58,13 @@ class DatasetSpecification(object): 'label': 'label', 'type': 'type', 'has_fixed_resource': 'hasFixedResource', + 'is_transformed_from': 'isTransformedFrom', 'has_data_transformation_setup': 'hasDataTransformationSetup', 'position': 'position', 'id': 'id' } - def __init__(self, has_dimensionality=None, has_format=None, path_location=None, has_file_structure=None, description=None, has_data_transformation=None, has_presentation=None, label=None, type=None, has_fixed_resource=None, has_data_transformation_setup=None, position=None, id=None): # noqa: E501 + def __init__(self, has_dimensionality=None, has_format=None, path_location=None, has_file_structure=None, description=None, has_data_transformation=None, has_presentation=None, label=None, type=None, has_fixed_resource=None, is_transformed_from=None, has_data_transformation_setup=None, position=None, id=None): # noqa: E501 """DatasetSpecification - a model defined in OpenAPI""" # noqa: E501 self._has_dimensionality = None @@ -75,6 +77,7 @@ def __init__(self, has_dimensionality=None, has_format=None, path_location=None, self._label = None self._type = None self._has_fixed_resource = None + self._is_transformed_from = None self._has_data_transformation_setup = None self._position = None self._id = None @@ -90,6 +93,7 @@ def __init__(self, has_dimensionality=None, has_format=None, path_location=None, self.label = label self.type = type self.has_fixed_resource = has_fixed_resource + self.is_transformed_from = is_transformed_from self.has_data_transformation_setup = has_data_transformation_setup self.position = position if id is not None: @@ -325,6 +329,29 @@ def has_fixed_resource(self, has_fixed_resource): self._has_fixed_resource = has_fixed_resource + @property + def is_transformed_from(self): + """Gets the is_transformed_from of this DatasetSpecification. # noqa: E501 + + Property that links a dataset specification from a model configuration or setup to the output from a target data transformation. This occurs when a data transformation produces several outputs, but only one of them is the one needed for a model # noqa: E501 + + :return: The is_transformed_from of this DatasetSpecification. # noqa: E501 + :rtype: list[DatasetSpecification] + """ + return self._is_transformed_from + + @is_transformed_from.setter + def is_transformed_from(self, is_transformed_from): + """Sets the is_transformed_from of this DatasetSpecification. + + Property that links a dataset specification from a model configuration or setup to the output from a target data transformation. This occurs when a data transformation produces several outputs, but only one of them is the one needed for a model # noqa: E501 + + :param is_transformed_from: The is_transformed_from of this DatasetSpecification. # noqa: E501 + :type: list[DatasetSpecification] + """ + + self._is_transformed_from = is_transformed_from + @property def has_data_transformation_setup(self): """Gets the has_data_transformation_setup of this DatasetSpecification. # noqa: E501 diff --git a/modelcatalog/models/empirical_model.py b/modelcatalog/models/empirical_model.py index 1538e9e..021dc01 100644 --- a/modelcatalog/models/empirical_model.py +++ b/modelcatalog/models/empirical_model.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ @@ -63,7 +63,7 @@ class EmpiricalModel(object): 'description': 'list[str]', 'reference_publication': 'list[str]', 'screenshot': 'list[Image]', - 'has_model_category': 'list[str]', + 'has_model_category': 'list[ModelCategory]', 'had_primary_source': 'list[object]', 'issue_tracker': 'list[str]', 'date_created': 'list[datetime]', @@ -991,10 +991,10 @@ def screenshot(self, screenshot): def has_model_category(self): """Gets the has_model_category of this EmpiricalModel. # noqa: E501 - Category associated with a model (e.g., Hydrology) # noqa: E501 + Category associated with a model (e.g., Hydrology, etc.) # noqa: E501 :return: The has_model_category of this EmpiricalModel. # noqa: E501 - :rtype: list[str] + :rtype: list[ModelCategory] """ return self._has_model_category @@ -1002,10 +1002,10 @@ def has_model_category(self): def has_model_category(self, has_model_category): """Sets the has_model_category of this EmpiricalModel. - Category associated with a model (e.g., Hydrology) # noqa: E501 + Category associated with a model (e.g., Hydrology, etc.) # noqa: E501 :param has_model_category: The has_model_category of this EmpiricalModel. # noqa: E501 - :type: list[str] + :type: list[ModelCategory] """ self._has_model_category = has_model_category diff --git a/modelcatalog/models/emulator.py b/modelcatalog/models/emulator.py index ebb64a6..741c2f4 100644 --- a/modelcatalog/models/emulator.py +++ b/modelcatalog/models/emulator.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ @@ -63,7 +63,7 @@ class Emulator(object): 'description': 'list[str]', 'reference_publication': 'list[str]', 'screenshot': 'list[Image]', - 'has_model_category': 'list[str]', + 'has_model_category': 'list[ModelCategory]', 'had_primary_source': 'list[object]', 'issue_tracker': 'list[str]', 'date_created': 'list[datetime]', @@ -991,10 +991,10 @@ def screenshot(self, screenshot): def has_model_category(self): """Gets the has_model_category of this Emulator. # noqa: E501 - Category associated with a model (e.g., Hydrology) # noqa: E501 + Category associated with a model (e.g., Hydrology, etc.) # noqa: E501 :return: The has_model_category of this Emulator. # noqa: E501 - :rtype: list[str] + :rtype: list[ModelCategory] """ return self._has_model_category @@ -1002,10 +1002,10 @@ def has_model_category(self): def has_model_category(self, has_model_category): """Sets the has_model_category of this Emulator. - Category associated with a model (e.g., Hydrology) # noqa: E501 + Category associated with a model (e.g., Hydrology, etc.) # noqa: E501 :param has_model_category: The has_model_category of this Emulator. # noqa: E501 - :type: list[str] + :type: list[ModelCategory] """ self._has_model_category = has_model_category diff --git a/modelcatalog/models/equation.py b/modelcatalog/models/equation.py index 2c9156e..fdab8f3 100644 --- a/modelcatalog/models/equation.py +++ b/modelcatalog/models/equation.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/models/funding_information.py b/modelcatalog/models/funding_information.py index c565af5..62b9f8b 100644 --- a/modelcatalog/models/funding_information.py +++ b/modelcatalog/models/funding_information.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ @@ -140,7 +140,7 @@ def label(self, label): def funding_source(self): """Gets the funding_source of this FundingInformation. # noqa: E501 - Description not available # noqa: E501 + Link to the organization funding a software component # noqa: E501 :return: The funding_source of this FundingInformation. # noqa: E501 :rtype: list[Organization] @@ -151,7 +151,7 @@ def funding_source(self): def funding_source(self, funding_source): """Sets the funding_source of this FundingInformation. - Description not available # noqa: E501 + Link to the organization funding a software component # noqa: E501 :param funding_source: The funding_source of this FundingInformation. # noqa: E501 :type: list[Organization] diff --git a/modelcatalog/models/geo_coordinates.py b/modelcatalog/models/geo_coordinates.py index 1d49045..7518b6e 100644 --- a/modelcatalog/models/geo_coordinates.py +++ b/modelcatalog/models/geo_coordinates.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/models/geo_shape.py b/modelcatalog/models/geo_shape.py index 17ea6dc..4931ab6 100644 --- a/modelcatalog/models/geo_shape.py +++ b/modelcatalog/models/geo_shape.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/models/grid.py b/modelcatalog/models/grid.py index b05baca..9915fde 100644 --- a/modelcatalog/models/grid.py +++ b/modelcatalog/models/grid.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ @@ -43,6 +43,7 @@ class Grid(object): 'has_fixed_resource': 'list[SampleResource]', 'has_coordinate_system': 'list[str]', 'has_spatial_resolution': 'list[str]', + 'is_transformed_from': 'list[DatasetSpecification]', 'has_shape': 'list[str]', 'has_dimension': 'list[str]', 'has_data_transformation_setup': 'list[DataTransformationSetup]', @@ -63,6 +64,7 @@ class Grid(object): 'has_fixed_resource': 'hasFixedResource', 'has_coordinate_system': 'hasCoordinateSystem', 'has_spatial_resolution': 'hasSpatialResolution', + 'is_transformed_from': 'isTransformedFrom', 'has_shape': 'hasShape', 'has_dimension': 'hasDimension', 'has_data_transformation_setup': 'hasDataTransformationSetup', @@ -70,7 +72,7 @@ class Grid(object): 'id': 'id' } - def __init__(self, has_dimensionality=None, has_format=None, path_location=None, has_file_structure=None, description=None, has_data_transformation=None, has_presentation=None, label=None, type=None, has_fixed_resource=None, has_coordinate_system=None, has_spatial_resolution=None, has_shape=None, has_dimension=None, has_data_transformation_setup=None, position=None, id=None): # noqa: E501 + def __init__(self, has_dimensionality=None, has_format=None, path_location=None, has_file_structure=None, description=None, has_data_transformation=None, has_presentation=None, label=None, type=None, has_fixed_resource=None, has_coordinate_system=None, has_spatial_resolution=None, is_transformed_from=None, has_shape=None, has_dimension=None, has_data_transformation_setup=None, position=None, id=None): # noqa: E501 """Grid - a model defined in OpenAPI""" # noqa: E501 self._has_dimensionality = None @@ -85,6 +87,7 @@ def __init__(self, has_dimensionality=None, has_format=None, path_location=None, self._has_fixed_resource = None self._has_coordinate_system = None self._has_spatial_resolution = None + self._is_transformed_from = None self._has_shape = None self._has_dimension = None self._has_data_transformation_setup = None @@ -104,6 +107,7 @@ def __init__(self, has_dimensionality=None, has_format=None, path_location=None, self.has_fixed_resource = has_fixed_resource self.has_coordinate_system = has_coordinate_system self.has_spatial_resolution = has_spatial_resolution + self.is_transformed_from = is_transformed_from self.has_shape = has_shape self.has_dimension = has_dimension self.has_data_transformation_setup = has_data_transformation_setup @@ -387,6 +391,29 @@ def has_spatial_resolution(self, has_spatial_resolution): self._has_spatial_resolution = has_spatial_resolution + @property + def is_transformed_from(self): + """Gets the is_transformed_from of this Grid. # noqa: E501 + + Description not available # noqa: E501 + + :return: The is_transformed_from of this Grid. # noqa: E501 + :rtype: list[DatasetSpecification] + """ + return self._is_transformed_from + + @is_transformed_from.setter + def is_transformed_from(self, is_transformed_from): + """Sets the is_transformed_from of this Grid. + + Description not available # noqa: E501 + + :param is_transformed_from: The is_transformed_from of this Grid. # noqa: E501 + :type: list[DatasetSpecification] + """ + + self._is_transformed_from = is_transformed_from + @property def has_shape(self): """Gets the has_shape of this Grid. # noqa: E501 diff --git a/modelcatalog/models/hybrid_model.py b/modelcatalog/models/hybrid_model.py index 8325111..64a2807 100644 --- a/modelcatalog/models/hybrid_model.py +++ b/modelcatalog/models/hybrid_model.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ @@ -63,7 +63,7 @@ class HybridModel(object): 'description': 'list[str]', 'reference_publication': 'list[str]', 'screenshot': 'list[Image]', - 'has_model_category': 'list[str]', + 'has_model_category': 'list[ModelCategory]', 'had_primary_source': 'list[object]', 'issue_tracker': 'list[str]', 'date_created': 'list[datetime]', @@ -991,10 +991,10 @@ def screenshot(self, screenshot): def has_model_category(self): """Gets the has_model_category of this HybridModel. # noqa: E501 - Category associated with a model (e.g., Hydrology) # noqa: E501 + Category associated with a model (e.g., Hydrology, etc.) # noqa: E501 :return: The has_model_category of this HybridModel. # noqa: E501 - :rtype: list[str] + :rtype: list[ModelCategory] """ return self._has_model_category @@ -1002,10 +1002,10 @@ def has_model_category(self): def has_model_category(self, has_model_category): """Sets the has_model_category of this HybridModel. - Category associated with a model (e.g., Hydrology) # noqa: E501 + Category associated with a model (e.g., Hydrology, etc.) # noqa: E501 :param has_model_category: The has_model_category of this HybridModel. # noqa: E501 - :type: list[str] + :type: list[ModelCategory] """ self._has_model_category = has_model_category diff --git a/modelcatalog/models/image.py b/modelcatalog/models/image.py index 930b14e..6107359 100644 --- a/modelcatalog/models/image.py +++ b/modelcatalog/models/image.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ @@ -41,6 +41,7 @@ class Image(object): 'label': 'list[str]', 'type': 'list[str]', 'has_fixed_resource': 'list[SampleResource]', + 'is_transformed_from': 'list[DatasetSpecification]', 'had_primary_source': 'list[object]', 'has_data_transformation_setup': 'list[DataTransformationSetup]', 'position': 'list[int]', @@ -59,6 +60,7 @@ class Image(object): 'label': 'label', 'type': 'type', 'has_fixed_resource': 'hasFixedResource', + 'is_transformed_from': 'isTransformedFrom', 'had_primary_source': 'hadPrimarySource', 'has_data_transformation_setup': 'hasDataTransformationSetup', 'position': 'position', @@ -66,7 +68,7 @@ class Image(object): 'value': 'value' } - def __init__(self, has_dimensionality=None, has_format=None, path_location=None, has_file_structure=None, description=None, has_data_transformation=None, has_presentation=None, label=None, type=None, has_fixed_resource=None, had_primary_source=None, has_data_transformation_setup=None, position=None, id=None, value=None): # noqa: E501 + def __init__(self, has_dimensionality=None, has_format=None, path_location=None, has_file_structure=None, description=None, has_data_transformation=None, has_presentation=None, label=None, type=None, has_fixed_resource=None, is_transformed_from=None, had_primary_source=None, has_data_transformation_setup=None, position=None, id=None, value=None): # noqa: E501 """Image - a model defined in OpenAPI""" # noqa: E501 self._has_dimensionality = None @@ -79,6 +81,7 @@ def __init__(self, has_dimensionality=None, has_format=None, path_location=None, self._label = None self._type = None self._has_fixed_resource = None + self._is_transformed_from = None self._had_primary_source = None self._has_data_transformation_setup = None self._position = None @@ -96,6 +99,7 @@ def __init__(self, has_dimensionality=None, has_format=None, path_location=None, self.label = label self.type = type self.has_fixed_resource = has_fixed_resource + self.is_transformed_from = is_transformed_from self.had_primary_source = had_primary_source self.has_data_transformation_setup = has_data_transformation_setup self.position = position @@ -333,11 +337,34 @@ def has_fixed_resource(self, has_fixed_resource): self._has_fixed_resource = has_fixed_resource + @property + def is_transformed_from(self): + """Gets the is_transformed_from of this Image. # noqa: E501 + + Property that links a dataset specification from a model configuration or setup to the output from a target data transformation. This occurs when a data transformation produces several outputs, but only one of them is the one needed for a model # noqa: E501 + + :return: The is_transformed_from of this Image. # noqa: E501 + :rtype: list[DatasetSpecification] + """ + return self._is_transformed_from + + @is_transformed_from.setter + def is_transformed_from(self, is_transformed_from): + """Sets the is_transformed_from of this Image. + + Property that links a dataset specification from a model configuration or setup to the output from a target data transformation. This occurs when a data transformation produces several outputs, but only one of them is the one needed for a model # noqa: E501 + + :param is_transformed_from: The is_transformed_from of this Image. # noqa: E501 + :type: list[DatasetSpecification] + """ + + self._is_transformed_from = is_transformed_from + @property def had_primary_source(self): """Gets the had_primary_source of this Image. # noqa: E501 - had primary source # noqa: E501 + Property to identify the original source of the information of the annotated resource. It could be a web page, an organization, a person, some experiment notes, etc. # noqa: E501 :return: The had_primary_source of this Image. # noqa: E501 :rtype: list[object] @@ -348,7 +375,7 @@ def had_primary_source(self): def had_primary_source(self, had_primary_source): """Sets the had_primary_source of this Image. - had primary source # noqa: E501 + Property to identify the original source of the information of the annotated resource. It could be a web page, an organization, a person, some experiment notes, etc. # noqa: E501 :param had_primary_source: The had_primary_source of this Image. # noqa: E501 :type: list[object] diff --git a/modelcatalog/models/intervention.py b/modelcatalog/models/intervention.py index 0997d52..acd0fdd 100644 --- a/modelcatalog/models/intervention.py +++ b/modelcatalog/models/intervention.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/models/model.py b/modelcatalog/models/model.py index c62dd98..16aefb9 100644 --- a/modelcatalog/models/model.py +++ b/modelcatalog/models/model.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ @@ -63,7 +63,7 @@ class Model(object): 'description': 'list[str]', 'reference_publication': 'list[str]', 'screenshot': 'list[Image]', - 'has_model_category': 'list[str]', + 'has_model_category': 'list[ModelCategory]', 'had_primary_source': 'list[object]', 'issue_tracker': 'list[str]', 'date_created': 'list[datetime]', @@ -991,10 +991,10 @@ def screenshot(self, screenshot): def has_model_category(self): """Gets the has_model_category of this Model. # noqa: E501 - Category associated with a model (e.g., Hydrology) # noqa: E501 + Category associated with a model (e.g., Hydrology, etc.) # noqa: E501 :return: The has_model_category of this Model. # noqa: E501 - :rtype: list[str] + :rtype: list[ModelCategory] """ return self._has_model_category @@ -1002,10 +1002,10 @@ def has_model_category(self): def has_model_category(self, has_model_category): """Sets the has_model_category of this Model. - Category associated with a model (e.g., Hydrology) # noqa: E501 + Category associated with a model (e.g., Hydrology, etc.) # noqa: E501 :param has_model_category: The has_model_category of this Model. # noqa: E501 - :type: list[str] + :type: list[ModelCategory] """ self._has_model_category = has_model_category diff --git a/modelcatalog/models/model_category.py b/modelcatalog/models/model_category.py new file mode 100644 index 0000000..621a6e6 --- /dev/null +++ b/modelcatalog/models/model_category.py @@ -0,0 +1,195 @@ +# coding: utf-8 + +""" + Model Catalog + + This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 + + The version of the OpenAPI document: v1.6.0 + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + + +class ModelCategory(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'description': 'list[str]', + 'id': 'str', + 'label': 'list[str]', + 'type': 'list[str]' + } + + attribute_map = { + 'description': 'description', + 'id': 'id', + 'label': 'label', + 'type': 'type' + } + + def __init__(self, description=None, id=None, label=None, type=None): # noqa: E501 + """ModelCategory - a model defined in OpenAPI""" # noqa: E501 + + self._description = None + self._id = None + self._label = None + self._type = None + self.discriminator = None + + self.description = description + if id is not None: + self.id = id + self.label = label + self.type = type + + @property + def description(self): + """Gets the description of this ModelCategory. # noqa: E501 + + small description # noqa: E501 + + :return: The description of this ModelCategory. # noqa: E501 + :rtype: list[str] + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this ModelCategory. + + small description # noqa: E501 + + :param description: The description of this ModelCategory. # noqa: E501 + :type: list[str] + """ + + self._description = description + + @property + def id(self): + """Gets the id of this ModelCategory. # noqa: E501 + + identifier # noqa: E501 + + :return: The id of this ModelCategory. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this ModelCategory. + + identifier # noqa: E501 + + :param id: The id of this ModelCategory. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def label(self): + """Gets the label of this ModelCategory. # noqa: E501 + + short description of the resource # noqa: E501 + + :return: The label of this ModelCategory. # noqa: E501 + :rtype: list[str] + """ + return self._label + + @label.setter + def label(self, label): + """Sets the label of this ModelCategory. + + short description of the resource # noqa: E501 + + :param label: The label of this ModelCategory. # noqa: E501 + :type: list[str] + """ + + self._label = label + + @property + def type(self): + """Gets the type of this ModelCategory. # noqa: E501 + + type of the resource # noqa: E501 + + :return: The type of this ModelCategory. # noqa: E501 + :rtype: list[str] + """ + return self._type + + @type.setter + def type(self, type): + """Sets the type of this ModelCategory. + + type of the resource # noqa: E501 + + :param type: The type of this ModelCategory. # noqa: E501 + :type: list[str] + """ + + self._type = type + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ModelCategory): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/modelcatalog/models/model_configuration.py b/modelcatalog/models/model_configuration.py index 9c067de..9613637 100644 --- a/modelcatalog/models/model_configuration.py +++ b/modelcatalog/models/model_configuration.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ @@ -75,7 +75,7 @@ class ModelConfiguration(object): 'description': 'list[str]', 'reference_publication': 'list[str]', 'screenshot': 'list[Image]', - 'has_model_category': 'list[str]', + 'has_model_category': 'list[ModelCategory]', 'had_primary_source': 'list[object]', 'issue_tracker': 'list[str]', 'has_software_image': 'list[SoftwareImage]', @@ -1339,10 +1339,10 @@ def screenshot(self, screenshot): def has_model_category(self): """Gets the has_model_category of this ModelConfiguration. # noqa: E501 - Category associated with a model (e.g., Hydrology) # noqa: E501 + Category associated with a model (e.g., Hydrology, etc.) # noqa: E501 :return: The has_model_category of this ModelConfiguration. # noqa: E501 - :rtype: list[str] + :rtype: list[ModelCategory] """ return self._has_model_category @@ -1350,10 +1350,10 @@ def has_model_category(self): def has_model_category(self, has_model_category): """Sets the has_model_category of this ModelConfiguration. - Category associated with a model (e.g., Hydrology) # noqa: E501 + Category associated with a model (e.g., Hydrology, etc.) # noqa: E501 :param has_model_category: The has_model_category of this ModelConfiguration. # noqa: E501 - :type: list[str] + :type: list[ModelCategory] """ self._has_model_category = has_model_category diff --git a/modelcatalog/models/model_configuration_setup.py b/modelcatalog/models/model_configuration_setup.py index dd3bc24..c57caa6 100644 --- a/modelcatalog/models/model_configuration_setup.py +++ b/modelcatalog/models/model_configuration_setup.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ @@ -54,6 +54,7 @@ class ModelConfigurationSetup(object): 'has_sample_execution': 'list[SampleExecution]', 'has_sample_result': 'list[SampleResource]', 'author': 'list[object]', + 'was_derived_from_setup': 'list[ConfigurationSetup]', 'has_constraint': 'list[str]', 'has_build_file': 'list[str]', 'short_description': 'list[str]', @@ -68,6 +69,7 @@ class ModelConfigurationSetup(object): 'publisher': 'list[object]', 'has_output': 'list[DatasetSpecification]', 'has_output_time_interval': 'list[TimeInterval]', + 'status': 'list[str]', 'doi': 'list[str]', 'parameter_assignment_method': 'list[str]', 'has_funding': 'list[FundingInformation]', @@ -79,7 +81,7 @@ class ModelConfigurationSetup(object): 'description': 'list[str]', 'reference_publication': 'list[str]', 'screenshot': 'list[Image]', - 'has_model_category': 'list[str]', + 'has_model_category': 'list[ModelCategory]', 'had_primary_source': 'list[object]', 'issue_tracker': 'list[str]', 'has_software_image': 'list[SoftwareImage]', @@ -134,6 +136,7 @@ class ModelConfigurationSetup(object): 'has_sample_execution': 'hasSampleExecution', 'has_sample_result': 'hasSampleResult', 'author': 'author', + 'was_derived_from_setup': 'wasDerivedFromSetup', 'has_constraint': 'hasConstraint', 'has_build_file': 'hasBuildFile', 'short_description': 'shortDescription', @@ -148,6 +151,7 @@ class ModelConfigurationSetup(object): 'publisher': 'publisher', 'has_output': 'hasOutput', 'has_output_time_interval': 'hasOutputTimeInterval', + 'status': 'status', 'doi': 'doi', 'parameter_assignment_method': 'parameterAssignmentMethod', 'has_funding': 'hasFunding', @@ -190,7 +194,7 @@ class ModelConfigurationSetup(object): 'has_input': 'hasInput' } - def __init__(self, has_download_instructions=None, keywords=None, has_documentation=None, has_grid=None, has_implementation_script_location=None, software_requirements=None, has_download_url=None, type=None, calibrated_variable=None, has_installation_instructions=None, compatible_visualization_software=None, copyright_holder=None, calibration_method=None, has_region=None, has_faq=None, logo=None, has_contact_person=None, tag=None, id=None, identifier=None, has_sample_execution=None, has_sample_result=None, author=None, has_constraint=None, has_build_file=None, short_description=None, has_execution_command=None, date_published=None, license=None, has_source_code=None, has_setup=None, has_explanation_diagram=None, has_example=None, calibration_interval=None, publisher=None, has_output=None, has_output_time_interval=None, doi=None, parameter_assignment_method=None, has_funding=None, has_component_location=None, has_process=None, support_details=None, has_version=None, has_typical_data_source=None, description=None, reference_publication=None, screenshot=None, has_model_category=None, had_primary_source=None, issue_tracker=None, has_software_image=None, date_created=None, contributor=None, has_model_result_table=None, calibration_target_variable=None, has_purpose=None, has_executable_instructions=None, has_sample_visualization=None, has_causal_diagram=None, memory_requirements=None, website=None, citation=None, processor_requirements=None, adjustable_parameter=None, has_usage_notes=None, has_support_script_location=None, readme=None, label=None, has_assumption=None, has_parameter=None, operating_systems=None, has_executable_notebook=None, valid_until=None, has_equation=None, useful_for_calculating_index=None, has_input=None): # noqa: E501 + def __init__(self, has_download_instructions=None, keywords=None, has_documentation=None, has_grid=None, has_implementation_script_location=None, software_requirements=None, has_download_url=None, type=None, calibrated_variable=None, has_installation_instructions=None, compatible_visualization_software=None, copyright_holder=None, calibration_method=None, has_region=None, has_faq=None, logo=None, has_contact_person=None, tag=None, id=None, identifier=None, has_sample_execution=None, has_sample_result=None, author=None, was_derived_from_setup=None, has_constraint=None, has_build_file=None, short_description=None, has_execution_command=None, date_published=None, license=None, has_source_code=None, has_setup=None, has_explanation_diagram=None, has_example=None, calibration_interval=None, publisher=None, has_output=None, has_output_time_interval=None, status=None, doi=None, parameter_assignment_method=None, has_funding=None, has_component_location=None, has_process=None, support_details=None, has_version=None, has_typical_data_source=None, description=None, reference_publication=None, screenshot=None, has_model_category=None, had_primary_source=None, issue_tracker=None, has_software_image=None, date_created=None, contributor=None, has_model_result_table=None, calibration_target_variable=None, has_purpose=None, has_executable_instructions=None, has_sample_visualization=None, has_causal_diagram=None, memory_requirements=None, website=None, citation=None, processor_requirements=None, adjustable_parameter=None, has_usage_notes=None, has_support_script_location=None, readme=None, label=None, has_assumption=None, has_parameter=None, operating_systems=None, has_executable_notebook=None, valid_until=None, has_equation=None, useful_for_calculating_index=None, has_input=None): # noqa: E501 """ModelConfigurationSetup - a model defined in OpenAPI""" # noqa: E501 self._has_download_instructions = None @@ -216,6 +220,7 @@ def __init__(self, has_download_instructions=None, keywords=None, has_documentat self._has_sample_execution = None self._has_sample_result = None self._author = None + self._was_derived_from_setup = None self._has_constraint = None self._has_build_file = None self._short_description = None @@ -230,6 +235,7 @@ def __init__(self, has_download_instructions=None, keywords=None, has_documentat self._publisher = None self._has_output = None self._has_output_time_interval = None + self._status = None self._doi = None self._parameter_assignment_method = None self._has_funding = None @@ -296,6 +302,7 @@ def __init__(self, has_download_instructions=None, keywords=None, has_documentat self.has_sample_execution = has_sample_execution self.has_sample_result = has_sample_result self.author = author + self.was_derived_from_setup = was_derived_from_setup self.has_constraint = has_constraint self.has_build_file = has_build_file self.short_description = short_description @@ -310,6 +317,7 @@ def __init__(self, has_download_instructions=None, keywords=None, has_documentat self.publisher = publisher self.has_output = has_output self.has_output_time_interval = has_output_time_interval + self.status = status self.doi = doi self.parameter_assignment_method = parameter_assignment_method self.has_funding = has_funding @@ -880,6 +888,29 @@ def author(self, author): self._author = author + @property + def was_derived_from_setup(self): + """Gets the was_derived_from_setup of this ModelConfigurationSetup. # noqa: E501 + + Description not available # noqa: E501 + + :return: The was_derived_from_setup of this ModelConfigurationSetup. # noqa: E501 + :rtype: list[ConfigurationSetup] + """ + return self._was_derived_from_setup + + @was_derived_from_setup.setter + def was_derived_from_setup(self, was_derived_from_setup): + """Sets the was_derived_from_setup of this ModelConfigurationSetup. + + Description not available # noqa: E501 + + :param was_derived_from_setup: The was_derived_from_setup of this ModelConfigurationSetup. # noqa: E501 + :type: list[ConfigurationSetup] + """ + + self._was_derived_from_setup = was_derived_from_setup + @property def has_constraint(self): """Gets the has_constraint of this ModelConfigurationSetup. # noqa: E501 @@ -1202,6 +1233,29 @@ def has_output_time_interval(self, has_output_time_interval): self._has_output_time_interval = has_output_time_interval + @property + def status(self): + """Gets the status of this ModelConfigurationSetup. # noqa: E501 + + Description not available # noqa: E501 + + :return: The status of this ModelConfigurationSetup. # noqa: E501 + :rtype: list[str] + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this ModelConfigurationSetup. + + Description not available # noqa: E501 + + :param status: The status of this ModelConfigurationSetup. # noqa: E501 + :type: list[str] + """ + + self._status = status + @property def doi(self): """Gets the doi of this ModelConfigurationSetup. # noqa: E501 @@ -1459,10 +1513,10 @@ def screenshot(self, screenshot): def has_model_category(self): """Gets the has_model_category of this ModelConfigurationSetup. # noqa: E501 - Category associated with a model (e.g., Hydrology) # noqa: E501 + Category associated with a model (e.g., Hydrology, etc.) # noqa: E501 :return: The has_model_category of this ModelConfigurationSetup. # noqa: E501 - :rtype: list[str] + :rtype: list[ModelCategory] """ return self._has_model_category @@ -1470,10 +1524,10 @@ def has_model_category(self): def has_model_category(self, has_model_category): """Sets the has_model_category of this ModelConfigurationSetup. - Category associated with a model (e.g., Hydrology) # noqa: E501 + Category associated with a model (e.g., Hydrology, etc.) # noqa: E501 :param has_model_category: The has_model_category of this ModelConfigurationSetup. # noqa: E501 - :type: list[str] + :type: list[ModelCategory] """ self._has_model_category = has_model_category diff --git a/modelcatalog/models/numerical_index.py b/modelcatalog/models/numerical_index.py index a5fa59b..abf67e5 100644 --- a/modelcatalog/models/numerical_index.py +++ b/modelcatalog/models/numerical_index.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/models/organization.py b/modelcatalog/models/organization.py index a3ff759..597ea16 100644 --- a/modelcatalog/models/organization.py +++ b/modelcatalog/models/organization.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/models/parameter.py b/modelcatalog/models/parameter.py index 427a8a1..701ac1f 100644 --- a/modelcatalog/models/parameter.py +++ b/modelcatalog/models/parameter.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/models/person.py b/modelcatalog/models/person.py index b0a495c..b81ffd0 100644 --- a/modelcatalog/models/person.py +++ b/modelcatalog/models/person.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ @@ -213,7 +213,7 @@ def type(self, type): def email(self): """Gets the email of this Person. # noqa: E501 - Description not available # noqa: E501 + Email of a person # noqa: E501 :return: The email of this Person. # noqa: E501 :rtype: list[str] @@ -224,7 +224,7 @@ def email(self): def email(self, email): """Sets the email of this Person. - Description not available # noqa: E501 + Email of a person # noqa: E501 :param email: The email of this Person. # noqa: E501 :type: list[str] diff --git a/modelcatalog/models/point_based_grid.py b/modelcatalog/models/point_based_grid.py index 5e75a34..10820d3 100644 --- a/modelcatalog/models/point_based_grid.py +++ b/modelcatalog/models/point_based_grid.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ @@ -43,6 +43,7 @@ class PointBasedGrid(object): 'has_fixed_resource': 'list[SampleResource]', 'has_coordinate_system': 'list[str]', 'has_spatial_resolution': 'list[str]', + 'is_transformed_from': 'list[DatasetSpecification]', 'has_shape': 'list[str]', 'has_dimension': 'list[str]', 'has_data_transformation_setup': 'list[DataTransformationSetup]', @@ -63,6 +64,7 @@ class PointBasedGrid(object): 'has_fixed_resource': 'hasFixedResource', 'has_coordinate_system': 'hasCoordinateSystem', 'has_spatial_resolution': 'hasSpatialResolution', + 'is_transformed_from': 'isTransformedFrom', 'has_shape': 'hasShape', 'has_dimension': 'hasDimension', 'has_data_transformation_setup': 'hasDataTransformationSetup', @@ -70,7 +72,7 @@ class PointBasedGrid(object): 'id': 'id' } - def __init__(self, has_dimensionality=None, has_format=None, path_location=None, has_file_structure=None, description=None, has_data_transformation=None, has_presentation=None, label=None, type=None, has_fixed_resource=None, has_coordinate_system=None, has_spatial_resolution=None, has_shape=None, has_dimension=None, has_data_transformation_setup=None, position=None, id=None): # noqa: E501 + def __init__(self, has_dimensionality=None, has_format=None, path_location=None, has_file_structure=None, description=None, has_data_transformation=None, has_presentation=None, label=None, type=None, has_fixed_resource=None, has_coordinate_system=None, has_spatial_resolution=None, is_transformed_from=None, has_shape=None, has_dimension=None, has_data_transformation_setup=None, position=None, id=None): # noqa: E501 """PointBasedGrid - a model defined in OpenAPI""" # noqa: E501 self._has_dimensionality = None @@ -85,6 +87,7 @@ def __init__(self, has_dimensionality=None, has_format=None, path_location=None, self._has_fixed_resource = None self._has_coordinate_system = None self._has_spatial_resolution = None + self._is_transformed_from = None self._has_shape = None self._has_dimension = None self._has_data_transformation_setup = None @@ -104,6 +107,7 @@ def __init__(self, has_dimensionality=None, has_format=None, path_location=None, self.has_fixed_resource = has_fixed_resource self.has_coordinate_system = has_coordinate_system self.has_spatial_resolution = has_spatial_resolution + self.is_transformed_from = is_transformed_from self.has_shape = has_shape self.has_dimension = has_dimension self.has_data_transformation_setup = has_data_transformation_setup @@ -387,6 +391,29 @@ def has_spatial_resolution(self, has_spatial_resolution): self._has_spatial_resolution = has_spatial_resolution + @property + def is_transformed_from(self): + """Gets the is_transformed_from of this PointBasedGrid. # noqa: E501 + + Description not available # noqa: E501 + + :return: The is_transformed_from of this PointBasedGrid. # noqa: E501 + :rtype: list[DatasetSpecification] + """ + return self._is_transformed_from + + @is_transformed_from.setter + def is_transformed_from(self, is_transformed_from): + """Sets the is_transformed_from of this PointBasedGrid. + + Description not available # noqa: E501 + + :param is_transformed_from: The is_transformed_from of this PointBasedGrid. # noqa: E501 + :type: list[DatasetSpecification] + """ + + self._is_transformed_from = is_transformed_from + @property def has_shape(self): """Gets the has_shape of this PointBasedGrid. # noqa: E501 diff --git a/modelcatalog/models/process.py b/modelcatalog/models/process.py index e81c2e8..e500c13 100644 --- a/modelcatalog/models/process.py +++ b/modelcatalog/models/process.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/models/region.py b/modelcatalog/models/region.py index f6941f2..5865bf2 100644 --- a/modelcatalog/models/region.py +++ b/modelcatalog/models/region.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/models/sample_collection.py b/modelcatalog/models/sample_collection.py index adf3c13..db4d495 100644 --- a/modelcatalog/models/sample_collection.py +++ b/modelcatalog/models/sample_collection.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/models/sample_execution.py b/modelcatalog/models/sample_execution.py index b68b0a9..bced642 100644 --- a/modelcatalog/models/sample_execution.py +++ b/modelcatalog/models/sample_execution.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/models/sample_resource.py b/modelcatalog/models/sample_resource.py index ae204c9..21be4e0 100644 --- a/modelcatalog/models/sample_resource.py +++ b/modelcatalog/models/sample_resource.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/models/software.py b/modelcatalog/models/software.py index be91991..fd08b67 100644 --- a/modelcatalog/models/software.py +++ b/modelcatalog/models/software.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ @@ -48,8 +48,8 @@ class Software(object): 'had_primary_source': 'list[object]', 'issue_tracker': 'list[str]', 'date_created': 'list[datetime]', - 'contributor': 'list[Person]', 'compatible_visualization_software': 'list[Software]', + 'contributor': 'list[Person]', 'copyright_holder': 'list[object]', 'has_faq': 'list[str]', 'logo': 'list[Image]', @@ -99,8 +99,8 @@ class Software(object): 'had_primary_source': 'hadPrimarySource', 'issue_tracker': 'issueTracker', 'date_created': 'dateCreated', - 'contributor': 'contributor', 'compatible_visualization_software': 'compatibleVisualizationSoftware', + 'contributor': 'contributor', 'copyright_holder': 'copyrightHolder', 'has_faq': 'hasFAQ', 'logo': 'logo', @@ -132,7 +132,7 @@ class Software(object): 'doi': 'doi' } - def __init__(self, has_download_instructions=None, has_funding=None, keywords=None, has_documentation=None, support_details=None, software_requirements=None, has_version=None, has_typical_data_source=None, has_download_url=None, description=None, reference_publication=None, screenshot=None, type=None, has_installation_instructions=None, had_primary_source=None, issue_tracker=None, date_created=None, contributor=None, compatible_visualization_software=None, copyright_holder=None, has_faq=None, logo=None, has_contact_person=None, has_purpose=None, id=None, has_executable_instructions=None, has_sample_visualization=None, identifier=None, memory_requirements=None, website=None, citation=None, author=None, processor_requirements=None, has_usage_notes=None, readme=None, has_build_file=None, short_description=None, label=None, has_assumption=None, date_published=None, operating_systems=None, license=None, has_source_code=None, has_executable_notebook=None, has_example=None, publisher=None, useful_for_calculating_index=None, doi=None): # noqa: E501 + def __init__(self, has_download_instructions=None, has_funding=None, keywords=None, has_documentation=None, support_details=None, software_requirements=None, has_version=None, has_typical_data_source=None, has_download_url=None, description=None, reference_publication=None, screenshot=None, type=None, has_installation_instructions=None, had_primary_source=None, issue_tracker=None, date_created=None, compatible_visualization_software=None, contributor=None, copyright_holder=None, has_faq=None, logo=None, has_contact_person=None, has_purpose=None, id=None, has_executable_instructions=None, has_sample_visualization=None, identifier=None, memory_requirements=None, website=None, citation=None, author=None, processor_requirements=None, has_usage_notes=None, readme=None, has_build_file=None, short_description=None, label=None, has_assumption=None, date_published=None, operating_systems=None, license=None, has_source_code=None, has_executable_notebook=None, has_example=None, publisher=None, useful_for_calculating_index=None, doi=None): # noqa: E501 """Software - a model defined in OpenAPI""" # noqa: E501 self._has_download_instructions = None @@ -152,8 +152,8 @@ def __init__(self, has_download_instructions=None, has_funding=None, keywords=No self._had_primary_source = None self._issue_tracker = None self._date_created = None - self._contributor = None self._compatible_visualization_software = None + self._contributor = None self._copyright_holder = None self._has_faq = None self._logo = None @@ -202,8 +202,8 @@ def __init__(self, has_download_instructions=None, has_funding=None, keywords=No self.had_primary_source = had_primary_source self.issue_tracker = issue_tracker self.date_created = date_created - self.contributor = contributor self.compatible_visualization_software = compatible_visualization_software + self.contributor = contributor self.copyright_holder = copyright_holder self.has_faq = has_faq self.logo = logo @@ -354,7 +354,7 @@ def support_details(self, support_details): def software_requirements(self): """Gets the software_requirements of this Software. # noqa: E501 - Description not available # noqa: E501 + Software requirements needed to install a software component # noqa: E501 :return: The software_requirements of this Software. # noqa: E501 :rtype: list[str] @@ -365,7 +365,7 @@ def software_requirements(self): def software_requirements(self, software_requirements): """Sets the software_requirements of this Software. - Description not available # noqa: E501 + Software requirements needed to install a software component # noqa: E501 :param software_requirements: The software_requirements of this Software. # noqa: E501 :type: list[str] @@ -377,7 +377,7 @@ def software_requirements(self, software_requirements): def has_version(self): """Gets the has_version of this Software. # noqa: E501 - Description not available # noqa: E501 + Property designed to link a software component with its corresponding versions # noqa: E501 :return: The has_version of this Software. # noqa: E501 :rtype: list[SoftwareVersion] @@ -388,7 +388,7 @@ def has_version(self): def has_version(self, has_version): """Sets the has_version of this Software. - Description not available # noqa: E501 + Property designed to link a software component with its corresponding versions # noqa: E501 :param has_version: The has_version of this Software. # noqa: E501 :type: list[SoftwareVersion] @@ -400,7 +400,7 @@ def has_version(self, has_version): def has_typical_data_source(self): """Gets the has_typical_data_source of this Software. # noqa: E501 - Description not available # noqa: E501 + Typical data sources that are used by a software component # noqa: E501 :return: The has_typical_data_source of this Software. # noqa: E501 :rtype: list[str] @@ -411,7 +411,7 @@ def has_typical_data_source(self): def has_typical_data_source(self, has_typical_data_source): """Sets the has_typical_data_source of this Software. - Description not available # noqa: E501 + Typical data sources that are used by a software component # noqa: E501 :param has_typical_data_source: The has_typical_data_source of this Software. # noqa: E501 :type: list[str] @@ -492,7 +492,7 @@ def reference_publication(self, reference_publication): def screenshot(self): """Gets the screenshot of this Software. # noqa: E501 - Description not available # noqa: E501 + Image illustrating a snapshot of the target software # noqa: E501 :return: The screenshot of this Software. # noqa: E501 :rtype: list[Image] @@ -503,7 +503,7 @@ def screenshot(self): def screenshot(self, screenshot): """Sets the screenshot of this Software. - Description not available # noqa: E501 + Image illustrating a snapshot of the target software # noqa: E501 :param screenshot: The screenshot of this Software. # noqa: E501 :type: list[Image] @@ -561,7 +561,7 @@ def has_installation_instructions(self, has_installation_instructions): def had_primary_source(self): """Gets the had_primary_source of this Software. # noqa: E501 - had primary source # noqa: E501 + Property to identify the original source of the information of the annotated resource. It could be a web page, an organization, a person, some experiment notes, etc. # noqa: E501 :return: The had_primary_source of this Software. # noqa: E501 :rtype: list[object] @@ -572,7 +572,7 @@ def had_primary_source(self): def had_primary_source(self, had_primary_source): """Sets the had_primary_source of this Software. - had primary source # noqa: E501 + Property to identify the original source of the information of the annotated resource. It could be a web page, an organization, a person, some experiment notes, etc. # noqa: E501 :param had_primary_source: The had_primary_source of this Software. # noqa: E501 :type: list[object] @@ -607,7 +607,7 @@ def issue_tracker(self, issue_tracker): def date_created(self): """Gets the date_created of this Software. # noqa: E501 - Description not available # noqa: E501 + Date when a software component was created # noqa: E501 :return: The date_created of this Software. # noqa: E501 :rtype: list[datetime] @@ -618,7 +618,7 @@ def date_created(self): def date_created(self, date_created): """Sets the date_created of this Software. - Description not available # noqa: E501 + Date when a software component was created # noqa: E501 :param date_created: The date_created of this Software. # noqa: E501 :type: list[datetime] @@ -626,29 +626,6 @@ def date_created(self, date_created): self._date_created = date_created - @property - def contributor(self): - """Gets the contributor of this Software. # noqa: E501 - - Description not available # noqa: E501 - - :return: The contributor of this Software. # noqa: E501 - :rtype: list[Person] - """ - return self._contributor - - @contributor.setter - def contributor(self, contributor): - """Sets the contributor of this Software. - - Description not available # noqa: E501 - - :param contributor: The contributor of this Software. # noqa: E501 - :type: list[Person] - """ - - self._contributor = contributor - @property def compatible_visualization_software(self): """Gets the compatible_visualization_software of this Software. # noqa: E501 @@ -672,11 +649,34 @@ def compatible_visualization_software(self, compatible_visualization_software): self._compatible_visualization_software = compatible_visualization_software + @property + def contributor(self): + """Gets the contributor of this Software. # noqa: E501 + + Contributor to a software component # noqa: E501 + + :return: The contributor of this Software. # noqa: E501 + :rtype: list[Person] + """ + return self._contributor + + @contributor.setter + def contributor(self, contributor): + """Sets the contributor of this Software. + + Contributor to a software component # noqa: E501 + + :param contributor: The contributor of this Software. # noqa: E501 + :type: list[Person] + """ + + self._contributor = contributor + @property def copyright_holder(self): """Gets the copyright_holder of this Software. # noqa: E501 - Description not available # noqa: E501 + Copyright holder for a software component # noqa: E501 :return: The copyright_holder of this Software. # noqa: E501 :rtype: list[object] @@ -687,7 +687,7 @@ def copyright_holder(self): def copyright_holder(self, copyright_holder): """Sets the copyright_holder of this Software. - Description not available # noqa: E501 + Copyright holder for a software component # noqa: E501 :param copyright_holder: The copyright_holder of this Software. # noqa: E501 :type: list[object] @@ -722,7 +722,7 @@ def has_faq(self, has_faq): def logo(self): """Gets the logo of this Software. # noqa: E501 - Description not available # noqa: E501 + Property that links to the image used as logo for a software component # noqa: E501 :return: The logo of this Software. # noqa: E501 :rtype: list[Image] @@ -733,7 +733,7 @@ def logo(self): def logo(self, logo): """Sets the logo of this Software. - Description not available # noqa: E501 + Property that links to the image used as logo for a software component # noqa: E501 :param logo: The logo of this Software. # noqa: E501 :type: list[Image] @@ -745,7 +745,7 @@ def logo(self, logo): def has_contact_person(self): """Gets the has_contact_person of this Software. # noqa: E501 - Description not available # noqa: E501 + Contact person responsible for a software component # noqa: E501 :return: The has_contact_person of this Software. # noqa: E501 :rtype: list[object] @@ -756,7 +756,7 @@ def has_contact_person(self): def has_contact_person(self, has_contact_person): """Sets the has_contact_person of this Software. - Description not available # noqa: E501 + Contact person responsible for a software component # noqa: E501 :param has_contact_person: The has_contact_person of this Software. # noqa: E501 :type: list[object] @@ -883,7 +883,7 @@ def identifier(self, identifier): def memory_requirements(self): """Gets the memory_requirements of this Software. # noqa: E501 - Description not available # noqa: E501 + Memory requirements of a software # noqa: E501 :return: The memory_requirements of this Software. # noqa: E501 :rtype: list[str] @@ -894,7 +894,7 @@ def memory_requirements(self): def memory_requirements(self, memory_requirements): """Sets the memory_requirements of this Software. - Description not available # noqa: E501 + Memory requirements of a software # noqa: E501 :param memory_requirements: The memory_requirements of this Software. # noqa: E501 :type: list[str] @@ -952,7 +952,7 @@ def citation(self, citation): def author(self): """Gets the author of this Software. # noqa: E501 - Description not available # noqa: E501 + The creator of a software component # noqa: E501 :return: The author of this Software. # noqa: E501 :rtype: list[object] @@ -963,7 +963,7 @@ def author(self): def author(self, author): """Sets the author of this Software. - Description not available # noqa: E501 + The creator of a software component # noqa: E501 :param author: The author of this Software. # noqa: E501 :type: list[object] @@ -975,7 +975,7 @@ def author(self, author): def processor_requirements(self): """Gets the processor_requirements of this Software. # noqa: E501 - Description not available # noqa: E501 + Processor requirements of a software component # noqa: E501 :return: The processor_requirements of this Software. # noqa: E501 :rtype: list[str] @@ -986,7 +986,7 @@ def processor_requirements(self): def processor_requirements(self, processor_requirements): """Sets the processor_requirements of this Software. - Description not available # noqa: E501 + Processor requirements of a software component # noqa: E501 :param processor_requirements: The processor_requirements of this Software. # noqa: E501 :type: list[str] @@ -1136,7 +1136,7 @@ def has_assumption(self, has_assumption): def date_published(self): """Gets the date_published of this Software. # noqa: E501 - Description not available # noqa: E501 + Date when a software component was published # noqa: E501 :return: The date_published of this Software. # noqa: E501 :rtype: list[datetime] @@ -1147,7 +1147,7 @@ def date_published(self): def date_published(self, date_published): """Sets the date_published of this Software. - Description not available # noqa: E501 + Date when a software component was published # noqa: E501 :param date_published: The date_published of this Software. # noqa: E501 :type: list[datetime] @@ -1159,7 +1159,7 @@ def date_published(self, date_published): def operating_systems(self): """Gets the operating_systems of this Software. # noqa: E501 - Description not available # noqa: E501 + Operating systems under which a software component can operate # noqa: E501 :return: The operating_systems of this Software. # noqa: E501 :rtype: list[str] @@ -1170,7 +1170,7 @@ def operating_systems(self): def operating_systems(self, operating_systems): """Sets the operating_systems of this Software. - Description not available # noqa: E501 + Operating systems under which a software component can operate # noqa: E501 :param operating_systems: The operating_systems of this Software. # noqa: E501 :type: list[str] @@ -1205,7 +1205,7 @@ def license(self, license): def has_source_code(self): """Gets the has_source_code of this Software. # noqa: E501 - Description not available # noqa: E501 + Property designed to link a software with its software source code (which may reside in a code repository such as GitHub) # noqa: E501 :return: The has_source_code of this Software. # noqa: E501 :rtype: list[SourceCode] @@ -1216,7 +1216,7 @@ def has_source_code(self): def has_source_code(self, has_source_code): """Sets the has_source_code of this Software. - Description not available # noqa: E501 + Property designed to link a software with its software source code (which may reside in a code repository such as GitHub) # noqa: E501 :param has_source_code: The has_source_code of this Software. # noqa: E501 :type: list[SourceCode] @@ -1274,7 +1274,7 @@ def has_example(self, has_example): def publisher(self): """Gets the publisher of this Software. # noqa: E501 - Description not available # noqa: E501 + Publisher organization or person responsible for a software component # noqa: E501 :return: The publisher of this Software. # noqa: E501 :rtype: list[object] @@ -1285,7 +1285,7 @@ def publisher(self): def publisher(self, publisher): """Sets the publisher of this Software. - Description not available # noqa: E501 + Publisher organization or person responsible for a software component # noqa: E501 :param publisher: The publisher of this Software. # noqa: E501 :type: list[object] diff --git a/modelcatalog/models/software_configuration.py b/modelcatalog/models/software_configuration.py index 2fd16cc..6838d88 100644 --- a/modelcatalog/models/software_configuration.py +++ b/modelcatalog/models/software_configuration.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ @@ -383,7 +383,7 @@ def has_implementation_script_location(self, has_implementation_script_location) def software_requirements(self): """Gets the software_requirements of this SoftwareConfiguration. # noqa: E501 - Description not available # noqa: E501 + Software requirements needed to install a software component # noqa: E501 :return: The software_requirements of this SoftwareConfiguration. # noqa: E501 :rtype: list[str] @@ -394,7 +394,7 @@ def software_requirements(self): def software_requirements(self, software_requirements): """Sets the software_requirements of this SoftwareConfiguration. - Description not available # noqa: E501 + Software requirements needed to install a software component # noqa: E501 :param software_requirements: The software_requirements of this SoftwareConfiguration. # noqa: E501 :type: list[str] @@ -498,7 +498,7 @@ def compatible_visualization_software(self, compatible_visualization_software): def copyright_holder(self): """Gets the copyright_holder of this SoftwareConfiguration. # noqa: E501 - Description not available # noqa: E501 + Copyright holder for a software component # noqa: E501 :return: The copyright_holder of this SoftwareConfiguration. # noqa: E501 :rtype: list[object] @@ -509,7 +509,7 @@ def copyright_holder(self): def copyright_holder(self, copyright_holder): """Sets the copyright_holder of this SoftwareConfiguration. - Description not available # noqa: E501 + Copyright holder for a software component # noqa: E501 :param copyright_holder: The copyright_holder of this SoftwareConfiguration. # noqa: E501 :type: list[object] @@ -544,7 +544,7 @@ def has_faq(self, has_faq): def logo(self): """Gets the logo of this SoftwareConfiguration. # noqa: E501 - Description not available # noqa: E501 + Property that links to the image used as logo for a software component # noqa: E501 :return: The logo of this SoftwareConfiguration. # noqa: E501 :rtype: list[Image] @@ -555,7 +555,7 @@ def logo(self): def logo(self, logo): """Sets the logo of this SoftwareConfiguration. - Description not available # noqa: E501 + Property that links to the image used as logo for a software component # noqa: E501 :param logo: The logo of this SoftwareConfiguration. # noqa: E501 :type: list[Image] @@ -567,7 +567,7 @@ def logo(self, logo): def has_contact_person(self): """Gets the has_contact_person of this SoftwareConfiguration. # noqa: E501 - Description not available # noqa: E501 + Contact person responsible for a software component # noqa: E501 :return: The has_contact_person of this SoftwareConfiguration. # noqa: E501 :rtype: list[object] @@ -578,7 +578,7 @@ def has_contact_person(self): def has_contact_person(self, has_contact_person): """Sets the has_contact_person of this SoftwareConfiguration. - Description not available # noqa: E501 + Contact person responsible for a software component # noqa: E501 :param has_contact_person: The has_contact_person of this SoftwareConfiguration. # noqa: E501 :type: list[object] @@ -659,7 +659,7 @@ def identifier(self, identifier): def has_sample_execution(self): """Gets the has_sample_execution of this SoftwareConfiguration. # noqa: E501 - Description not available # noqa: E501 + Property pointing to a sample execution of a software configuration # noqa: E501 :return: The has_sample_execution of this SoftwareConfiguration. # noqa: E501 :rtype: list[SampleExecution] @@ -670,7 +670,7 @@ def has_sample_execution(self): def has_sample_execution(self, has_sample_execution): """Sets the has_sample_execution of this SoftwareConfiguration. - Description not available # noqa: E501 + Property pointing to a sample execution of a software configuration # noqa: E501 :param has_sample_execution: The has_sample_execution of this SoftwareConfiguration. # noqa: E501 :type: list[SampleExecution] @@ -682,7 +682,7 @@ def has_sample_execution(self, has_sample_execution): def has_sample_result(self): """Gets the has_sample_result of this SoftwareConfiguration. # noqa: E501 - Description not available # noqa: E501 + Property designed to link a software configuration to a sample resource resulting from its execution # noqa: E501 :return: The has_sample_result of this SoftwareConfiguration. # noqa: E501 :rtype: list[SampleResource] @@ -693,7 +693,7 @@ def has_sample_result(self): def has_sample_result(self, has_sample_result): """Sets the has_sample_result of this SoftwareConfiguration. - Description not available # noqa: E501 + Property designed to link a software configuration to a sample resource resulting from its execution # noqa: E501 :param has_sample_result: The has_sample_result of this SoftwareConfiguration. # noqa: E501 :type: list[SampleResource] @@ -705,7 +705,7 @@ def has_sample_result(self, has_sample_result): def author(self): """Gets the author of this SoftwareConfiguration. # noqa: E501 - Description not available # noqa: E501 + The creator of a software component # noqa: E501 :return: The author of this SoftwareConfiguration. # noqa: E501 :rtype: list[object] @@ -716,7 +716,7 @@ def author(self): def author(self, author): """Sets the author of this SoftwareConfiguration. - Description not available # noqa: E501 + The creator of a software component # noqa: E501 :param author: The author of this SoftwareConfiguration. # noqa: E501 :type: list[object] @@ -820,7 +820,7 @@ def has_execution_command(self, has_execution_command): def date_published(self): """Gets the date_published of this SoftwareConfiguration. # noqa: E501 - Description not available # noqa: E501 + Date when a software component was published # noqa: E501 :return: The date_published of this SoftwareConfiguration. # noqa: E501 :rtype: list[datetime] @@ -831,7 +831,7 @@ def date_published(self): def date_published(self, date_published): """Sets the date_published of this SoftwareConfiguration. - Description not available # noqa: E501 + Date when a software component was published # noqa: E501 :param date_published: The date_published of this SoftwareConfiguration. # noqa: E501 :type: list[datetime] @@ -866,7 +866,7 @@ def license(self, license): def has_source_code(self): """Gets the has_source_code of this SoftwareConfiguration. # noqa: E501 - Description not available # noqa: E501 + Property designed to link a software with its software source code (which may reside in a code repository such as GitHub) # noqa: E501 :return: The has_source_code of this SoftwareConfiguration. # noqa: E501 :rtype: list[SourceCode] @@ -877,7 +877,7 @@ def has_source_code(self): def has_source_code(self, has_source_code): """Sets the has_source_code of this SoftwareConfiguration. - Description not available # noqa: E501 + Property designed to link a software with its software source code (which may reside in a code repository such as GitHub) # noqa: E501 :param has_source_code: The has_source_code of this SoftwareConfiguration. # noqa: E501 :type: list[SourceCode] @@ -935,7 +935,7 @@ def has_example(self, has_example): def publisher(self): """Gets the publisher of this SoftwareConfiguration. # noqa: E501 - Description not available # noqa: E501 + Publisher organization or person responsible for a software component # noqa: E501 :return: The publisher of this SoftwareConfiguration. # noqa: E501 :rtype: list[object] @@ -946,7 +946,7 @@ def publisher(self): def publisher(self, publisher): """Sets the publisher of this SoftwareConfiguration. - Description not available # noqa: E501 + Publisher organization or person responsible for a software component # noqa: E501 :param publisher: The publisher of this SoftwareConfiguration. # noqa: E501 :type: list[object] @@ -1073,7 +1073,7 @@ def support_details(self, support_details): def has_version(self): """Gets the has_version of this SoftwareConfiguration. # noqa: E501 - Description not available # noqa: E501 + Property designed to link a software component with its corresponding versions # noqa: E501 :return: The has_version of this SoftwareConfiguration. # noqa: E501 :rtype: list[SoftwareVersion] @@ -1084,7 +1084,7 @@ def has_version(self): def has_version(self, has_version): """Sets the has_version of this SoftwareConfiguration. - Description not available # noqa: E501 + Property designed to link a software component with its corresponding versions # noqa: E501 :param has_version: The has_version of this SoftwareConfiguration. # noqa: E501 :type: list[SoftwareVersion] @@ -1096,7 +1096,7 @@ def has_version(self, has_version): def has_typical_data_source(self): """Gets the has_typical_data_source of this SoftwareConfiguration. # noqa: E501 - Description not available # noqa: E501 + Typical data sources that are used by a software component # noqa: E501 :return: The has_typical_data_source of this SoftwareConfiguration. # noqa: E501 :rtype: list[str] @@ -1107,7 +1107,7 @@ def has_typical_data_source(self): def has_typical_data_source(self, has_typical_data_source): """Sets the has_typical_data_source of this SoftwareConfiguration. - Description not available # noqa: E501 + Typical data sources that are used by a software component # noqa: E501 :param has_typical_data_source: The has_typical_data_source of this SoftwareConfiguration. # noqa: E501 :type: list[str] @@ -1165,7 +1165,7 @@ def reference_publication(self, reference_publication): def screenshot(self): """Gets the screenshot of this SoftwareConfiguration. # noqa: E501 - Description not available # noqa: E501 + Image illustrating a snapshot of the target software # noqa: E501 :return: The screenshot of this SoftwareConfiguration. # noqa: E501 :rtype: list[Image] @@ -1176,7 +1176,7 @@ def screenshot(self): def screenshot(self, screenshot): """Sets the screenshot of this SoftwareConfiguration. - Description not available # noqa: E501 + Image illustrating a snapshot of the target software # noqa: E501 :param screenshot: The screenshot of this SoftwareConfiguration. # noqa: E501 :type: list[Image] @@ -1188,7 +1188,7 @@ def screenshot(self, screenshot): def had_primary_source(self): """Gets the had_primary_source of this SoftwareConfiguration. # noqa: E501 - had primary source # noqa: E501 + Property to identify the original source of the information of the annotated resource. It could be a web page, an organization, a person, some experiment notes, etc. # noqa: E501 :return: The had_primary_source of this SoftwareConfiguration. # noqa: E501 :rtype: list[object] @@ -1199,7 +1199,7 @@ def had_primary_source(self): def had_primary_source(self, had_primary_source): """Sets the had_primary_source of this SoftwareConfiguration. - had primary source # noqa: E501 + Property to identify the original source of the information of the annotated resource. It could be a web page, an organization, a person, some experiment notes, etc. # noqa: E501 :param had_primary_source: The had_primary_source of this SoftwareConfiguration. # noqa: E501 :type: list[object] @@ -1257,7 +1257,7 @@ def has_software_image(self, has_software_image): def date_created(self): """Gets the date_created of this SoftwareConfiguration. # noqa: E501 - Description not available # noqa: E501 + Date when a software component was created # noqa: E501 :return: The date_created of this SoftwareConfiguration. # noqa: E501 :rtype: list[datetime] @@ -1268,7 +1268,7 @@ def date_created(self): def date_created(self, date_created): """Sets the date_created of this SoftwareConfiguration. - Description not available # noqa: E501 + Date when a software component was created # noqa: E501 :param date_created: The date_created of this SoftwareConfiguration. # noqa: E501 :type: list[datetime] @@ -1280,7 +1280,7 @@ def date_created(self, date_created): def contributor(self): """Gets the contributor of this SoftwareConfiguration. # noqa: E501 - Description not available # noqa: E501 + Contributor to a software component # noqa: E501 :return: The contributor of this SoftwareConfiguration. # noqa: E501 :rtype: list[Person] @@ -1291,7 +1291,7 @@ def contributor(self): def contributor(self, contributor): """Sets the contributor of this SoftwareConfiguration. - Description not available # noqa: E501 + Contributor to a software component # noqa: E501 :param contributor: The contributor of this SoftwareConfiguration. # noqa: E501 :type: list[Person] @@ -1372,7 +1372,7 @@ def has_sample_visualization(self, has_sample_visualization): def memory_requirements(self): """Gets the memory_requirements of this SoftwareConfiguration. # noqa: E501 - Description not available # noqa: E501 + Memory requirements of a software # noqa: E501 :return: The memory_requirements of this SoftwareConfiguration. # noqa: E501 :rtype: list[str] @@ -1383,7 +1383,7 @@ def memory_requirements(self): def memory_requirements(self, memory_requirements): """Sets the memory_requirements of this SoftwareConfiguration. - Description not available # noqa: E501 + Memory requirements of a software # noqa: E501 :param memory_requirements: The memory_requirements of this SoftwareConfiguration. # noqa: E501 :type: list[str] @@ -1441,7 +1441,7 @@ def citation(self, citation): def processor_requirements(self): """Gets the processor_requirements of this SoftwareConfiguration. # noqa: E501 - Description not available # noqa: E501 + Processor requirements of a software component # noqa: E501 :return: The processor_requirements of this SoftwareConfiguration. # noqa: E501 :rtype: list[str] @@ -1452,7 +1452,7 @@ def processor_requirements(self): def processor_requirements(self, processor_requirements): """Sets the processor_requirements of this SoftwareConfiguration. - Description not available # noqa: E501 + Processor requirements of a software component # noqa: E501 :param processor_requirements: The processor_requirements of this SoftwareConfiguration. # noqa: E501 :type: list[str] @@ -1602,7 +1602,7 @@ def has_parameter(self, has_parameter): def operating_systems(self): """Gets the operating_systems of this SoftwareConfiguration. # noqa: E501 - Description not available # noqa: E501 + Operating systems under which a software component can operate # noqa: E501 :return: The operating_systems of this SoftwareConfiguration. # noqa: E501 :rtype: list[str] @@ -1613,7 +1613,7 @@ def operating_systems(self): def operating_systems(self, operating_systems): """Sets the operating_systems of this SoftwareConfiguration. - Description not available # noqa: E501 + Operating systems under which a software component can operate # noqa: E501 :param operating_systems: The operating_systems of this SoftwareConfiguration. # noqa: E501 :type: list[str] diff --git a/modelcatalog/models/software_image.py b/modelcatalog/models/software_image.py index 744ea05..3ac6993 100644 --- a/modelcatalog/models/software_image.py +++ b/modelcatalog/models/software_image.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ @@ -312,7 +312,7 @@ def has_documentation(self, has_documentation): def software_requirements(self): """Gets the software_requirements of this SoftwareImage. # noqa: E501 - Description not available # noqa: E501 + Software requirements needed to install a software component # noqa: E501 :return: The software_requirements of this SoftwareImage. # noqa: E501 :rtype: list[str] @@ -323,7 +323,7 @@ def software_requirements(self): def software_requirements(self, software_requirements): """Sets the software_requirements of this SoftwareImage. - Description not available # noqa: E501 + Software requirements needed to install a software component # noqa: E501 :param software_requirements: The software_requirements of this SoftwareImage. # noqa: E501 :type: list[str] @@ -427,7 +427,7 @@ def compatible_visualization_software(self, compatible_visualization_software): def copyright_holder(self): """Gets the copyright_holder of this SoftwareImage. # noqa: E501 - Description not available # noqa: E501 + Copyright holder for a software component # noqa: E501 :return: The copyright_holder of this SoftwareImage. # noqa: E501 :rtype: list[object] @@ -438,7 +438,7 @@ def copyright_holder(self): def copyright_holder(self, copyright_holder): """Sets the copyright_holder of this SoftwareImage. - Description not available # noqa: E501 + Copyright holder for a software component # noqa: E501 :param copyright_holder: The copyright_holder of this SoftwareImage. # noqa: E501 :type: list[object] @@ -473,7 +473,7 @@ def has_faq(self, has_faq): def logo(self): """Gets the logo of this SoftwareImage. # noqa: E501 - Description not available # noqa: E501 + Property that links to the image used as logo for a software component # noqa: E501 :return: The logo of this SoftwareImage. # noqa: E501 :rtype: list[Image] @@ -484,7 +484,7 @@ def logo(self): def logo(self, logo): """Sets the logo of this SoftwareImage. - Description not available # noqa: E501 + Property that links to the image used as logo for a software component # noqa: E501 :param logo: The logo of this SoftwareImage. # noqa: E501 :type: list[Image] @@ -496,7 +496,7 @@ def logo(self, logo): def has_contact_person(self): """Gets the has_contact_person of this SoftwareImage. # noqa: E501 - Description not available # noqa: E501 + Contact person responsible for a software component # noqa: E501 :return: The has_contact_person of this SoftwareImage. # noqa: E501 :rtype: list[object] @@ -507,7 +507,7 @@ def has_contact_person(self): def has_contact_person(self, has_contact_person): """Sets the has_contact_person of this SoftwareImage. - Description not available # noqa: E501 + Contact person responsible for a software component # noqa: E501 :param has_contact_person: The has_contact_person of this SoftwareImage. # noqa: E501 :type: list[object] @@ -565,7 +565,7 @@ def identifier(self, identifier): def author(self): """Gets the author of this SoftwareImage. # noqa: E501 - Description not available # noqa: E501 + The creator of a software component # noqa: E501 :return: The author of this SoftwareImage. # noqa: E501 :rtype: list[object] @@ -576,7 +576,7 @@ def author(self): def author(self, author): """Sets the author of this SoftwareImage. - Description not available # noqa: E501 + The creator of a software component # noqa: E501 :param author: The author of this SoftwareImage. # noqa: E501 :type: list[object] @@ -657,7 +657,7 @@ def has_execution_command(self, has_execution_command): def date_published(self): """Gets the date_published of this SoftwareImage. # noqa: E501 - Description not available # noqa: E501 + Date when a software component was published # noqa: E501 :return: The date_published of this SoftwareImage. # noqa: E501 :rtype: list[datetime] @@ -668,7 +668,7 @@ def date_published(self): def date_published(self, date_published): """Sets the date_published of this SoftwareImage. - Description not available # noqa: E501 + Date when a software component was published # noqa: E501 :param date_published: The date_published of this SoftwareImage. # noqa: E501 :type: list[datetime] @@ -703,7 +703,7 @@ def license(self, license): def has_source_code(self): """Gets the has_source_code of this SoftwareImage. # noqa: E501 - Description not available # noqa: E501 + Property designed to link a software with its software source code (which may reside in a code repository such as GitHub) # noqa: E501 :return: The has_source_code of this SoftwareImage. # noqa: E501 :rtype: list[SourceCode] @@ -714,7 +714,7 @@ def has_source_code(self): def has_source_code(self, has_source_code): """Sets the has_source_code of this SoftwareImage. - Description not available # noqa: E501 + Property designed to link a software with its software source code (which may reside in a code repository such as GitHub) # noqa: E501 :param has_source_code: The has_source_code of this SoftwareImage. # noqa: E501 :type: list[SourceCode] @@ -749,7 +749,7 @@ def has_example(self, has_example): def publisher(self): """Gets the publisher of this SoftwareImage. # noqa: E501 - Description not available # noqa: E501 + Publisher organization or person responsible for a software component # noqa: E501 :return: The publisher of this SoftwareImage. # noqa: E501 :rtype: list[object] @@ -760,7 +760,7 @@ def publisher(self): def publisher(self, publisher): """Sets the publisher of this SoftwareImage. - Description not available # noqa: E501 + Publisher organization or person responsible for a software component # noqa: E501 :param publisher: The publisher of this SoftwareImage. # noqa: E501 :type: list[object] @@ -841,7 +841,7 @@ def support_details(self, support_details): def has_version(self): """Gets the has_version of this SoftwareImage. # noqa: E501 - Description not available # noqa: E501 + Property designed to link a software component with its corresponding versions # noqa: E501 :return: The has_version of this SoftwareImage. # noqa: E501 :rtype: list[SoftwareVersion] @@ -852,7 +852,7 @@ def has_version(self): def has_version(self, has_version): """Sets the has_version of this SoftwareImage. - Description not available # noqa: E501 + Property designed to link a software component with its corresponding versions # noqa: E501 :param has_version: The has_version of this SoftwareImage. # noqa: E501 :type: list[SoftwareVersion] @@ -864,7 +864,7 @@ def has_version(self, has_version): def has_typical_data_source(self): """Gets the has_typical_data_source of this SoftwareImage. # noqa: E501 - Description not available # noqa: E501 + Typical data sources that are used by a software component # noqa: E501 :return: The has_typical_data_source of this SoftwareImage. # noqa: E501 :rtype: list[str] @@ -875,7 +875,7 @@ def has_typical_data_source(self): def has_typical_data_source(self, has_typical_data_source): """Sets the has_typical_data_source of this SoftwareImage. - Description not available # noqa: E501 + Typical data sources that are used by a software component # noqa: E501 :param has_typical_data_source: The has_typical_data_source of this SoftwareImage. # noqa: E501 :type: list[str] @@ -933,7 +933,7 @@ def reference_publication(self, reference_publication): def screenshot(self): """Gets the screenshot of this SoftwareImage. # noqa: E501 - Description not available # noqa: E501 + Image illustrating a snapshot of the target software # noqa: E501 :return: The screenshot of this SoftwareImage. # noqa: E501 :rtype: list[Image] @@ -944,7 +944,7 @@ def screenshot(self): def screenshot(self, screenshot): """Sets the screenshot of this SoftwareImage. - Description not available # noqa: E501 + Image illustrating a snapshot of the target software # noqa: E501 :param screenshot: The screenshot of this SoftwareImage. # noqa: E501 :type: list[Image] @@ -956,7 +956,7 @@ def screenshot(self, screenshot): def had_primary_source(self): """Gets the had_primary_source of this SoftwareImage. # noqa: E501 - had primary source # noqa: E501 + Property to identify the original source of the information of the annotated resource. It could be a web page, an organization, a person, some experiment notes, etc. # noqa: E501 :return: The had_primary_source of this SoftwareImage. # noqa: E501 :rtype: list[object] @@ -967,7 +967,7 @@ def had_primary_source(self): def had_primary_source(self, had_primary_source): """Sets the had_primary_source of this SoftwareImage. - had primary source # noqa: E501 + Property to identify the original source of the information of the annotated resource. It could be a web page, an organization, a person, some experiment notes, etc. # noqa: E501 :param had_primary_source: The had_primary_source of this SoftwareImage. # noqa: E501 :type: list[object] @@ -1002,7 +1002,7 @@ def issue_tracker(self, issue_tracker): def date_created(self): """Gets the date_created of this SoftwareImage. # noqa: E501 - Description not available # noqa: E501 + Date when a software component was created # noqa: E501 :return: The date_created of this SoftwareImage. # noqa: E501 :rtype: list[datetime] @@ -1013,7 +1013,7 @@ def date_created(self): def date_created(self, date_created): """Sets the date_created of this SoftwareImage. - Description not available # noqa: E501 + Date when a software component was created # noqa: E501 :param date_created: The date_created of this SoftwareImage. # noqa: E501 :type: list[datetime] @@ -1025,7 +1025,7 @@ def date_created(self, date_created): def contributor(self): """Gets the contributor of this SoftwareImage. # noqa: E501 - Description not available # noqa: E501 + Contributor to a software component # noqa: E501 :return: The contributor of this SoftwareImage. # noqa: E501 :rtype: list[Person] @@ -1036,7 +1036,7 @@ def contributor(self): def contributor(self, contributor): """Sets the contributor of this SoftwareImage. - Description not available # noqa: E501 + Contributor to a software component # noqa: E501 :param contributor: The contributor of this SoftwareImage. # noqa: E501 :type: list[Person] @@ -1117,7 +1117,7 @@ def has_sample_visualization(self, has_sample_visualization): def memory_requirements(self): """Gets the memory_requirements of this SoftwareImage. # noqa: E501 - Description not available # noqa: E501 + Memory requirements of a software # noqa: E501 :return: The memory_requirements of this SoftwareImage. # noqa: E501 :rtype: list[str] @@ -1128,7 +1128,7 @@ def memory_requirements(self): def memory_requirements(self, memory_requirements): """Sets the memory_requirements of this SoftwareImage. - Description not available # noqa: E501 + Memory requirements of a software # noqa: E501 :param memory_requirements: The memory_requirements of this SoftwareImage. # noqa: E501 :type: list[str] @@ -1186,7 +1186,7 @@ def citation(self, citation): def processor_requirements(self): """Gets the processor_requirements of this SoftwareImage. # noqa: E501 - Description not available # noqa: E501 + Processor requirements of a software component # noqa: E501 :return: The processor_requirements of this SoftwareImage. # noqa: E501 :rtype: list[str] @@ -1197,7 +1197,7 @@ def processor_requirements(self): def processor_requirements(self, processor_requirements): """Sets the processor_requirements of this SoftwareImage. - Description not available # noqa: E501 + Processor requirements of a software component # noqa: E501 :param processor_requirements: The processor_requirements of this SoftwareImage. # noqa: E501 :type: list[str] @@ -1301,7 +1301,7 @@ def has_assumption(self, has_assumption): def operating_systems(self): """Gets the operating_systems of this SoftwareImage. # noqa: E501 - Description not available # noqa: E501 + Operating systems under which a software component can operate # noqa: E501 :return: The operating_systems of this SoftwareImage. # noqa: E501 :rtype: list[str] @@ -1312,7 +1312,7 @@ def operating_systems(self): def operating_systems(self, operating_systems): """Sets the operating_systems of this SoftwareImage. - Description not available # noqa: E501 + Operating systems under which a software component can operate # noqa: E501 :param operating_systems: The operating_systems of this SoftwareImage. # noqa: E501 :type: list[str] diff --git a/modelcatalog/models/software_version.py b/modelcatalog/models/software_version.py index ccb8d42..4289fbc 100644 --- a/modelcatalog/models/software_version.py +++ b/modelcatalog/models/software_version.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ @@ -320,7 +320,7 @@ def has_documentation(self, has_documentation): def software_requirements(self): """Gets the software_requirements of this SoftwareVersion. # noqa: E501 - Description not available # noqa: E501 + Software requirements needed to install a software component # noqa: E501 :return: The software_requirements of this SoftwareVersion. # noqa: E501 :rtype: list[str] @@ -331,7 +331,7 @@ def software_requirements(self): def software_requirements(self, software_requirements): """Sets the software_requirements of this SoftwareVersion. - Description not available # noqa: E501 + Software requirements needed to install a software component # noqa: E501 :param software_requirements: The software_requirements of this SoftwareVersion. # noqa: E501 :type: list[str] @@ -435,7 +435,7 @@ def compatible_visualization_software(self, compatible_visualization_software): def copyright_holder(self): """Gets the copyright_holder of this SoftwareVersion. # noqa: E501 - Description not available # noqa: E501 + Copyright holder for a software component # noqa: E501 :return: The copyright_holder of this SoftwareVersion. # noqa: E501 :rtype: list[object] @@ -446,7 +446,7 @@ def copyright_holder(self): def copyright_holder(self, copyright_holder): """Sets the copyright_holder of this SoftwareVersion. - Description not available # noqa: E501 + Copyright holder for a software component # noqa: E501 :param copyright_holder: The copyright_holder of this SoftwareVersion. # noqa: E501 :type: list[object] @@ -481,7 +481,7 @@ def has_faq(self, has_faq): def logo(self): """Gets the logo of this SoftwareVersion. # noqa: E501 - Description not available # noqa: E501 + Property that links to the image used as logo for a software component # noqa: E501 :return: The logo of this SoftwareVersion. # noqa: E501 :rtype: list[Image] @@ -492,7 +492,7 @@ def logo(self): def logo(self, logo): """Sets the logo of this SoftwareVersion. - Description not available # noqa: E501 + Property that links to the image used as logo for a software component # noqa: E501 :param logo: The logo of this SoftwareVersion. # noqa: E501 :type: list[Image] @@ -504,7 +504,7 @@ def logo(self, logo): def has_contact_person(self): """Gets the has_contact_person of this SoftwareVersion. # noqa: E501 - Description not available # noqa: E501 + Contact person responsible for a software component # noqa: E501 :return: The has_contact_person of this SoftwareVersion. # noqa: E501 :rtype: list[object] @@ -515,7 +515,7 @@ def has_contact_person(self): def has_contact_person(self, has_contact_person): """Sets the has_contact_person of this SoftwareVersion. - Description not available # noqa: E501 + Contact person responsible for a software component # noqa: E501 :param has_contact_person: The has_contact_person of this SoftwareVersion. # noqa: E501 :type: list[object] @@ -619,7 +619,7 @@ def has_configuration(self, has_configuration): def author(self): """Gets the author of this SoftwareVersion. # noqa: E501 - Description not available # noqa: E501 + The creator of a software component # noqa: E501 :return: The author of this SoftwareVersion. # noqa: E501 :rtype: list[object] @@ -630,7 +630,7 @@ def author(self): def author(self, author): """Sets the author of this SoftwareVersion. - Description not available # noqa: E501 + The creator of a software component # noqa: E501 :param author: The author of this SoftwareVersion. # noqa: E501 :type: list[object] @@ -688,7 +688,7 @@ def short_description(self, short_description): def date_published(self): """Gets the date_published of this SoftwareVersion. # noqa: E501 - Description not available # noqa: E501 + Date when a software component was published # noqa: E501 :return: The date_published of this SoftwareVersion. # noqa: E501 :rtype: list[datetime] @@ -699,7 +699,7 @@ def date_published(self): def date_published(self, date_published): """Sets the date_published of this SoftwareVersion. - Description not available # noqa: E501 + Date when a software component was published # noqa: E501 :param date_published: The date_published of this SoftwareVersion. # noqa: E501 :type: list[datetime] @@ -734,7 +734,7 @@ def license(self, license): def has_source_code(self): """Gets the has_source_code of this SoftwareVersion. # noqa: E501 - Description not available # noqa: E501 + Property designed to link a software with its software source code (which may reside in a code repository such as GitHub) # noqa: E501 :return: The has_source_code of this SoftwareVersion. # noqa: E501 :rtype: list[SourceCode] @@ -745,7 +745,7 @@ def has_source_code(self): def has_source_code(self, has_source_code): """Sets the has_source_code of this SoftwareVersion. - Description not available # noqa: E501 + Property designed to link a software with its software source code (which may reside in a code repository such as GitHub) # noqa: E501 :param has_source_code: The has_source_code of this SoftwareVersion. # noqa: E501 :type: list[SourceCode] @@ -780,7 +780,7 @@ def has_example(self, has_example): def publisher(self): """Gets the publisher of this SoftwareVersion. # noqa: E501 - Description not available # noqa: E501 + Publisher organization or person responsible for a software component # noqa: E501 :return: The publisher of this SoftwareVersion. # noqa: E501 :rtype: list[object] @@ -791,7 +791,7 @@ def publisher(self): def publisher(self, publisher): """Sets the publisher of this SoftwareVersion. - Description not available # noqa: E501 + Publisher organization or person responsible for a software component # noqa: E501 :param publisher: The publisher of this SoftwareVersion. # noqa: E501 :type: list[object] @@ -872,7 +872,7 @@ def support_details(self, support_details): def has_version(self): """Gets the has_version of this SoftwareVersion. # noqa: E501 - Description not available # noqa: E501 + Property designed to link a software component with its corresponding versions # noqa: E501 :return: The has_version of this SoftwareVersion. # noqa: E501 :rtype: list[SoftwareVersion] @@ -883,7 +883,7 @@ def has_version(self): def has_version(self, has_version): """Sets the has_version of this SoftwareVersion. - Description not available # noqa: E501 + Property designed to link a software component with its corresponding versions # noqa: E501 :param has_version: The has_version of this SoftwareVersion. # noqa: E501 :type: list[SoftwareVersion] @@ -895,7 +895,7 @@ def has_version(self, has_version): def has_typical_data_source(self): """Gets the has_typical_data_source of this SoftwareVersion. # noqa: E501 - Description not available # noqa: E501 + Typical data sources that are used by a software component # noqa: E501 :return: The has_typical_data_source of this SoftwareVersion. # noqa: E501 :rtype: list[str] @@ -906,7 +906,7 @@ def has_typical_data_source(self): def has_typical_data_source(self, has_typical_data_source): """Sets the has_typical_data_source of this SoftwareVersion. - Description not available # noqa: E501 + Typical data sources that are used by a software component # noqa: E501 :param has_typical_data_source: The has_typical_data_source of this SoftwareVersion. # noqa: E501 :type: list[str] @@ -964,7 +964,7 @@ def reference_publication(self, reference_publication): def screenshot(self): """Gets the screenshot of this SoftwareVersion. # noqa: E501 - Description not available # noqa: E501 + Image illustrating a snapshot of the target software # noqa: E501 :return: The screenshot of this SoftwareVersion. # noqa: E501 :rtype: list[Image] @@ -975,7 +975,7 @@ def screenshot(self): def screenshot(self, screenshot): """Sets the screenshot of this SoftwareVersion. - Description not available # noqa: E501 + Image illustrating a snapshot of the target software # noqa: E501 :param screenshot: The screenshot of this SoftwareVersion. # noqa: E501 :type: list[Image] @@ -987,7 +987,7 @@ def screenshot(self, screenshot): def had_primary_source(self): """Gets the had_primary_source of this SoftwareVersion. # noqa: E501 - had primary source # noqa: E501 + Property to identify the original source of the information of the annotated resource. It could be a web page, an organization, a person, some experiment notes, etc. # noqa: E501 :return: The had_primary_source of this SoftwareVersion. # noqa: E501 :rtype: list[object] @@ -998,7 +998,7 @@ def had_primary_source(self): def had_primary_source(self, had_primary_source): """Sets the had_primary_source of this SoftwareVersion. - had primary source # noqa: E501 + Property to identify the original source of the information of the annotated resource. It could be a web page, an organization, a person, some experiment notes, etc. # noqa: E501 :param had_primary_source: The had_primary_source of this SoftwareVersion. # noqa: E501 :type: list[object] @@ -1033,7 +1033,7 @@ def issue_tracker(self, issue_tracker): def date_created(self): """Gets the date_created of this SoftwareVersion. # noqa: E501 - Description not available # noqa: E501 + Date when a software component was created # noqa: E501 :return: The date_created of this SoftwareVersion. # noqa: E501 :rtype: list[datetime] @@ -1044,7 +1044,7 @@ def date_created(self): def date_created(self, date_created): """Sets the date_created of this SoftwareVersion. - Description not available # noqa: E501 + Date when a software component was created # noqa: E501 :param date_created: The date_created of this SoftwareVersion. # noqa: E501 :type: list[datetime] @@ -1056,7 +1056,7 @@ def date_created(self, date_created): def contributor(self): """Gets the contributor of this SoftwareVersion. # noqa: E501 - Description not available # noqa: E501 + Contributor to a software component # noqa: E501 :return: The contributor of this SoftwareVersion. # noqa: E501 :rtype: list[Person] @@ -1067,7 +1067,7 @@ def contributor(self): def contributor(self, contributor): """Sets the contributor of this SoftwareVersion. - Description not available # noqa: E501 + Contributor to a software component # noqa: E501 :param contributor: The contributor of this SoftwareVersion. # noqa: E501 :type: list[Person] @@ -1148,7 +1148,7 @@ def has_sample_visualization(self, has_sample_visualization): def memory_requirements(self): """Gets the memory_requirements of this SoftwareVersion. # noqa: E501 - Description not available # noqa: E501 + Memory requirements of a software # noqa: E501 :return: The memory_requirements of this SoftwareVersion. # noqa: E501 :rtype: list[str] @@ -1159,7 +1159,7 @@ def memory_requirements(self): def memory_requirements(self, memory_requirements): """Sets the memory_requirements of this SoftwareVersion. - Description not available # noqa: E501 + Memory requirements of a software # noqa: E501 :param memory_requirements: The memory_requirements of this SoftwareVersion. # noqa: E501 :type: list[str] @@ -1217,7 +1217,7 @@ def citation(self, citation): def processor_requirements(self): """Gets the processor_requirements of this SoftwareVersion. # noqa: E501 - Description not available # noqa: E501 + Processor requirements of a software component # noqa: E501 :return: The processor_requirements of this SoftwareVersion. # noqa: E501 :rtype: list[str] @@ -1228,7 +1228,7 @@ def processor_requirements(self): def processor_requirements(self, processor_requirements): """Sets the processor_requirements of this SoftwareVersion. - Description not available # noqa: E501 + Processor requirements of a software component # noqa: E501 :param processor_requirements: The processor_requirements of this SoftwareVersion. # noqa: E501 :type: list[str] @@ -1332,7 +1332,7 @@ def has_assumption(self, has_assumption): def operating_systems(self): """Gets the operating_systems of this SoftwareVersion. # noqa: E501 - Description not available # noqa: E501 + Operating systems under which a software component can operate # noqa: E501 :return: The operating_systems of this SoftwareVersion. # noqa: E501 :rtype: list[str] @@ -1343,7 +1343,7 @@ def operating_systems(self): def operating_systems(self, operating_systems): """Sets the operating_systems of this SoftwareVersion. - Description not available # noqa: E501 + Operating systems under which a software component can operate # noqa: E501 :param operating_systems: The operating_systems of this SoftwareVersion. # noqa: E501 :type: list[str] diff --git a/modelcatalog/models/source_code.py b/modelcatalog/models/source_code.py index 78f78da..4599cab 100644 --- a/modelcatalog/models/source_code.py +++ b/modelcatalog/models/source_code.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ @@ -98,7 +98,7 @@ def license(self, license): def programming_language(self): """Gets the programming_language of this SourceCode. # noqa: E501 - Description not available # noqa: E501 + Language used to code a software component # noqa: E501 :return: The programming_language of this SourceCode. # noqa: E501 :rtype: list[str] @@ -109,7 +109,7 @@ def programming_language(self): def programming_language(self, programming_language): """Sets the programming_language of this SourceCode. - Description not available # noqa: E501 + Language used to code a software component # noqa: E501 :param programming_language: The programming_language of this SourceCode. # noqa: E501 :type: list[str] diff --git a/modelcatalog/models/spatial_resolution.py b/modelcatalog/models/spatial_resolution.py index c246b11..5931304 100644 --- a/modelcatalog/models/spatial_resolution.py +++ b/modelcatalog/models/spatial_resolution.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/models/spatially_distributed_grid.py b/modelcatalog/models/spatially_distributed_grid.py index 5f50981..3b89050 100644 --- a/modelcatalog/models/spatially_distributed_grid.py +++ b/modelcatalog/models/spatially_distributed_grid.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ @@ -43,6 +43,7 @@ class SpatiallyDistributedGrid(object): 'has_fixed_resource': 'list[SampleResource]', 'has_coordinate_system': 'list[str]', 'has_spatial_resolution': 'list[str]', + 'is_transformed_from': 'list[DatasetSpecification]', 'has_shape': 'list[str]', 'has_dimension': 'list[str]', 'has_data_transformation_setup': 'list[DataTransformationSetup]', @@ -63,6 +64,7 @@ class SpatiallyDistributedGrid(object): 'has_fixed_resource': 'hasFixedResource', 'has_coordinate_system': 'hasCoordinateSystem', 'has_spatial_resolution': 'hasSpatialResolution', + 'is_transformed_from': 'isTransformedFrom', 'has_shape': 'hasShape', 'has_dimension': 'hasDimension', 'has_data_transformation_setup': 'hasDataTransformationSetup', @@ -70,7 +72,7 @@ class SpatiallyDistributedGrid(object): 'id': 'id' } - def __init__(self, has_dimensionality=None, has_format=None, path_location=None, has_file_structure=None, description=None, has_data_transformation=None, has_presentation=None, label=None, type=None, has_fixed_resource=None, has_coordinate_system=None, has_spatial_resolution=None, has_shape=None, has_dimension=None, has_data_transformation_setup=None, position=None, id=None): # noqa: E501 + def __init__(self, has_dimensionality=None, has_format=None, path_location=None, has_file_structure=None, description=None, has_data_transformation=None, has_presentation=None, label=None, type=None, has_fixed_resource=None, has_coordinate_system=None, has_spatial_resolution=None, is_transformed_from=None, has_shape=None, has_dimension=None, has_data_transformation_setup=None, position=None, id=None): # noqa: E501 """SpatiallyDistributedGrid - a model defined in OpenAPI""" # noqa: E501 self._has_dimensionality = None @@ -85,6 +87,7 @@ def __init__(self, has_dimensionality=None, has_format=None, path_location=None, self._has_fixed_resource = None self._has_coordinate_system = None self._has_spatial_resolution = None + self._is_transformed_from = None self._has_shape = None self._has_dimension = None self._has_data_transformation_setup = None @@ -104,6 +107,7 @@ def __init__(self, has_dimensionality=None, has_format=None, path_location=None, self.has_fixed_resource = has_fixed_resource self.has_coordinate_system = has_coordinate_system self.has_spatial_resolution = has_spatial_resolution + self.is_transformed_from = is_transformed_from self.has_shape = has_shape self.has_dimension = has_dimension self.has_data_transformation_setup = has_data_transformation_setup @@ -387,6 +391,29 @@ def has_spatial_resolution(self, has_spatial_resolution): self._has_spatial_resolution = has_spatial_resolution + @property + def is_transformed_from(self): + """Gets the is_transformed_from of this SpatiallyDistributedGrid. # noqa: E501 + + Description not available # noqa: E501 + + :return: The is_transformed_from of this SpatiallyDistributedGrid. # noqa: E501 + :rtype: list[DatasetSpecification] + """ + return self._is_transformed_from + + @is_transformed_from.setter + def is_transformed_from(self, is_transformed_from): + """Sets the is_transformed_from of this SpatiallyDistributedGrid. + + Description not available # noqa: E501 + + :param is_transformed_from: The is_transformed_from of this SpatiallyDistributedGrid. # noqa: E501 + :type: list[DatasetSpecification] + """ + + self._is_transformed_from = is_transformed_from + @property def has_shape(self): """Gets the has_shape of this SpatiallyDistributedGrid. # noqa: E501 diff --git a/modelcatalog/models/standard_variable.py b/modelcatalog/models/standard_variable.py index d4c4dae..22839e3 100644 --- a/modelcatalog/models/standard_variable.py +++ b/modelcatalog/models/standard_variable.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/models/theory_guided_model.py b/modelcatalog/models/theory_guided_model.py index 9740972..ff6163e 100644 --- a/modelcatalog/models/theory_guided_model.py +++ b/modelcatalog/models/theory_guided_model.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ @@ -63,7 +63,7 @@ class TheoryGuidedModel(object): 'description': 'list[str]', 'reference_publication': 'list[str]', 'screenshot': 'list[Image]', - 'has_model_category': 'list[str]', + 'has_model_category': 'list[ModelCategory]', 'had_primary_source': 'list[object]', 'issue_tracker': 'list[str]', 'date_created': 'list[datetime]', @@ -991,10 +991,10 @@ def screenshot(self, screenshot): def has_model_category(self): """Gets the has_model_category of this TheoryGuidedModel. # noqa: E501 - Category associated with a model (e.g., Hydrology) # noqa: E501 + Category associated with a model (e.g., Hydrology, etc.) # noqa: E501 :return: The has_model_category of this TheoryGuidedModel. # noqa: E501 - :rtype: list[str] + :rtype: list[ModelCategory] """ return self._has_model_category @@ -1002,10 +1002,10 @@ def has_model_category(self): def has_model_category(self, has_model_category): """Sets the has_model_category of this TheoryGuidedModel. - Category associated with a model (e.g., Hydrology) # noqa: E501 + Category associated with a model (e.g., Hydrology, etc.) # noqa: E501 :param has_model_category: The has_model_category of this TheoryGuidedModel. # noqa: E501 - :type: list[str] + :type: list[ModelCategory] """ self._has_model_category = has_model_category diff --git a/modelcatalog/models/time_interval.py b/modelcatalog/models/time_interval.py index 6b30b65..3774190 100644 --- a/modelcatalog/models/time_interval.py +++ b/modelcatalog/models/time_interval.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/models/unit.py b/modelcatalog/models/unit.py index 78a72cd..e278dfe 100644 --- a/modelcatalog/models/unit.py +++ b/modelcatalog/models/unit.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/models/user.py b/modelcatalog/models/user.py index b501be8..8195d27 100644 --- a/modelcatalog/models/user.py +++ b/modelcatalog/models/user.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/models/variable.py b/modelcatalog/models/variable.py index d0e6a4a..94ca3ce 100644 --- a/modelcatalog/models/variable.py +++ b/modelcatalog/models/variable.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/models/variable_presentation.py b/modelcatalog/models/variable_presentation.py index a7ba7e0..f899c67 100644 --- a/modelcatalog/models/variable_presentation.py +++ b/modelcatalog/models/variable_presentation.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/modelcatalog/models/visualization.py b/modelcatalog/models/visualization.py index 0905f53..45f2cd4 100644 --- a/modelcatalog/models/visualization.py +++ b/modelcatalog/models/visualization.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ @@ -102,7 +102,7 @@ def has_format(self, has_format): def had_primary_source(self): """Gets the had_primary_source of this Visualization. # noqa: E501 - had primary source # noqa: E501 + Property to identify the original source of the information of the annotated resource. It could be a web page, an organization, a person, some experiment notes, etc. # noqa: E501 :return: The had_primary_source of this Visualization. # noqa: E501 :rtype: list[object] @@ -113,7 +113,7 @@ def had_primary_source(self): def had_primary_source(self, had_primary_source): """Sets the had_primary_source of this Visualization. - had primary source # noqa: E501 + Property to identify the original source of the information of the annotated resource. It could be a web page, an organization, a person, some experiment notes, etc. # noqa: E501 :param had_primary_source: The had_primary_source of this Visualization. # noqa: E501 :type: list[object] @@ -125,7 +125,7 @@ def had_primary_source(self, had_primary_source): def was_derived_from_software(self): """Gets the was_derived_from_software of this Visualization. # noqa: E501 - Description not available # noqa: E501 + Property that identifies the software used to create a visualization # noqa: E501 :return: The was_derived_from_software of this Visualization. # noqa: E501 :rtype: list[Software] @@ -136,7 +136,7 @@ def was_derived_from_software(self): def was_derived_from_software(self, was_derived_from_software): """Sets the was_derived_from_software of this Visualization. - Description not available # noqa: E501 + Property that identifies the software used to create a visualization # noqa: E501 :param was_derived_from_software: The was_derived_from_software of this Visualization. # noqa: E501 :type: list[Software] diff --git a/modelcatalog/rest.py b/modelcatalog/rest.py index 7016e46..ab42f2b 100644 --- a/modelcatalog/rest.py +++ b/modelcatalog/rest.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/setup.py b/setup.py index 06f99a5..60d56de 100644 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 - The version of the OpenAPI document: v1.5.0 + The version of the OpenAPI document: v1.6.0 Generated by: https://openapi-generator.tech """ diff --git a/test/test_catalog_identifier.py b/test/test_catalog_identifier.py new file mode 100644 index 0000000..7d2cfed --- /dev/null +++ b/test/test_catalog_identifier.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Model Catalog + + This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 + + The version of the OpenAPI document: v1.6.0 + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest + +import modelcatalog +from modelcatalog.models.catalog_identifier import CatalogIdentifier # noqa: E501 +from modelcatalog.rest import ApiException + + +class TestCatalogIdentifier(unittest.TestCase): + """CatalogIdentifier unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCatalogIdentifier(self): + """Test CatalogIdentifier""" + # FIXME: construct object with mandatory attributes with example values + # model = modelcatalog.models.catalog_identifier.CatalogIdentifier() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_catalog_identifier_api.py b/test/test_catalog_identifier_api.py new file mode 100644 index 0000000..4e9c731 --- /dev/null +++ b/test/test_catalog_identifier_api.py @@ -0,0 +1,68 @@ +# coding: utf-8 + +""" + Model Catalog + + This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 + + The version of the OpenAPI document: v1.6.0 + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest + +import modelcatalog +from modelcatalog.api.catalog_identifier_api import CatalogIdentifierApi # noqa: E501 +from modelcatalog.rest import ApiException + + +class TestCatalogIdentifierApi(unittest.TestCase): + """CatalogIdentifierApi unit test stubs""" + + def setUp(self): + self.api = modelcatalog.api.catalog_identifier_api.CatalogIdentifierApi() # noqa: E501 + + def tearDown(self): + pass + + def test_catalogidentifiers_get(self): + """Test case for catalogidentifiers_get + + List all instances of CatalogIdentifier # noqa: E501 + """ + pass + + def test_catalogidentifiers_id_delete(self): + """Test case for catalogidentifiers_id_delete + + Delete an existing CatalogIdentifier # noqa: E501 + """ + pass + + def test_catalogidentifiers_id_get(self): + """Test case for catalogidentifiers_id_get + + Get a single CatalogIdentifier by its id # noqa: E501 + """ + pass + + def test_catalogidentifiers_id_put(self): + """Test case for catalogidentifiers_id_put + + Update an existing CatalogIdentifier # noqa: E501 + """ + pass + + def test_catalogidentifiers_post(self): + """Test case for catalogidentifiers_post + + Create one CatalogIdentifier # noqa: E501 + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_coupled_model.py b/test/test_coupled_model.py new file mode 100644 index 0000000..a149d1d --- /dev/null +++ b/test/test_coupled_model.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Model Catalog + + This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 + + The version of the OpenAPI document: v1.6.0 + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest + +import modelcatalog +from modelcatalog.models.coupled_model import CoupledModel # noqa: E501 +from modelcatalog.rest import ApiException + + +class TestCoupledModel(unittest.TestCase): + """CoupledModel unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCoupledModel(self): + """Test CoupledModel""" + # FIXME: construct object with mandatory attributes with example values + # model = modelcatalog.models.coupled_model.CoupledModel() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_coupled_model_api.py b/test/test_coupled_model_api.py new file mode 100644 index 0000000..9a82b68 --- /dev/null +++ b/test/test_coupled_model_api.py @@ -0,0 +1,68 @@ +# coding: utf-8 + +""" + Model Catalog + + This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 + + The version of the OpenAPI document: v1.6.0 + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest + +import modelcatalog +from modelcatalog.api.coupled_model_api import CoupledModelApi # noqa: E501 +from modelcatalog.rest import ApiException + + +class TestCoupledModelApi(unittest.TestCase): + """CoupledModelApi unit test stubs""" + + def setUp(self): + self.api = modelcatalog.api.coupled_model_api.CoupledModelApi() # noqa: E501 + + def tearDown(self): + pass + + def test_coupledmodels_get(self): + """Test case for coupledmodels_get + + List all instances of CoupledModel # noqa: E501 + """ + pass + + def test_coupledmodels_id_delete(self): + """Test case for coupledmodels_id_delete + + Delete an existing CoupledModel # noqa: E501 + """ + pass + + def test_coupledmodels_id_get(self): + """Test case for coupledmodels_id_get + + Get a single CoupledModel by its id # noqa: E501 + """ + pass + + def test_coupledmodels_id_put(self): + """Test case for coupledmodels_id_put + + Update an existing CoupledModel # noqa: E501 + """ + pass + + def test_coupledmodels_post(self): + """Test case for coupledmodels_post + + Create one CoupledModel # noqa: E501 + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_model_category.py b/test/test_model_category.py new file mode 100644 index 0000000..369a9e1 --- /dev/null +++ b/test/test_model_category.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Model Catalog + + This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 + + The version of the OpenAPI document: v1.6.0 + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest + +import modelcatalog +from modelcatalog.models.model_category import ModelCategory # noqa: E501 +from modelcatalog.rest import ApiException + + +class TestModelCategory(unittest.TestCase): + """ModelCategory unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testModelCategory(self): + """Test ModelCategory""" + # FIXME: construct object with mandatory attributes with example values + # model = modelcatalog.models.model_category.ModelCategory() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_model_category_api.py b/test/test_model_category_api.py new file mode 100644 index 0000000..23d12ff --- /dev/null +++ b/test/test_model_category_api.py @@ -0,0 +1,68 @@ +# coding: utf-8 + +""" + Model Catalog + + This is the API of the Software Description Ontology at [https://w3id.org/okn/o/sdm](https://w3id.org/okn/o/sdm) # noqa: E501 + + The version of the OpenAPI document: v1.6.0 + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest + +import modelcatalog +from modelcatalog.api.model_category_api import ModelCategoryApi # noqa: E501 +from modelcatalog.rest import ApiException + + +class TestModelCategoryApi(unittest.TestCase): + """ModelCategoryApi unit test stubs""" + + def setUp(self): + self.api = modelcatalog.api.model_category_api.ModelCategoryApi() # noqa: E501 + + def tearDown(self): + pass + + def test_modelcategorys_get(self): + """Test case for modelcategorys_get + + List all instances of ModelCategory # noqa: E501 + """ + pass + + def test_modelcategorys_id_delete(self): + """Test case for modelcategorys_id_delete + + Delete an existing ModelCategory # noqa: E501 + """ + pass + + def test_modelcategorys_id_get(self): + """Test case for modelcategorys_id_get + + Get a single ModelCategory by its id # noqa: E501 + """ + pass + + def test_modelcategorys_id_put(self): + """Test case for modelcategorys_id_put + + Update an existing ModelCategory # noqa: E501 + """ + pass + + def test_modelcategorys_post(self): + """Test case for modelcategorys_post + + Create one ModelCategory # noqa: E501 + """ + pass + + +if __name__ == '__main__': + unittest.main()