Merge branch 'master' of github.com:mintproject/model-catalog-python-…

…api-client

README.md

@@ -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)

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]](../)
+
+