Skip to content

Commit

Permalink
relese using model catalog 1.5.0
Browse files Browse the repository at this point in the history
  • Loading branch information
mosoriob committed Aug 3, 2020
1 parent 9fc1461 commit 60c40d5
Show file tree
Hide file tree
Showing 48 changed files with 639 additions and 463 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,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
- Package version: 3.0.0
- Package version: 5.0.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.
Expand Down Expand Up @@ -87,6 +87,7 @@ 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
*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
Expand Down
4 changes: 2 additions & 2 deletions docs/endpoints/ConfigurationSetup.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Name | Type | Description | Notes
**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[str]** | Description not available | [optional]
**date_published** | **list[datetime]** | Description not available | [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_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]
Expand All @@ -45,7 +45,7 @@ Name | Type | Description | Notes
**had_primary_source** | **list[object]** | had primary source | [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[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]** | 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]
Expand Down
36 changes: 18 additions & 18 deletions docs/endpoints/DataTransformation.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,45 +11,45 @@ Name | Type | Description | Notes
**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[object]** | Property that links a software component to other useful software that canbe used to visualize its outputs | [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]
**has_faq** | **list[str]** | Frequently asked questions about a software | [optional]
**logo** | **list[object]** | Description not available | [optional]
**logo** | [**list[Image]**](Image.md) | Description not available | [optional]
**has_contact_person** | **list[object]** | Description not available | [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[object]** | Description not available | [optional]
**has_sample_result** | **list[object]** | 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]
**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[str]** | Description not available | [optional]
**date_published** | **list[datetime]** | Description not available | [optional]
**license** | **list[str]** | License of a software component or its source code | [optional]
**has_source_code** | **list[object]** | Description not available | [optional]
**has_setup** | **list[object]** | Property used to define configurations with some fixed resources and values. The rationale of this property is to allow predefined configurations | [optional]
**has_source_code** | [**list[SourceCode]**](SourceCode.md) | Description not available | [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]
**has_output** | **list[object]** | Property that expresses what are the outputs of a model | [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[object]** | Property that links a software project to its funding information | [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[object]** | 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]** | Main publication to cite for this software component | [optional]
**screenshot** | **list[object]** | Description not available | [optional]
**screenshot** | [**list[Image]**](Image.md) | Description not available | [optional]
**had_primary_source** | **list[object]** | had primary source | [optional]
**issue_tracker** | **list[str]** | Pointer to the issue tracker of a software component | [optional]
**has_software_image** | **list[object]** | Function to link a function with its corresponding container | [optional]
**date_created** | **list[str]** | Description not available | [optional]
**contributor** | **list[object]** | Description not available | [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]
**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[object]** | A typical sample visualization of the softwware outputs | [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]
**website** | **list[str]** | Website of the software | [optional]
**citation** | **list[str]** | How to cite this software | [optional]
Expand All @@ -59,11 +59,11 @@ Name | Type | Description | Notes
**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[object]** | Property that indicates the parameters of a model configuration | [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]
**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[object]** | 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[object]** | Property that links a model configuration to the input types expected by it. | [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]

[[Back to Model list]](../#documentation-for-models) [[Back to API list]](../#documentation-for-api-endpoints) [[Back to README]](../)

Expand Down
59 changes: 59 additions & 0 deletions docs/endpoints/DataTransformationApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,72 @@ All URIs are relative to *https://api.models.mint.isi.edu/v1.5.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
[**datatransformations_id_put**](DataTransformationApi.md#datatransformations_id_put) | **PUT** /datatransformations/{id} | Update an existing DataTransformation
[**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)
Expand Down
Loading

0 comments on commit 60c40d5

Please sign in to comment.