diff --git a/appli/search/common.py b/appli/search/common.py
index 3648e8f9..0df49a62 100644
--- a/appli/search/common.py
+++ b/appli/search/common.py
@@ -5,7 +5,7 @@
from appli import app, gvg, DecodeEqualList
from appli.utils import ApiClient
-from to_back.ecotaxa_cli_py.api import SamplesApi, InstrumentApi, TaxonomyTreeApi, ProjectsApi
+from to_back.ecotaxa_cli_py.api import SamplesApi, InstrumentsApi, TaxonomyTreeApi, ProjectsApi
from to_back.ecotaxa_cli_py.models import ProjectModel, SampleModel, TaxonModel, ProjectUserStatsModel
@@ -64,7 +64,7 @@ def searchinstrumlist():
project_ids = ""
if gvg("projid") != "":
project_ids = gvg("projid")
- with ApiClient(InstrumentApi, request) as api:
+ with ApiClient(InstrumentsApi, request) as api:
instrums: List[str] = api.instrument_query_instruments_get(project_ids=project_ids)
txt = "List of available Intruments :
"
for r in instrums:
diff --git a/appli/utils.py b/appli/utils.py
index cf657f5c..269482ba 100644
--- a/appli/utils.py
+++ b/appli/utils.py
@@ -10,12 +10,12 @@
from to_back import booster
from to_back.ecotaxa_cli_py import ApiClient as _ApiClient
from to_back.ecotaxa_cli_py.api import ProjectsApi, UsersApi, ObjectsApi, SamplesApi, \
- AcquisitionsApi, ProcessesApi, ObjectApi, TaxonomyTreeApi, MiscApi, InstrumentApi, FilesApi, JobsApi
+ AcquisitionsApi, ProcessesApi, ObjectApi, TaxonomyTreeApi, MiscApi, InstrumentsApi, FilesApi, JobsApi
# Lol, generics in python
A = TypeVar('A', ProjectsApi, UsersApi, ObjectsApi, ObjectApi,
SamplesApi, AcquisitionsApi, ProcessesApi, TaxonomyTreeApi,
- MiscApi, InstrumentApi, FilesApi, JobsApi)
+ MiscApi, InstrumentsApi, FilesApi, JobsApi)
class ApiClient(Generic[A]):
diff --git a/to_back/ecotaxa_cli_py/__init__.py b/to_back/ecotaxa_cli_py/__init__.py
index 6f11f082..9a9c44e1 100644
--- a/to_back/ecotaxa_cli_py/__init__.py
+++ b/to_back/ecotaxa_cli_py/__init__.py
@@ -7,7 +7,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -23,7 +23,7 @@
from to_back.ecotaxa_cli_py.api.acquisitions_api import AcquisitionsApi
from to_back.ecotaxa_cli_py.api.authentification_api import AuthentificationApi
from to_back.ecotaxa_cli_py.api.collections_api import CollectionsApi
-from to_back.ecotaxa_cli_py.api.instrument_api import InstrumentApi
+from to_back.ecotaxa_cli_py.api.instruments_api import InstrumentsApi
from to_back.ecotaxa_cli_py.api.jobs_api import JobsApi
from to_back.ecotaxa_cli_py.api.misc_api import MiscApi
from to_back.ecotaxa_cli_py.api.object_api import ObjectApi
@@ -44,6 +44,7 @@
# import models into sdk package
from to_back.ecotaxa_cli_py.models.acquisition_model import AcquisitionModel
from to_back.ecotaxa_cli_py.models.body_export_object_set_object_set_export_post import BodyExportObjectSetObjectSetExportPost
+from to_back.ecotaxa_cli_py.models.body_predict_object_set_object_set_predict_post import BodyPredictObjectSetObjectSetPredictPost
from to_back.ecotaxa_cli_py.models.body_put_user_file_my_files_post import BodyPutUserFileMyFilesPost
from to_back.ecotaxa_cli_py.models.bulk_update_req import BulkUpdateReq
from to_back.ecotaxa_cli_py.models.classify_auto_req import ClassifyAutoReq
@@ -75,9 +76,12 @@
from to_back.ecotaxa_cli_py.models.object_set_query_rsp import ObjectSetQueryRsp
from to_back.ecotaxa_cli_py.models.object_set_revert_to_history_rsp import ObjectSetRevertToHistoryRsp
from to_back.ecotaxa_cli_py.models.object_set_summary_rsp import ObjectSetSummaryRsp
+from to_back.ecotaxa_cli_py.models.prediction_req import PredictionReq
+from to_back.ecotaxa_cli_py.models.prediction_rsp import PredictionRsp
from to_back.ecotaxa_cli_py.models.process_model import ProcessModel
from to_back.ecotaxa_cli_py.models.project_filters import ProjectFilters
from to_back.ecotaxa_cli_py.models.project_model import ProjectModel
+from to_back.ecotaxa_cli_py.models.project_set_column_stats_model import ProjectSetColumnStatsModel
from to_back.ecotaxa_cli_py.models.project_summary_model import ProjectSummaryModel
from to_back.ecotaxa_cli_py.models.project_taxo_stats_model import ProjectTaxoStatsModel
from to_back.ecotaxa_cli_py.models.project_user_stats_model import ProjectUserStatsModel
@@ -88,6 +92,7 @@
from to_back.ecotaxa_cli_py.models.subset_req import SubsetReq
from to_back.ecotaxa_cli_py.models.subset_rsp import SubsetRsp
from to_back.ecotaxa_cli_py.models.taxa_search_rsp import TaxaSearchRsp
+from to_back.ecotaxa_cli_py.models.taxon_central import TaxonCentral
from to_back.ecotaxa_cli_py.models.taxon_model import TaxonModel
from to_back.ecotaxa_cli_py.models.taxon_usage_model import TaxonUsageModel
from to_back.ecotaxa_cli_py.models.taxonomy_tree_status import TaxonomyTreeStatus
diff --git a/to_back/ecotaxa_cli_py/api/__init__.py b/to_back/ecotaxa_cli_py/api/__init__.py
index 267b5a24..0ccbd674 100644
--- a/to_back/ecotaxa_cli_py/api/__init__.py
+++ b/to_back/ecotaxa_cli_py/api/__init__.py
@@ -9,7 +9,7 @@
from to_back.ecotaxa_cli_py.api.acquisitions_api import AcquisitionsApi
from to_back.ecotaxa_cli_py.api.authentification_api import AuthentificationApi
from to_back.ecotaxa_cli_py.api.collections_api import CollectionsApi
-from to_back.ecotaxa_cli_py.api.instrument_api import InstrumentApi
+from to_back.ecotaxa_cli_py.api.instruments_api import InstrumentsApi
from to_back.ecotaxa_cli_py.api.jobs_api import JobsApi
from to_back.ecotaxa_cli_py.api.misc_api import MiscApi
from to_back.ecotaxa_cli_py.api.object_api import ObjectApi
diff --git a/to_back/ecotaxa_cli_py/api/acquisitions_api.py b/to_back/ecotaxa_cli_py/api/acquisitions_api.py
index 90f950fb..630eb749 100644
--- a/to_back/ecotaxa_cli_py/api/acquisitions_api.py
+++ b/to_back/ecotaxa_cli_py/api/acquisitions_api.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -39,14 +39,14 @@ def __init__(self, api_client=None):
def acquisition_query_acquisition_acquisition_id_get(self, acquisition_id, **kwargs): # noqa: E501
"""Acquisition Query # noqa: E501
- Read a single object. # noqa: E501
+ Returns **information about the acquisition** corresponding to the given id. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.acquisition_query_acquisition_acquisition_id_get(acquisition_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int acquisition_id: (required)
+ :param int acquisition_id: Internal, the unique numeric id of this acquisition. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -64,14 +64,14 @@ def acquisition_query_acquisition_acquisition_id_get(self, acquisition_id, **kwa
def acquisition_query_acquisition_acquisition_id_get_with_http_info(self, acquisition_id, **kwargs): # noqa: E501
"""Acquisition Query # noqa: E501
- Read a single object. # noqa: E501
+ Returns **information about the acquisition** corresponding to the given id. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.acquisition_query_acquisition_acquisition_id_get_with_http_info(acquisition_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int acquisition_id: (required)
+ :param int acquisition_id: Internal, the unique numeric id of this acquisition. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -153,14 +153,14 @@ def acquisition_query_acquisition_acquisition_id_get_with_http_info(self, acquis
def acquisitions_search_acquisitions_search_get(self, project_id, **kwargs): # noqa: E501
"""Acquisitions Search # noqa: E501
- Read all acquisitions for a project. # noqa: E501
+ Returns the **list of all acquisitions for a given project**. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.acquisitions_search_acquisitions_search_get(project_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
+ :param int project_id: The project id. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -178,14 +178,14 @@ def acquisitions_search_acquisitions_search_get(self, project_id, **kwargs): #
def acquisitions_search_acquisitions_search_get_with_http_info(self, project_id, **kwargs): # noqa: E501
"""Acquisitions Search # noqa: E501
- Read all acquisitions for a project. # noqa: E501
+ Returns the **list of all acquisitions for a given project**. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.acquisitions_search_acquisitions_search_get_with_http_info(project_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
+ :param int project_id: The project id. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -267,7 +267,7 @@ def acquisitions_search_acquisitions_search_get_with_http_info(self, project_id,
def update_acquisitions_acquisition_set_update_post(self, bulk_update_req, **kwargs): # noqa: E501
"""Update Acquisitions # noqa: E501
- Do the required update for each acquisition in the set. Return the number of updated entities. # noqa: E501
+ Do the required **update for each acquisition in the set**. **Return the number of updated entities.** # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_acquisitions_acquisition_set_update_post(bulk_update_req, async_req=True)
@@ -282,7 +282,7 @@ def update_acquisitions_acquisition_set_update_post(self, bulk_update_req, **kwa
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :return: object
+ :return: int
If the method is called asynchronously,
returns the request thread.
"""
@@ -292,7 +292,7 @@ def update_acquisitions_acquisition_set_update_post(self, bulk_update_req, **kwa
def update_acquisitions_acquisition_set_update_post_with_http_info(self, bulk_update_req, **kwargs): # noqa: E501
"""Update Acquisitions # noqa: E501
- Do the required update for each acquisition in the set. Return the number of updated entities. # noqa: E501
+ Do the required **update for each acquisition in the set**. **Return the number of updated entities.** # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_acquisitions_acquisition_set_update_post_with_http_info(bulk_update_req, async_req=True)
@@ -309,7 +309,7 @@ def update_acquisitions_acquisition_set_update_post_with_http_info(self, bulk_up
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :return: tuple(object, status_code(int), headers(HTTPHeaderDict))
+ :return: tuple(int, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
@@ -374,7 +374,7 @@ def update_acquisitions_acquisition_set_update_post_with_http_info(self, bulk_up
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='object', # noqa: E501
+ response_type='int', # 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
diff --git a/to_back/ecotaxa_cli_py/api/authentification_api.py b/to_back/ecotaxa_cli_py/api/authentification_api.py
index c76441f2..3f2750bc 100644
--- a/to_back/ecotaxa_cli_py/api/authentification_api.py
+++ b/to_back/ecotaxa_cli_py/api/authentification_api.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -39,7 +39,7 @@ def __init__(self, api_client=None):
def login_login_post(self, login_req, **kwargs): # noqa: E501
"""Login # noqa: E501
- Login barrier. If successful, the login will return a JWT which will have to be used in Bearer authentication scheme for subsequent calls. -`username`: User *email* which was used during registration -`password`: User password # noqa: E501
+ **Login barrier,** If successful, the login will returns a **JWT** which will have to be used in bearer authentication scheme for subsequent calls. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.login_login_post(login_req, async_req=True)
@@ -54,7 +54,7 @@ def login_login_post(self, login_req, **kwargs): # noqa: E501
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :return: object
+ :return: str
If the method is called asynchronously,
returns the request thread.
"""
@@ -64,7 +64,7 @@ def login_login_post(self, login_req, **kwargs): # noqa: E501
def login_login_post_with_http_info(self, login_req, **kwargs): # noqa: E501
"""Login # noqa: E501
- Login barrier. If successful, the login will return a JWT which will have to be used in Bearer authentication scheme for subsequent calls. -`username`: User *email* which was used during registration -`password`: User password # noqa: E501
+ **Login barrier,** If successful, the login will returns a **JWT** which will have to be used in bearer authentication scheme for subsequent calls. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.login_login_post_with_http_info(login_req, async_req=True)
@@ -81,7 +81,7 @@ def login_login_post_with_http_info(self, login_req, **kwargs): # noqa: E501
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :return: tuple(object, status_code(int), headers(HTTPHeaderDict))
+ :return: tuple(str, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
@@ -146,7 +146,7 @@ def login_login_post_with_http_info(self, login_req, **kwargs): # noqa: E501
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='object', # noqa: E501
+ response_type='str', # 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
diff --git a/to_back/ecotaxa_cli_py/api/collections_api.py b/to_back/ecotaxa_cli_py/api/collections_api.py
index b5c5f6fb..4882a564 100644
--- a/to_back/ecotaxa_cli_py/api/collections_api.py
+++ b/to_back/ecotaxa_cli_py/api/collections_api.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -39,14 +39,14 @@ def __init__(self, api_client=None):
def collection_by_short_title_collections_by_short_title_get(self, q, **kwargs): # noqa: E501
"""Collection By Short Title # noqa: E501
- Return the single collection with this title. For published datasets. !!! DO NOT MODIFY BEHAVIOR !!! # noqa: E501
+ Return the **single collection with this short title**. *For published datasets.* ⚠️ DO NOT MODIFY BEHAVIOR ⚠️ # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.collection_by_short_title_collections_by_short_title_get(q, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param str q: (required)
+ :param str q: Search by **exact** short title. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -64,14 +64,14 @@ def collection_by_short_title_collections_by_short_title_get(self, q, **kwargs):
def collection_by_short_title_collections_by_short_title_get_with_http_info(self, q, **kwargs): # noqa: E501
"""Collection By Short Title # noqa: E501
- Return the single collection with this title. For published datasets. !!! DO NOT MODIFY BEHAVIOR !!! # noqa: E501
+ Return the **single collection with this short title**. *For published datasets.* ⚠️ DO NOT MODIFY BEHAVIOR ⚠️ # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.collection_by_short_title_collections_by_short_title_get_with_http_info(q, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param str q: (required)
+ :param str q: Search by **exact** short title. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -153,14 +153,14 @@ def collection_by_short_title_collections_by_short_title_get_with_http_info(self
def collection_by_title_collections_by_title_get(self, q, **kwargs): # noqa: E501
"""Collection By Title # noqa: E501
- Return the single collection with this title. For published datasets. !!! DO NOT MODIFY BEHAVIOR !!! # noqa: E501
+ Return the **single collection with this title**. *For published datasets.* ⚠️ DO NOT MODIFY BEHAVIOR ⚠️ # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.collection_by_title_collections_by_title_get(q, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param str q: (required)
+ :param str q: Search by **exact** title. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -178,14 +178,14 @@ def collection_by_title_collections_by_title_get(self, q, **kwargs): # noqa: E5
def collection_by_title_collections_by_title_get_with_http_info(self, q, **kwargs): # noqa: E501
"""Collection By Title # noqa: E501
- Return the single collection with this title. For published datasets. !!! DO NOT MODIFY BEHAVIOR !!! # noqa: E501
+ Return the **single collection with this title**. *For published datasets.* ⚠️ DO NOT MODIFY BEHAVIOR ⚠️ # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.collection_by_title_collections_by_title_get_with_http_info(q, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param str q: (required)
+ :param str q: Search by **exact** title. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -267,7 +267,7 @@ def collection_by_title_collections_by_title_get_with_http_info(self, q, **kwarg
def create_collection_collections_create_post(self, create_collection_req, **kwargs): # noqa: E501
"""Create Collection # noqa: E501
- Create a collection with at least one project inside. *Currently only for admins* # noqa: E501
+ **Create a collection** with at least one project inside. Returns the created collection Id. 🔒 *For admins only.* # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_collection_collections_create_post(create_collection_req, async_req=True)
@@ -282,7 +282,7 @@ def create_collection_collections_create_post(self, create_collection_req, **kwa
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :return: object
+ :return: int
If the method is called asynchronously,
returns the request thread.
"""
@@ -292,7 +292,7 @@ def create_collection_collections_create_post(self, create_collection_req, **kwa
def create_collection_collections_create_post_with_http_info(self, create_collection_req, **kwargs): # noqa: E501
"""Create Collection # noqa: E501
- Create a collection with at least one project inside. *Currently only for admins* # noqa: E501
+ **Create a collection** with at least one project inside. Returns the created collection Id. 🔒 *For admins only.* # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_collection_collections_create_post_with_http_info(create_collection_req, async_req=True)
@@ -309,7 +309,7 @@ def create_collection_collections_create_post_with_http_info(self, create_collec
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :return: tuple(object, status_code(int), headers(HTTPHeaderDict))
+ :return: tuple(int, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
@@ -374,7 +374,7 @@ def create_collection_collections_create_post_with_http_info(self, create_collec
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='object', # noqa: E501
+ response_type='int', # 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
@@ -385,18 +385,18 @@ def create_collection_collections_create_post_with_http_info(self, create_collec
def emodnet_format_export_collections_collection_id_export_emodnet_get(self, collection_id, dry_run, with_zeroes, auto_morpho, with_computations, **kwargs): # noqa: E501
"""Emodnet Format Export # noqa: E501
- Export the collection in EMODnet format, @see https://www.emodnet-ingestion.eu/ Produces a DwC-A archive into a temporary directory, ready for download. - param `dry_run`: If set, then only a diagnostic of doability will be done. - param `with_zeroes`: If set, then *absent* records will be generated, in the relevant samples, for categories present in other samples. - param `with_computations`: If set, then an attempt will be made to compute organisms concentrations and biovolumes. - param `auto_morpho`: If set, then any object classified on a Morpho category will be added to the count of the nearest Phylo parent, upward in the tree. Maybe useful, a reader in Python: https://python-dwca-reader.readthedocs.io/en/latest/index.html *Currently only for admins* # noqa: E501
+ **Export the collection in EMODnet format**, @see https://www.emodnet-ingestion.eu Produces a DwC-A archive into a temporary directory, ready for download. Maybe useful, a reader in Python: https://python-dwca-reader.readthedocs.io/en/latest/index.html 🔒 *For admins only.* # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.emodnet_format_export_collections_collection_id_export_emodnet_get(collection_id, dry_run, with_zeroes, auto_morpho, with_computations, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int collection_id: (required)
- :param bool dry_run: (required)
- :param bool with_zeroes: (required)
- :param bool auto_morpho: (required)
- :param bool with_computations: (required)
+ :param int collection_id: Internal, the unique numeric id of this collection. (required)
+ :param bool dry_run: If set, then only a diagnostic of doability will be done. (required)
+ :param bool with_zeroes: If set, then *absent* records will be generated, in the relevant samples, for categories present in other samples. (required)
+ :param bool auto_morpho: If set, then any object classified on a Morpho category will be added to the count of the nearest Phylo parent, upward in the tree. (required)
+ :param bool with_computations: If set, then an attempt will be made to compute organisms concentrations and biovolumes. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -414,18 +414,18 @@ def emodnet_format_export_collections_collection_id_export_emodnet_get(self, col
def emodnet_format_export_collections_collection_id_export_emodnet_get_with_http_info(self, collection_id, dry_run, with_zeroes, auto_morpho, with_computations, **kwargs): # noqa: E501
"""Emodnet Format Export # noqa: E501
- Export the collection in EMODnet format, @see https://www.emodnet-ingestion.eu/ Produces a DwC-A archive into a temporary directory, ready for download. - param `dry_run`: If set, then only a diagnostic of doability will be done. - param `with_zeroes`: If set, then *absent* records will be generated, in the relevant samples, for categories present in other samples. - param `with_computations`: If set, then an attempt will be made to compute organisms concentrations and biovolumes. - param `auto_morpho`: If set, then any object classified on a Morpho category will be added to the count of the nearest Phylo parent, upward in the tree. Maybe useful, a reader in Python: https://python-dwca-reader.readthedocs.io/en/latest/index.html *Currently only for admins* # noqa: E501
+ **Export the collection in EMODnet format**, @see https://www.emodnet-ingestion.eu Produces a DwC-A archive into a temporary directory, ready for download. Maybe useful, a reader in Python: https://python-dwca-reader.readthedocs.io/en/latest/index.html 🔒 *For admins only.* # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.emodnet_format_export_collections_collection_id_export_emodnet_get_with_http_info(collection_id, dry_run, with_zeroes, auto_morpho, with_computations, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int collection_id: (required)
- :param bool dry_run: (required)
- :param bool with_zeroes: (required)
- :param bool auto_morpho: (required)
- :param bool with_computations: (required)
+ :param int collection_id: Internal, the unique numeric id of this collection. (required)
+ :param bool dry_run: If set, then only a diagnostic of doability will be done. (required)
+ :param bool with_zeroes: If set, then *absent* records will be generated, in the relevant samples, for categories present in other samples. (required)
+ :param bool auto_morpho: If set, then any object classified on a Morpho category will be added to the count of the nearest Phylo parent, upward in the tree. (required)
+ :param bool with_computations: If set, then an attempt will be made to compute organisms concentrations and biovolumes. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -535,14 +535,14 @@ def emodnet_format_export_collections_collection_id_export_emodnet_get_with_http
def erase_collection_collections_collection_id_delete(self, collection_id, **kwargs): # noqa: E501
"""Erase Collection # noqa: E501
- Delete the collection, i.e. the precious fields, as the projects are just linked-at from the collection. # noqa: E501
+ **Delete the collection**, i.e. the precious fields, as the projects are just linked-at from the collection. 🔒 *For admins only.* # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.erase_collection_collections_collection_id_delete(collection_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int collection_id: (required)
+ :param int collection_id: Internal, the unique numeric id of this collection. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -550,7 +550,7 @@ def erase_collection_collections_collection_id_delete(self, collection_id, **kwa
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :return: object
+ :return: int
If the method is called asynchronously,
returns the request thread.
"""
@@ -560,14 +560,14 @@ def erase_collection_collections_collection_id_delete(self, collection_id, **kwa
def erase_collection_collections_collection_id_delete_with_http_info(self, collection_id, **kwargs): # noqa: E501
"""Erase Collection # noqa: E501
- Delete the collection, i.e. the precious fields, as the projects are just linked-at from the collection. # noqa: E501
+ **Delete the collection**, i.e. the precious fields, as the projects are just linked-at from the collection. 🔒 *For admins only.* # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.erase_collection_collections_collection_id_delete_with_http_info(collection_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int collection_id: (required)
+ :param int collection_id: Internal, the unique numeric id of this collection. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -577,7 +577,7 @@ def erase_collection_collections_collection_id_delete_with_http_info(self, colle
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :return: tuple(object, status_code(int), headers(HTTPHeaderDict))
+ :return: tuple(int, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
@@ -638,7 +638,7 @@ def erase_collection_collections_collection_id_delete_with_http_info(self, colle
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='object', # noqa: E501
+ response_type='int', # 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
@@ -649,14 +649,14 @@ def erase_collection_collections_collection_id_delete_with_http_info(self, colle
def get_collection_collections_collection_id_get(self, collection_id, **kwargs): # noqa: E501
"""Get Collection # noqa: E501
- Read a collection by its ID. *Currently only for admins* # noqa: E501
+ Returns **information about the collection** corresponding to the given id. 🔒 *For admins only.* # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_collection_collections_collection_id_get(collection_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int collection_id: (required)
+ :param int collection_id: Internal, the unique numeric id of this collection. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -674,14 +674,14 @@ def get_collection_collections_collection_id_get(self, collection_id, **kwargs):
def get_collection_collections_collection_id_get_with_http_info(self, collection_id, **kwargs): # noqa: E501
"""Get Collection # noqa: E501
- Read a collection by its ID. *Currently only for admins* # noqa: E501
+ Returns **information about the collection** corresponding to the given id. 🔒 *For admins only.* # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_collection_collections_collection_id_get_with_http_info(collection_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int collection_id: (required)
+ :param int collection_id: Internal, the unique numeric id of this collection. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -763,14 +763,14 @@ def get_collection_collections_collection_id_get_with_http_info(self, collection
def search_collections_collections_search_get(self, title, **kwargs): # noqa: E501
"""Search Collections # noqa: E501
- Search for collections. Use % for searching with 'any char'. *Currently only for admins* # noqa: E501
+ **Search for collections.** 🔒 *For admins only.* # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.search_collections_collections_search_get(title, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param str title: (required)
+ :param str title: Search by title, use % for searching with 'any char'. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -788,14 +788,14 @@ def search_collections_collections_search_get(self, title, **kwargs): # noqa: E
def search_collections_collections_search_get_with_http_info(self, title, **kwargs): # noqa: E501
"""Search Collections # noqa: E501
- Search for collections. Use % for searching with 'any char'. *Currently only for admins* # noqa: E501
+ **Search for collections.** 🔒 *For admins only.* # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.search_collections_collections_search_get_with_http_info(title, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param str title: (required)
+ :param str title: Search by title, use % for searching with 'any char'. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -877,14 +877,14 @@ def search_collections_collections_search_get_with_http_info(self, title, **kwar
def update_collection_collections_collection_id_put(self, collection_id, collection_model, **kwargs): # noqa: E501
"""Update Collection # noqa: E501
- Update the collection. Note that some updates are silently failing when not compatible with the composing projects. *Currently only for admins* # noqa: E501
+ **Update the collection**. Note that some updates are silently failing when not compatible with the composing projects. **Returns NULL upon success.** 🔒 *For admins only.* # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_collection_collections_collection_id_put(collection_id, collection_model, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int collection_id: (required)
+ :param int collection_id: Internal, the unique numeric id of this collection. (required)
:param CollectionModel collection_model: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -903,14 +903,14 @@ def update_collection_collections_collection_id_put(self, collection_id, collect
def update_collection_collections_collection_id_put_with_http_info(self, collection_id, collection_model, **kwargs): # noqa: E501
"""Update Collection # noqa: E501
- Update the collection. Note that some updates are silently failing when not compatible with the composing projects. *Currently only for admins* # noqa: E501
+ **Update the collection**. Note that some updates are silently failing when not compatible with the composing projects. **Returns NULL upon success.** 🔒 *For admins only.* # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_collection_collections_collection_id_put_with_http_info(collection_id, collection_model, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int collection_id: (required)
+ :param int collection_id: Internal, the unique numeric id of this collection. (required)
:param CollectionModel collection_model: (required)
:param _return_http_data_only: response data without head status code
and headers
diff --git a/to_back/ecotaxa_cli_py/api/files_api.py b/to_back/ecotaxa_cli_py/api/files_api.py
index 881a83ee..50e84930 100644
--- a/to_back/ecotaxa_cli_py/api/files_api.py
+++ b/to_back/ecotaxa_cli_py/api/files_api.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -39,7 +39,7 @@ def __init__(self, api_client=None):
def list_common_files_common_files_get(self, path, **kwargs): # noqa: E501
"""List Common Files # noqa: E501
- List the common files which are usable for some file-related operations e.g. import. # noqa: E501
+ **List the common files** which are usable for some file-related operations. *e.g. import.* # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_common_files_common_files_get(path, async_req=True)
@@ -64,7 +64,7 @@ def list_common_files_common_files_get(self, path, **kwargs): # noqa: E501
def list_common_files_common_files_get_with_http_info(self, path, **kwargs): # noqa: E501
"""List Common Files # noqa: E501
- List the common files which are usable for some file-related operations e.g. import. # noqa: E501
+ **List the common files** which are usable for some file-related operations. *e.g. import.* # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_common_files_common_files_get_with_http_info(path, async_req=True)
@@ -153,7 +153,7 @@ def list_common_files_common_files_get_with_http_info(self, path, **kwargs): #
def list_user_files_my_files_sub_path_get(self, sub_path, **kwargs): # noqa: E501
"""List User Files # noqa: E501
- List the private files which are usable for some file-related operations e.g. import. # noqa: E501
+ **List the private files** which are usable for some file-related operations. *e.g. import.* # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_user_files_my_files_sub_path_get(sub_path, async_req=True)
@@ -178,7 +178,7 @@ def list_user_files_my_files_sub_path_get(self, sub_path, **kwargs): # noqa: E5
def list_user_files_my_files_sub_path_get_with_http_info(self, sub_path, **kwargs): # noqa: E501
"""List User Files # noqa: E501
- List the private files which are usable for some file-related operations e.g. import. # noqa: E501
+ **List the private files** which are usable for some file-related operations. *e.g. import.* # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_user_files_my_files_sub_path_get_with_http_info(sub_path, async_req=True)
@@ -267,7 +267,7 @@ def list_user_files_my_files_sub_path_get_with_http_info(self, sub_path, **kwarg
def put_user_file_my_files_post(self, file, **kwargs): # noqa: E501
"""Put User File # noqa: E501
- Upload a file for the current user. The returned text will contain a serve-side path which is usable for some file-related operations e.g. import. # noqa: E501
+ **Upload a file for the current user.** The returned text will contain a serve-side path which is usable for some file-related operations. *e.g. import.* # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.put_user_file_my_files_post(file, async_req=True)
@@ -275,8 +275,8 @@ def put_user_file_my_files_post(self, file, **kwargs): # noqa: E501
:param async_req bool: execute request asynchronously
:param file file: (required)
- :param str path:
- :param str tag:
+ :param str path: The client-side full path of the file.
+ :param str tag: If a tag is provided, then all files with the same tag are grouped (in a sub-directory). Otherwise, a temp directory with only this file will be created.
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -294,7 +294,7 @@ def put_user_file_my_files_post(self, file, **kwargs): # noqa: E501
def put_user_file_my_files_post_with_http_info(self, file, **kwargs): # noqa: E501
"""Put User File # noqa: E501
- Upload a file for the current user. The returned text will contain a serve-side path which is usable for some file-related operations e.g. import. # noqa: E501
+ **Upload a file for the current user.** The returned text will contain a serve-side path which is usable for some file-related operations. *e.g. import.* # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.put_user_file_my_files_post_with_http_info(file, async_req=True)
@@ -302,8 +302,8 @@ def put_user_file_my_files_post_with_http_info(self, file, **kwargs): # noqa: E
:param async_req bool: execute request asynchronously
:param file file: (required)
- :param str path:
- :param str tag:
+ :param str path: The client-side full path of the file.
+ :param str tag: If a tag is provided, then all files with the same tag are grouped (in a sub-directory). Otherwise, a temp directory with only this file will 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
diff --git a/to_back/ecotaxa_cli_py/api/instrument_api.py b/to_back/ecotaxa_cli_py/api/instruments_api.py
similarity index 92%
rename from to_back/ecotaxa_cli_py/api/instrument_api.py
rename to to_back/ecotaxa_cli_py/api/instruments_api.py
index da2f4e44..6cc60437 100644
--- a/to_back/ecotaxa_cli_py/api/instrument_api.py
+++ b/to_back/ecotaxa_cli_py/api/instruments_api.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -24,7 +24,7 @@
)
-class InstrumentApi(object):
+class InstrumentsApi(object):
"""NOTE: This class is auto generated by OpenAPI Generator
Ref: https://openapi-generator.tech
@@ -39,14 +39,14 @@ def __init__(self, api_client=None):
def instrument_query_instruments_get(self, project_ids, **kwargs): # noqa: E501
"""Instrument Query # noqa: E501
- Query for instruments, inside specific project(s). # noqa: E501
+ Returns the list of instruments, inside specific project(s). # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.instrument_query_instruments_get(project_ids, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param str project_ids: (required)
+ :param str project_ids: String containing the list of one or more project id separated by non-num char. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -64,14 +64,14 @@ def instrument_query_instruments_get(self, project_ids, **kwargs): # noqa: E501
def instrument_query_instruments_get_with_http_info(self, project_ids, **kwargs): # noqa: E501
"""Instrument Query # noqa: E501
- Query for instruments, inside specific project(s). # noqa: E501
+ Returns the list of instruments, inside specific project(s). # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.instrument_query_instruments_get_with_http_info(project_ids, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param str project_ids: (required)
+ :param str project_ids: String containing the list of one or more project id separated by non-num char. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
diff --git a/to_back/ecotaxa_cli_py/api/jobs_api.py b/to_back/ecotaxa_cli_py/api/jobs_api.py
index 9b5b0321..c59f2f0e 100644
--- a/to_back/ecotaxa_cli_py/api/jobs_api.py
+++ b/to_back/ecotaxa_cli_py/api/jobs_api.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -39,14 +39,14 @@ def __init__(self, api_client=None):
def erase_job_jobs_job_id_delete(self, job_id, **kwargs): # noqa: E501
"""Erase Job # noqa: E501
- Delete the job, from DB and with associated storage. If the job is running then kill it. # noqa: E501
+ **Delete the job** from DB, with associated storage. Return **NULL upon success.** If the job is running then kill it. 🔒 The job must be accessible to current user. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.erase_job_jobs_job_id_delete(job_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int job_id: (required)
+ :param int job_id: Internal, the unique numeric id of this job. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -64,14 +64,14 @@ def erase_job_jobs_job_id_delete(self, job_id, **kwargs): # noqa: E501
def erase_job_jobs_job_id_delete_with_http_info(self, job_id, **kwargs): # noqa: E501
"""Erase Job # noqa: E501
- Delete the job, from DB and with associated storage. If the job is running then kill it. # noqa: E501
+ **Delete the job** from DB, with associated storage. Return **NULL upon success.** If the job is running then kill it. 🔒 The job must be accessible to current user. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.erase_job_jobs_job_id_delete_with_http_info(job_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int job_id: (required)
+ :param int job_id: Internal, the unique numeric id of this job. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -153,14 +153,14 @@ def erase_job_jobs_job_id_delete_with_http_info(self, job_id, **kwargs): # noqa
def get_job_file_jobs_job_id_file_get(self, job_id, **kwargs): # noqa: E501
"""Get Job File # noqa: E501
- Return the file produced by given task. The task must belong to requester. # noqa: E501
+ **Return the file produced by given job.** 🔒 The job must be accessible to current user. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_job_file_jobs_job_id_file_get(job_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int job_id: (required)
+ :param int job_id: Internal, the unique numeric id of this job. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -178,14 +178,14 @@ def get_job_file_jobs_job_id_file_get(self, job_id, **kwargs): # noqa: E501
def get_job_file_jobs_job_id_file_get_with_http_info(self, job_id, **kwargs): # noqa: E501
"""Get Job File # noqa: E501
- Return the file produced by given task. The task must belong to requester. # noqa: E501
+ **Return the file produced by given job.** 🔒 The job must be accessible to current user. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_job_file_jobs_job_id_file_get_with_http_info(job_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int job_id: (required)
+ :param int job_id: Internal, the unique numeric id of this job. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -267,14 +267,14 @@ def get_job_file_jobs_job_id_file_get_with_http_info(self, job_id, **kwargs): #
def get_job_jobs_job_id_get(self, job_id, **kwargs): # noqa: E501
"""Get Job # noqa: E501
- Return the job by its id. # noqa: E501
+ Returns **information about the job** corresponding to the given id. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_job_jobs_job_id_get(job_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int job_id: (required)
+ :param int job_id: Internal, the unique numeric id of this job. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -292,14 +292,14 @@ def get_job_jobs_job_id_get(self, job_id, **kwargs): # noqa: E501
def get_job_jobs_job_id_get_with_http_info(self, job_id, **kwargs): # noqa: E501
"""Get Job # noqa: E501
- Return the job by its id. # noqa: E501
+ Returns **information about the job** corresponding to the given id. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_job_jobs_job_id_get_with_http_info(job_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int job_id: (required)
+ :param int job_id: Internal, the unique numeric id of this job. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -381,14 +381,14 @@ def get_job_jobs_job_id_get_with_http_info(self, job_id, **kwargs): # noqa: E50
def get_job_log_file_jobs_job_id_log_get(self, job_id, **kwargs): # noqa: E501
"""Get Job Log File # noqa: E501
- Return the log file produced by given task. The task must belong to requester. # noqa: E501
+ **Return the log file produced by given job.** 🔒 The job must be accessible to current user. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_job_log_file_jobs_job_id_log_get(job_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int job_id: (required)
+ :param int job_id: Internal, the unique numeric id of this job. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -406,14 +406,14 @@ def get_job_log_file_jobs_job_id_log_get(self, job_id, **kwargs): # noqa: E501
def get_job_log_file_jobs_job_id_log_get_with_http_info(self, job_id, **kwargs): # noqa: E501
"""Get Job Log File # noqa: E501
- Return the log file produced by given task. The task must belong to requester. # noqa: E501
+ **Return the log file produced by given job.** 🔒 The job must be accessible to current user. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_job_log_file_jobs_job_id_log_get_with_http_info(job_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int job_id: (required)
+ :param int job_id: Internal, the unique numeric id of this job. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -495,14 +495,14 @@ def get_job_log_file_jobs_job_id_log_get_with_http_info(self, job_id, **kwargs):
def list_jobs_jobs_get(self, for_admin, **kwargs): # noqa: E501
"""List Jobs # noqa: E501
- Return the jobs for current user, or all of them if admin and asked for. # noqa: E501
+ **Return the jobs** for current user, or all of them if admin is asked for. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_jobs_jobs_get(for_admin, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param bool for_admin: (required)
+ :param bool for_admin: If FALSE return the jobs for current user, else return all of them. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -520,14 +520,14 @@ def list_jobs_jobs_get(self, for_admin, **kwargs): # noqa: E501
def list_jobs_jobs_get_with_http_info(self, for_admin, **kwargs): # noqa: E501
"""List Jobs # noqa: E501
- Return the jobs for current user, or all of them if admin and asked for. # noqa: E501
+ **Return the jobs** for current user, or all of them if admin is asked for. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_jobs_jobs_get_with_http_info(for_admin, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param bool for_admin: (required)
+ :param bool for_admin: If FALSE return the jobs for current user, else return all of them. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -606,18 +606,18 @@ def list_jobs_jobs_get_with_http_info(self, for_admin, **kwargs): # noqa: E501
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
- def reply_job_question_jobs_job_id_answer_post(self, job_id, body, **kwargs): # noqa: E501
+ def reply_job_question_jobs_job_id_answer_post(self, job_id, **kwargs): # noqa: E501
"""Reply Job Question # noqa: E501
- Send answers to last question. The job resumes after it receives the reply. Note: It's only about data storage here. If the data is technically NOK e.g. not a JS object, standard 422 error should be thrown. If the data is incorrect from consistency point of view, the job will return in Asking state. # noqa: E501
+ **Send answers to last question.** The job resumes after it receives the reply. Return **NULL upon success.** *Note: It's only about data storage here.* If the data is technically NOK e.g. not a JS object, standard 422 error should be thrown. If the data is incorrect from consistency point of view, the job will return in Asking state. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.reply_job_question_jobs_job_id_answer_post(job_id, body, async_req=True)
+ >>> thread = api.reply_job_question_jobs_job_id_answer_post(job_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int job_id: (required)
- :param object body: (required)
+ :param int job_id: Internal, the unique numeric id of this job. (required)
+ :param object body:
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -630,20 +630,20 @@ def reply_job_question_jobs_job_id_answer_post(self, job_id, body, **kwargs): #
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
- return self.reply_job_question_jobs_job_id_answer_post_with_http_info(job_id, body, **kwargs) # noqa: E501
+ return self.reply_job_question_jobs_job_id_answer_post_with_http_info(job_id, **kwargs) # noqa: E501
- def reply_job_question_jobs_job_id_answer_post_with_http_info(self, job_id, body, **kwargs): # noqa: E501
+ def reply_job_question_jobs_job_id_answer_post_with_http_info(self, job_id, **kwargs): # noqa: E501
"""Reply Job Question # noqa: E501
- Send answers to last question. The job resumes after it receives the reply. Note: It's only about data storage here. If the data is technically NOK e.g. not a JS object, standard 422 error should be thrown. If the data is incorrect from consistency point of view, the job will return in Asking state. # noqa: E501
+ **Send answers to last question.** The job resumes after it receives the reply. Return **NULL upon success.** *Note: It's only about data storage here.* If the data is technically NOK e.g. not a JS object, standard 422 error should be thrown. If the data is incorrect from consistency point of view, the job will return in Asking state. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.reply_job_question_jobs_job_id_answer_post_with_http_info(job_id, body, async_req=True)
+ >>> thread = api.reply_job_question_jobs_job_id_answer_post_with_http_info(job_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int job_id: (required)
- :param object body: (required)
+ :param int job_id: Internal, the unique numeric id of this job. (required)
+ :param object body:
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -685,10 +685,6 @@ def reply_job_question_jobs_job_id_answer_post_with_http_info(self, job_id, body
if self.api_client.client_side_validation and ('job_id' not in local_var_params or # noqa: E501
local_var_params['job_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `job_id` when calling `reply_job_question_jobs_job_id_answer_post`") # noqa: E501
- # verify the required parameter 'body' is set
- if self.api_client.client_side_validation and ('body' not in local_var_params or # noqa: E501
- local_var_params['body'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `body` when calling `reply_job_question_jobs_job_id_answer_post`") # noqa: E501
collection_formats = {}
@@ -736,14 +732,14 @@ def reply_job_question_jobs_job_id_answer_post_with_http_info(self, job_id, body
def restart_job_jobs_job_id_restart_get(self, job_id, **kwargs): # noqa: E501
"""Restart Job # noqa: E501
- Restart the job by its id. The job must be in a restartable state, and be accessible to current user. # noqa: E501
+ **Restart the job related to the given id.** Return **NULL upon success.** 🔒 The job must be in a restartable state, and be accessible to current user. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.restart_job_jobs_job_id_restart_get(job_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int job_id: (required)
+ :param int job_id: Internal, the unique numeric id of this job. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -761,14 +757,14 @@ def restart_job_jobs_job_id_restart_get(self, job_id, **kwargs): # noqa: E501
def restart_job_jobs_job_id_restart_get_with_http_info(self, job_id, **kwargs): # noqa: E501
"""Restart Job # noqa: E501
- Restart the job by its id. The job must be in a restartable state, and be accessible to current user. # noqa: E501
+ **Restart the job related to the given id.** Return **NULL upon success.** 🔒 The job must be in a restartable state, and be accessible to current user. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.restart_job_jobs_job_id_restart_get_with_http_info(job_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int job_id: (required)
+ :param int job_id: Internal, the unique numeric id of this job. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
diff --git a/to_back/ecotaxa_cli_py/api/misc_api.py b/to_back/ecotaxa_cli_py/api/misc_api.py
index a7768707..a85c052d 100644
--- a/to_back/ecotaxa_cli_py/api/misc_api.py
+++ b/to_back/ecotaxa_cli_py/api/misc_api.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -39,7 +39,7 @@ def __init__(self, api_client=None):
def do_nothing_noop_get(self, **kwargs): # noqa: E501
"""Do Nothing # noqa: E501
- This entry point will just do nothing. It's also used for exporting models we need on client side. # noqa: E501
+ **This entry point will just do nothing.** It's also used for exporting models we need on client side. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.do_nothing_noop_get(async_req=True)
@@ -63,7 +63,7 @@ def do_nothing_noop_get(self, **kwargs): # noqa: E501
def do_nothing_noop_get_with_http_info(self, **kwargs): # noqa: E501
"""Do Nothing # noqa: E501
- This entry point will just do nothing. It's also used for exporting models we need on client side. # noqa: E501
+ **This entry point will just do nothing.** It's also used for exporting models we need on client side. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.do_nothing_noop_get_with_http_info(async_req=True)
@@ -144,7 +144,7 @@ def do_nothing_noop_get_with_http_info(self, **kwargs): # noqa: E501
def system_error_error_get(self, **kwargs): # noqa: E501
"""System Error # noqa: E501
- This entry point will return a 500 internal error, on purpose so the stack trace is visible and client can see what it gives. # noqa: E501
+ **Return a 500 internal error**, on purpose so the stack trace is visible and client can see what it gives. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.system_error_error_get(async_req=True)
@@ -168,7 +168,7 @@ def system_error_error_get(self, **kwargs): # noqa: E501
def system_error_error_get_with_http_info(self, **kwargs): # noqa: E501
"""System Error # noqa: E501
- This entry point will return a 500 internal error, on purpose so the stack trace is visible and client can see what it gives. # noqa: E501
+ **Return a 500 internal error**, on purpose so the stack trace is visible and client can see what it gives. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.system_error_error_get_with_http_info(async_req=True)
@@ -249,7 +249,7 @@ def system_error_error_get_with_http_info(self, **kwargs): # noqa: E501
def used_constants_constants_get(self, **kwargs): # noqa: E501
"""Used Constants # noqa: E501
- This entry point will return useful strings for user dialog. Now also used for values extracted from Config. # noqa: E501
+ **Return useful strings for user dialog.** Now also used for values extracted from Config. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.used_constants_constants_get(async_req=True)
@@ -273,7 +273,7 @@ def used_constants_constants_get(self, **kwargs): # noqa: E501
def used_constants_constants_get_with_http_info(self, **kwargs): # noqa: E501
"""Used Constants # noqa: E501
- This entry point will return useful strings for user dialog. Now also used for values extracted from Config. # noqa: E501
+ **Return useful strings for user dialog.** Now also used for values extracted from Config. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.used_constants_constants_get_with_http_info(async_req=True)
diff --git a/to_back/ecotaxa_cli_py/api/object_api.py b/to_back/ecotaxa_cli_py/api/object_api.py
index eb4e90f0..ed72ec89 100644
--- a/to_back/ecotaxa_cli_py/api/object_api.py
+++ b/to_back/ecotaxa_cli_py/api/object_api.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -39,14 +39,14 @@ def __init__(self, api_client=None):
def object_query_history_object_object_id_history_get(self, object_id, **kwargs): # noqa: E501
"""Object Query History # noqa: E501
- Read a single object's history. # noqa: E501
+ Returns **information about the object's history** corresponding to the given id. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.object_query_history_object_object_id_history_get(object_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int object_id: (required)
+ :param int object_id: Internal, the unique numeric id of this object. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -64,14 +64,14 @@ def object_query_history_object_object_id_history_get(self, object_id, **kwargs)
def object_query_history_object_object_id_history_get_with_http_info(self, object_id, **kwargs): # noqa: E501
"""Object Query History # noqa: E501
- Read a single object's history. # noqa: E501
+ Returns **information about the object's history** corresponding to the given id. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.object_query_history_object_object_id_history_get_with_http_info(object_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int object_id: (required)
+ :param int object_id: Internal, the unique numeric id of this object. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -153,14 +153,14 @@ def object_query_history_object_object_id_history_get_with_http_info(self, objec
def object_query_object_object_id_get(self, object_id, **kwargs): # noqa: E501
"""Object Query # noqa: E501
- Read a single object. Anonymous reader can do if the project has the right rights :) # noqa: E501
+ Returns **information about the object** corresponding to the given id. 🔒 Anonymous reader can do if the project has the right rights :) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.object_query_object_object_id_get(object_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int object_id: (required)
+ :param int object_id: Internal, the unique numeric id of this object. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -178,14 +178,14 @@ def object_query_object_object_id_get(self, object_id, **kwargs): # noqa: E501
def object_query_object_object_id_get_with_http_info(self, object_id, **kwargs): # noqa: E501
"""Object Query # noqa: E501
- Read a single object. Anonymous reader can do if the project has the right rights :) # noqa: E501
+ Returns **information about the object** corresponding to the given id. 🔒 Anonymous reader can do if the project has the right rights :) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.object_query_object_object_id_get_with_http_info(object_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int object_id: (required)
+ :param int object_id: Internal, the unique numeric id of this object. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
diff --git a/to_back/ecotaxa_cli_py/api/objects_api.py b/to_back/ecotaxa_cli_py/api/objects_api.py
index 38b6abe1..6f88e1a8 100644
--- a/to_back/ecotaxa_cli_py/api/objects_api.py
+++ b/to_back/ecotaxa_cli_py/api/objects_api.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -39,7 +39,7 @@ def __init__(self, api_client=None):
def classify_auto_object_set_object_set_classify_auto_post(self, classify_auto_req, **kwargs): # noqa: E501
"""Classify Auto Object Set # noqa: E501
- Set automatic classification of a set of objects. - `params`: None, all is in the Request body. # noqa: E501
+ **Set automatic classification** of a set of objects. **Returns the number of updated entities.** # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.classify_auto_object_set_object_set_classify_auto_post(classify_auto_req, async_req=True)
@@ -54,7 +54,7 @@ def classify_auto_object_set_object_set_classify_auto_post(self, classify_auto_r
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :return: object
+ :return: int
If the method is called asynchronously,
returns the request thread.
"""
@@ -64,7 +64,7 @@ def classify_auto_object_set_object_set_classify_auto_post(self, classify_auto_r
def classify_auto_object_set_object_set_classify_auto_post_with_http_info(self, classify_auto_req, **kwargs): # noqa: E501
"""Classify Auto Object Set # noqa: E501
- Set automatic classification of a set of objects. - `params`: None, all is in the Request body. # noqa: E501
+ **Set automatic classification** of a set of objects. **Returns the number of updated entities.** # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.classify_auto_object_set_object_set_classify_auto_post_with_http_info(classify_auto_req, async_req=True)
@@ -81,7 +81,7 @@ def classify_auto_object_set_object_set_classify_auto_post_with_http_info(self,
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :return: tuple(object, status_code(int), headers(HTTPHeaderDict))
+ :return: tuple(int, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
@@ -146,7 +146,7 @@ def classify_auto_object_set_object_set_classify_auto_post_with_http_info(self,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='object', # noqa: E501
+ response_type='int', # 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
@@ -157,7 +157,7 @@ def classify_auto_object_set_object_set_classify_auto_post_with_http_info(self,
def classify_object_set_object_set_classify_post(self, classify_req, **kwargs): # noqa: E501
"""Classify Object Set # noqa: E501
- Change classification and/or qualification for a set of objects. Current user needs at least Annotate right on all projects of specified objects. # noqa: E501
+ **Change classification and/or qualification for a set of objects.** **Returns the number of updated entities.** 🔒 Current user needs at *least Annotate* right on all projects of specified objects. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.classify_object_set_object_set_classify_post(classify_req, async_req=True)
@@ -172,7 +172,7 @@ def classify_object_set_object_set_classify_post(self, classify_req, **kwargs):
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :return: object
+ :return: int
If the method is called asynchronously,
returns the request thread.
"""
@@ -182,7 +182,7 @@ def classify_object_set_object_set_classify_post(self, classify_req, **kwargs):
def classify_object_set_object_set_classify_post_with_http_info(self, classify_req, **kwargs): # noqa: E501
"""Classify Object Set # noqa: E501
- Change classification and/or qualification for a set of objects. Current user needs at least Annotate right on all projects of specified objects. # noqa: E501
+ **Change classification and/or qualification for a set of objects.** **Returns the number of updated entities.** 🔒 Current user needs at *least Annotate* right on all projects of specified objects. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.classify_object_set_object_set_classify_post_with_http_info(classify_req, async_req=True)
@@ -199,7 +199,7 @@ def classify_object_set_object_set_classify_post_with_http_info(self, classify_r
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :return: tuple(object, status_code(int), headers(HTTPHeaderDict))
+ :return: tuple(int, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
@@ -264,7 +264,121 @@ def classify_object_set_object_set_classify_post_with_http_info(self, classify_r
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='object', # noqa: E501
+ response_type='int', # 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 compute_project_cnn_project_do_cnn_get(self, proj_id, **kwargs): # noqa: E501
+ """Compute Project Cnn # noqa: E501
+
+ **Generate CNN features** for the requested project. **Returns a string containing the number of generated features.** # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+ >>> thread = api.compute_project_cnn_project_do_cnn_get(proj_id, async_req=True)
+ >>> result = thread.get()
+
+ :param async_req bool: execute request asynchronously
+ :param int proj_id: Internal, numeric id of the project. (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: str
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ return self.compute_project_cnn_project_do_cnn_get_with_http_info(proj_id, **kwargs) # noqa: E501
+
+ def compute_project_cnn_project_do_cnn_get_with_http_info(self, proj_id, **kwargs): # noqa: E501
+ """Compute Project Cnn # noqa: E501
+
+ **Generate CNN features** for the requested project. **Returns a string containing the number of generated features.** # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+ >>> thread = api.compute_project_cnn_project_do_cnn_get_with_http_info(proj_id, async_req=True)
+ >>> result = thread.get()
+
+ :param async_req bool: execute request asynchronously
+ :param int proj_id: Internal, numeric id of the project. (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: tuple(str, status_code(int), headers(HTTPHeaderDict))
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ local_var_params = locals()
+
+ all_params = [
+ 'proj_id'
+ ]
+ all_params.extend(
+ [
+ 'async_req',
+ '_return_http_data_only',
+ '_preload_content',
+ '_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 compute_project_cnn_project_do_cnn_get" % key
+ )
+ local_var_params[key] = val
+ del local_var_params['kwargs']
+ # verify the required parameter 'proj_id' is set
+ if self.api_client.client_side_validation and ('proj_id' not in local_var_params or # noqa: E501
+ local_var_params['proj_id'] is None): # noqa: E501
+ raise ApiValueError("Missing the required parameter `proj_id` when calling `compute_project_cnn_project_do_cnn_get`") # noqa: E501
+
+ collection_formats = {}
+
+ path_params = {}
+ if 'proj_id' in local_var_params:
+ path_params['proj_id'] = local_var_params['proj_id'] # noqa: E501
+
+ query_params = []
+
+ 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 = ['BearerOrCookieAuth'] # noqa: E501
+
+ return self.api_client.call_api(
+ '/project/do_cnn', 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='str', # 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
@@ -275,7 +389,7 @@ def classify_object_set_object_set_classify_post_with_http_info(self, classify_r
def erase_object_set_object_set_delete(self, request_body, **kwargs): # noqa: E501
"""Erase Object Set # noqa: E501
- Delete the objects with given object ids. Current user needs Manage right on all projects of specified objects. # noqa: E501
+ **Delete the objects with given object ids.** **Returns** the number of : **deleted objects**, 0, **deleated image rows** and **deleated image files**. 🔒 Current user needs *Manage* right on all projects of specified objects. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.erase_object_set_object_set_delete(request_body, async_req=True)
@@ -300,7 +414,7 @@ def erase_object_set_object_set_delete(self, request_body, **kwargs): # noqa: E
def erase_object_set_object_set_delete_with_http_info(self, request_body, **kwargs): # noqa: E501
"""Erase Object Set # noqa: E501
- Delete the objects with given object ids. Current user needs Manage right on all projects of specified objects. # noqa: E501
+ **Delete the objects with given object ids.** **Returns** the number of : **deleted objects**, 0, **deleated image rows** and **deleated image files**. 🔒 Current user needs *Manage* right on all projects of specified objects. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.erase_object_set_object_set_delete_with_http_info(request_body, async_req=True)
@@ -393,7 +507,7 @@ def erase_object_set_object_set_delete_with_http_info(self, request_body, **kwar
def export_object_set_object_set_export_post(self, body_export_object_set_object_set_export_post, **kwargs): # noqa: E501
"""Export Object Set # noqa: E501
- Start an export job for the given object set and options. # noqa: E501
+ **Start an export job for the given object set and options.** # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.export_object_set_object_set_export_post(body_export_object_set_object_set_export_post, async_req=True)
@@ -418,7 +532,7 @@ def export_object_set_object_set_export_post(self, body_export_object_set_object
def export_object_set_object_set_export_post_with_http_info(self, body_export_object_set_object_set_export_post, **kwargs): # noqa: E501
"""Export Object Set # noqa: E501
- Start an export job for the given object set and options. # noqa: E501
+ **Start an export job for the given object set and options.** # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.export_object_set_object_set_export_post_with_http_info(body_export_object_set_object_set_export_post, async_req=True)
@@ -511,31 +625,19 @@ def export_object_set_object_set_export_post_with_http_info(self, body_export_ob
def get_object_set_object_set_project_id_query_post(self, project_id, project_filters, **kwargs): # noqa: E501
"""Get Object Set # noqa: E501
- Return object ids for the given project with the filters. Optionally: - fields will specify the needed object (and ancilliary entities) fields - order_field will order the result using given field, If prefixed with \"-\" then it will be reversed. - window_start & window_size allows to return only a slice of the result. Fields follow the naming convention: `prefix.field`. Prefix is either 'obj' for main object, 'fre' for free fields, 'img' for the visible image. Use a comma to separate fields. - Column obj.imgcount contains the total count of images for the object.
- More help:
- You can get the field labels by parsing the classiffieldlist returned by a call to https://ecotaxa.obs-vlfr.fr/api/docs#/projects/project_query_projects__project_id__get.
- **Note that the following fields must be prefixed with the header “obj.” ** (for example ==> obj.orig_id):
- acquisid classif_auto_id classif_auto_score classif_auto_when classif_crossvalidation_id
- classif_id classif_qual classif_who classif_when complement_info depth_max depth_min
- latitude longitude objdate object_link objid objtime orig_id random_value similarity sunpos
- **Note that the following fields must be prefixed with the header “img.“ ** (for example ==> img.file_name):
- file_name height imgid imgrank file_name orig objid file_name thumb_file_name thumb_height thumb_width width
- **Note that the following fields must be prefixed with the header “txo.” ** (for example ==> txo.display_name):
- creation_datetime creator_email display_name id id_instance id_source lastupdate_datetime
- name nbrobj nbrobjcum parent_id rename_to source_desc source_url taxostatus taxotype
- **All other fields must be prefixed by the header “fre.“ ** (for example ==> fre.circ.). # noqa: E501
+ Returns **filtred object Ids** for the given project. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_object_set_object_set_project_id_query_post(project_id, project_filters, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
+ :param int project_id: Internal, numeric id of the project. (required)
:param ProjectFilters project_filters: (required)
- :param str fields:
- :param str order_field:
- :param int window_start:
- :param int window_size:
+ :param str fields: Specify the needed object (and ancilliary entities) fields. It follows the naming convention 'prefix.field' : Prefix is either 'obj' for main object, 'fre' for free fields, 'img' for the visible image. The column obj.imgcount contains the total count of images for the object. Use a comma to separate fields. 💡 More help : You can get the field labels by parsing the classiffieldlist returned by a call to https://ecotaxa.obs-vlfr.fr/api/docs#/projects/project_query_projects__project_id__get. **Note that the following fields must be prefixed with the header \"obj.\"** (for example → obj.orig_id): acquisid classif_auto_id, classif_auto_score, classif_auto_when, classif_crossvalidation_id, classif_id, classif_qual, classif_who, classif_when, complement_info, depth_max, depth_min, latitude, longitude, objdate, object_link, objid, objtime, orig_id, random_value, similarity, sunpos. **Note that the following fields must be prefixed with the header \"img.\"** (for example → img.file_name): file_name, height, imgid, imgrank, file_name, orig, objid, file_name thumb_file_name, thumb_height, thumb_width, width. **Note that the following fields must be prefixed with the header \"txo.\"** (for example → txo.display_name): creation_datetime, creator_email, display_name, id, id_instance, id_source, lastupdate_datetime, name, nbrobj, nbrobjcum, parent_id, rename_to source_desc, source_url, taxostatus, taxotype. **All other fields must be prefixed by the header \"fre.\"** (for example → fre.circ.).
+ :param str order_field: Order the result using given field. If prefixed with \"-\" then it will be reversed.
+ :param int window_start: Allows to return only a slice of the result. Skip window_start before returning data.
+ :param int window_size: Allows to return only a slice of the result. Return only window_size lines.
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -553,31 +655,19 @@ def get_object_set_object_set_project_id_query_post(self, project_id, project_fi
def get_object_set_object_set_project_id_query_post_with_http_info(self, project_id, project_filters, **kwargs): # noqa: E501
"""Get Object Set # noqa: E501
- Return object ids for the given project with the filters. Optionally: - fields will specify the needed object (and ancilliary entities) fields - order_field will order the result using given field, If prefixed with \"-\" then it will be reversed. - window_start & window_size allows to return only a slice of the result. Fields follow the naming convention: `prefix.field`. Prefix is either 'obj' for main object, 'fre' for free fields, 'img' for the visible image. Use a comma to separate fields. - Column obj.imgcount contains the total count of images for the object.
- More help:
- You can get the field labels by parsing the classiffieldlist returned by a call to https://ecotaxa.obs-vlfr.fr/api/docs#/projects/project_query_projects__project_id__get.
- **Note that the following fields must be prefixed with the header “obj.” ** (for example ==> obj.orig_id):
- acquisid classif_auto_id classif_auto_score classif_auto_when classif_crossvalidation_id
- classif_id classif_qual classif_who classif_when complement_info depth_max depth_min
- latitude longitude objdate object_link objid objtime orig_id random_value similarity sunpos
- **Note that the following fields must be prefixed with the header “img.“ ** (for example ==> img.file_name):
- file_name height imgid imgrank file_name orig objid file_name thumb_file_name thumb_height thumb_width width
- **Note that the following fields must be prefixed with the header “txo.” ** (for example ==> txo.display_name):
- creation_datetime creator_email display_name id id_instance id_source lastupdate_datetime
- name nbrobj nbrobjcum parent_id rename_to source_desc source_url taxostatus taxotype
- **All other fields must be prefixed by the header “fre.“ ** (for example ==> fre.circ.). # noqa: E501
+ Returns **filtred object Ids** for the given project. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_object_set_object_set_project_id_query_post_with_http_info(project_id, project_filters, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
+ :param int project_id: Internal, numeric id of the project. (required)
:param ProjectFilters project_filters: (required)
- :param str fields:
- :param str order_field:
- :param int window_start:
- :param int window_size:
+ :param str fields: Specify the needed object (and ancilliary entities) fields. It follows the naming convention 'prefix.field' : Prefix is either 'obj' for main object, 'fre' for free fields, 'img' for the visible image. The column obj.imgcount contains the total count of images for the object. Use a comma to separate fields. 💡 More help : You can get the field labels by parsing the classiffieldlist returned by a call to https://ecotaxa.obs-vlfr.fr/api/docs#/projects/project_query_projects__project_id__get. **Note that the following fields must be prefixed with the header \"obj.\"** (for example → obj.orig_id): acquisid classif_auto_id, classif_auto_score, classif_auto_when, classif_crossvalidation_id, classif_id, classif_qual, classif_who, classif_when, complement_info, depth_max, depth_min, latitude, longitude, objdate, object_link, objid, objtime, orig_id, random_value, similarity, sunpos. **Note that the following fields must be prefixed with the header \"img.\"** (for example → img.file_name): file_name, height, imgid, imgrank, file_name, orig, objid, file_name thumb_file_name, thumb_height, thumb_width, width. **Note that the following fields must be prefixed with the header \"txo.\"** (for example → txo.display_name): creation_datetime, creator_email, display_name, id, id_instance, id_source, lastupdate_datetime, name, nbrobj, nbrobjcum, parent_id, rename_to source_desc, source_url, taxostatus, taxotype. **All other fields must be prefixed by the header \"fre.\"** (for example → fre.circ.).
+ :param str order_field: Order the result using given field. If prefixed with \"-\" then it will be reversed.
+ :param int window_start: Allows to return only a slice of the result. Skip window_start before returning data.
+ :param int window_size: Allows to return only a slice of the result. Return only window_size lines.
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -682,15 +772,15 @@ def get_object_set_object_set_project_id_query_post_with_http_info(self, project
def get_object_set_summary_object_set_project_id_summary_post(self, project_id, only_total, project_filters, **kwargs): # noqa: E501
"""Get Object Set Summary # noqa: E501
- For the given project, with given filters, return the classification summary, i.e.: - Total number of objects Also if 'only_total' is not set: - Number of Validated ones - Number of Dubious ones - Number of Predicted ones # noqa: E501
+ For the given project, with given filters, **return the classification summary**. i.e.: - Total number of objects And optionnaly - Number of Validated ones - Number of Dubious ones - Number of Predicted ones # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_object_set_summary_object_set_project_id_summary_post(project_id, only_total, project_filters, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
- :param bool only_total: (required)
+ :param int project_id: Internal, numeric id of the project. (required)
+ :param bool only_total: If True, returns only the **Total number of objects**. Else returns also the **Number of validated ones**, the **number of Dubious ones** and the number of **predicted ones**. (required)
:param ProjectFilters project_filters: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -709,15 +799,15 @@ def get_object_set_summary_object_set_project_id_summary_post(self, project_id,
def get_object_set_summary_object_set_project_id_summary_post_with_http_info(self, project_id, only_total, project_filters, **kwargs): # noqa: E501
"""Get Object Set Summary # noqa: E501
- For the given project, with given filters, return the classification summary, i.e.: - Total number of objects Also if 'only_total' is not set: - Number of Validated ones - Number of Dubious ones - Number of Predicted ones # noqa: E501
+ For the given project, with given filters, **return the classification summary**. i.e.: - Total number of objects And optionnaly - Number of Validated ones - Number of Dubious ones - Number of Predicted ones # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_object_set_summary_object_set_project_id_summary_post_with_http_info(project_id, only_total, project_filters, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
- :param bool only_total: (required)
+ :param int project_id: Internal, numeric id of the project. (required)
+ :param bool only_total: If True, returns only the **Total number of objects**. Else returns also the **Number of validated ones**, the **number of Dubious ones** and the number of **predicted ones**. (required)
:param ProjectFilters project_filters: (required)
:param _return_http_data_only: response data without head status code
and headers
@@ -815,10 +905,128 @@ def get_object_set_summary_object_set_project_id_summary_post_with_http_info(sel
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
+ def predict_object_set_object_set_predict_post(self, body_predict_object_set_object_set_predict_post, **kwargs): # noqa: E501
+ """Predict Object Set # noqa: E501
+
+ **Start a prediction** AKA automatic classification for the given object set and options. # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+ >>> thread = api.predict_object_set_object_set_predict_post(body_predict_object_set_object_set_predict_post, async_req=True)
+ >>> result = thread.get()
+
+ :param async_req bool: execute request asynchronously
+ :param BodyPredictObjectSetObjectSetPredictPost body_predict_object_set_object_set_predict_post: (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: PredictionRsp
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ return self.predict_object_set_object_set_predict_post_with_http_info(body_predict_object_set_object_set_predict_post, **kwargs) # noqa: E501
+
+ def predict_object_set_object_set_predict_post_with_http_info(self, body_predict_object_set_object_set_predict_post, **kwargs): # noqa: E501
+ """Predict Object Set # noqa: E501
+
+ **Start a prediction** AKA automatic classification for the given object set and options. # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+ >>> thread = api.predict_object_set_object_set_predict_post_with_http_info(body_predict_object_set_object_set_predict_post, async_req=True)
+ >>> result = thread.get()
+
+ :param async_req bool: execute request asynchronously
+ :param BodyPredictObjectSetObjectSetPredictPost body_predict_object_set_object_set_predict_post: (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: tuple(PredictionRsp, status_code(int), headers(HTTPHeaderDict))
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ local_var_params = locals()
+
+ all_params = [
+ 'body_predict_object_set_object_set_predict_post'
+ ]
+ all_params.extend(
+ [
+ 'async_req',
+ '_return_http_data_only',
+ '_preload_content',
+ '_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 predict_object_set_object_set_predict_post" % key
+ )
+ local_var_params[key] = val
+ del local_var_params['kwargs']
+ # verify the required parameter 'body_predict_object_set_object_set_predict_post' is set
+ if self.api_client.client_side_validation and ('body_predict_object_set_object_set_predict_post' not in local_var_params or # noqa: E501
+ local_var_params['body_predict_object_set_object_set_predict_post'] is None): # noqa: E501
+ raise ApiValueError("Missing the required parameter `body_predict_object_set_object_set_predict_post` when calling `predict_object_set_object_set_predict_post`") # noqa: E501
+
+ collection_formats = {}
+
+ path_params = {}
+
+ query_params = []
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ if 'body_predict_object_set_object_set_predict_post' in local_var_params:
+ body_params = local_var_params['body_predict_object_set_object_set_predict_post']
+ # 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 = ['BearerOrCookieAuth'] # noqa: E501
+
+ return self.api_client.call_api(
+ '/object_set/predict', 'POST',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='PredictionRsp', # 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 query_object_set_parents_object_set_parents_post(self, request_body, **kwargs): # noqa: E501
"""Query Object Set Parents # noqa: E501
- Return object ids, with parent ones and projects for the objects in given list. # noqa: E501
+ **Return object ids, with parent ones and projects** for the objects in given list. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.query_object_set_parents_object_set_parents_post(request_body, async_req=True)
@@ -843,7 +1051,7 @@ def query_object_set_parents_object_set_parents_post(self, request_body, **kwarg
def query_object_set_parents_object_set_parents_post_with_http_info(self, request_body, **kwargs): # noqa: E501
"""Query Object Set Parents # noqa: E501
- Return object ids, with parent ones and projects for the objects in given list. # noqa: E501
+ **Return object ids, with parent ones and projects** for the objects in given list. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.query_object_set_parents_object_set_parents_post_with_http_info(request_body, async_req=True)
@@ -936,16 +1144,16 @@ def query_object_set_parents_object_set_parents_post_with_http_info(self, reques
def reclassify_object_set_object_set_project_id_reclassify_post(self, project_id, forced_id, reason, project_filters, **kwargs): # noqa: E501
"""Reclassify Object Set # noqa: E501
- Regardless of present classification or state, set the new classification for this object set. If the filter designates \"all with given classification\", add a TaxonomyChangeLog entry. :returns the number of affected objects. # noqa: E501
+ Regardless of present classification or state, **set the new classification for this object set.** If the filter designates \"all with given classification\", add a TaxonomyChangeLog entry. **Returns the number of affected objects.** # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.reclassify_object_set_object_set_project_id_reclassify_post(project_id, forced_id, reason, project_filters, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
- :param int forced_id: (required)
- :param str reason: (required)
+ :param int project_id: Internal, numeric id of the project. (required)
+ :param int forced_id: The new classification Id. (required)
+ :param str reason: The reason of this new classification. (required)
:param ProjectFilters project_filters: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -954,7 +1162,7 @@ def reclassify_object_set_object_set_project_id_reclassify_post(self, project_id
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :return: object
+ :return: int
If the method is called asynchronously,
returns the request thread.
"""
@@ -964,16 +1172,16 @@ def reclassify_object_set_object_set_project_id_reclassify_post(self, project_id
def reclassify_object_set_object_set_project_id_reclassify_post_with_http_info(self, project_id, forced_id, reason, project_filters, **kwargs): # noqa: E501
"""Reclassify Object Set # noqa: E501
- Regardless of present classification or state, set the new classification for this object set. If the filter designates \"all with given classification\", add a TaxonomyChangeLog entry. :returns the number of affected objects. # noqa: E501
+ Regardless of present classification or state, **set the new classification for this object set.** If the filter designates \"all with given classification\", add a TaxonomyChangeLog entry. **Returns the number of affected objects.** # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.reclassify_object_set_object_set_project_id_reclassify_post_with_http_info(project_id, forced_id, reason, project_filters, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
- :param int forced_id: (required)
- :param str reason: (required)
+ :param int project_id: Internal, numeric id of the project. (required)
+ :param int forced_id: The new classification Id. (required)
+ :param str reason: The reason of this new classification. (required)
:param ProjectFilters project_filters: (required)
:param _return_http_data_only: response data without head status code
and headers
@@ -984,7 +1192,7 @@ def reclassify_object_set_object_set_project_id_reclassify_post_with_http_info(s
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :return: tuple(object, status_code(int), headers(HTTPHeaderDict))
+ :return: tuple(int, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
@@ -1070,7 +1278,7 @@ def reclassify_object_set_object_set_project_id_reclassify_post_with_http_info(s
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='object', # noqa: E501
+ response_type='int', # 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
@@ -1081,14 +1289,14 @@ def reclassify_object_set_object_set_project_id_reclassify_post_with_http_info(s
def reset_object_set_to_predicted_object_set_project_id_reset_to_predicted_post(self, project_id, project_filters, **kwargs): # noqa: E501
"""Reset Object Set To Predicted # noqa: E501
- Reset to Predicted all objects for the given project with the filters. # noqa: E501
+ **Reset to Predicted** all objects for the given project with the filters. Return **NULL upon success.** # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.reset_object_set_to_predicted_object_set_project_id_reset_to_predicted_post(project_id, project_filters, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
+ :param int project_id: Internal, numeric id of the project. (required)
:param ProjectFilters project_filters: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -1107,14 +1315,14 @@ def reset_object_set_to_predicted_object_set_project_id_reset_to_predicted_post(
def reset_object_set_to_predicted_object_set_project_id_reset_to_predicted_post_with_http_info(self, project_id, project_filters, **kwargs): # noqa: E501
"""Reset Object Set To Predicted # noqa: E501
- Reset to Predicted all objects for the given project with the filters. # noqa: E501
+ **Reset to Predicted** all objects for the given project with the filters. Return **NULL upon success.** # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.reset_object_set_to_predicted_object_set_project_id_reset_to_predicted_post_with_http_info(project_id, project_filters, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
+ :param int project_id: Internal, numeric id of the project. (required)
:param ProjectFilters project_filters: (required)
:param _return_http_data_only: response data without head status code
and headers
@@ -1208,17 +1416,17 @@ def reset_object_set_to_predicted_object_set_project_id_reset_to_predicted_post_
def revert_object_set_to_history_object_set_project_id_revert_to_history_post(self, project_id, dry_run, project_filters, **kwargs): # noqa: E501
"""Revert Object Set To History # noqa: E501
- Revert all objects for the given project, with the filters, to the target. - param `filters`: The set of filters to apply to get the target objects. - param `dry_run`: If set, then no real write but consequences of the revert will be replied. - param `target`: Use null/None for reverting using the last annotation from anyone, or a user id for the last annotation from this user. # noqa: E501
+ **Revert all objects for the given project**, with the filters, to the target. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.revert_object_set_to_history_object_set_project_id_revert_to_history_post(project_id, dry_run, project_filters, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
- :param bool dry_run: (required)
+ :param int project_id: Internal, numeric id of the project. (required)
+ :param bool dry_run: If set, then no real write but consequences of the revert will be replied. (required)
:param ProjectFilters project_filters: (required)
- :param int target:
+ :param int target: Use null/None for reverting using the last annotation from anyone, or a user id for the last annotation from this user.
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1236,17 +1444,17 @@ def revert_object_set_to_history_object_set_project_id_revert_to_history_post(se
def revert_object_set_to_history_object_set_project_id_revert_to_history_post_with_http_info(self, project_id, dry_run, project_filters, **kwargs): # noqa: E501
"""Revert Object Set To History # noqa: E501
- Revert all objects for the given project, with the filters, to the target. - param `filters`: The set of filters to apply to get the target objects. - param `dry_run`: If set, then no real write but consequences of the revert will be replied. - param `target`: Use null/None for reverting using the last annotation from anyone, or a user id for the last annotation from this user. # noqa: E501
+ **Revert all objects for the given project**, with the filters, to the target. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.revert_object_set_to_history_object_set_project_id_revert_to_history_post_with_http_info(project_id, dry_run, project_filters, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
- :param bool dry_run: (required)
+ :param int project_id: Internal, numeric id of the project. (required)
+ :param bool dry_run: If set, then no real write but consequences of the revert will be replied. (required)
:param ProjectFilters project_filters: (required)
- :param int target:
+ :param int target: Use null/None for reverting using the last annotation from anyone, or a user id for the last annotation from this user.
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1349,7 +1557,7 @@ def revert_object_set_to_history_object_set_project_id_revert_to_history_post_wi
def update_object_set_object_set_update_post(self, bulk_update_req, **kwargs): # noqa: E501
"""Update Object Set # noqa: E501
- Update all the objects with given IDs and values Current user needs Manage right on all projects of specified objects. # noqa: E501
+ Do the required **update for each objects in the set.** **Returns the number of updated entities.** 🔒 Current user needs *Manage* right on all projects of specified objects. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_object_set_object_set_update_post(bulk_update_req, async_req=True)
@@ -1364,7 +1572,7 @@ def update_object_set_object_set_update_post(self, bulk_update_req, **kwargs):
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :return: object
+ :return: int
If the method is called asynchronously,
returns the request thread.
"""
@@ -1374,7 +1582,7 @@ def update_object_set_object_set_update_post(self, bulk_update_req, **kwargs):
def update_object_set_object_set_update_post_with_http_info(self, bulk_update_req, **kwargs): # noqa: E501
"""Update Object Set # noqa: E501
- Update all the objects with given IDs and values Current user needs Manage right on all projects of specified objects. # noqa: E501
+ Do the required **update for each objects in the set.** **Returns the number of updated entities.** 🔒 Current user needs *Manage* right on all projects of specified objects. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_object_set_object_set_update_post_with_http_info(bulk_update_req, async_req=True)
@@ -1391,7 +1599,7 @@ def update_object_set_object_set_update_post_with_http_info(self, bulk_update_re
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :return: tuple(object, status_code(int), headers(HTTPHeaderDict))
+ :return: tuple(int, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
@@ -1456,7 +1664,7 @@ def update_object_set_object_set_update_post_with_http_info(self, bulk_update_re
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='object', # noqa: E501
+ response_type='int', # 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
diff --git a/to_back/ecotaxa_cli_py/api/processes_api.py b/to_back/ecotaxa_cli_py/api/processes_api.py
index 8fe16e0d..b97c7217 100644
--- a/to_back/ecotaxa_cli_py/api/processes_api.py
+++ b/to_back/ecotaxa_cli_py/api/processes_api.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -39,14 +39,14 @@ def __init__(self, api_client=None):
def process_query_process_process_id_get(self, process_id, **kwargs): # noqa: E501
"""Process Query # noqa: E501
- Read a single object. # noqa: E501
+ Returns **information about the process** corresponding to the given id. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.process_query_process_process_id_get(process_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int process_id: (required)
+ :param int process_id: Internal, the unique numeric id of this process. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -64,14 +64,14 @@ def process_query_process_process_id_get(self, process_id, **kwargs): # noqa: E
def process_query_process_process_id_get_with_http_info(self, process_id, **kwargs): # noqa: E501
"""Process Query # noqa: E501
- Read a single object. # noqa: E501
+ Returns **information about the process** corresponding to the given id. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.process_query_process_process_id_get_with_http_info(process_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int process_id: (required)
+ :param int process_id: Internal, the unique numeric id of this process. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -153,7 +153,7 @@ def process_query_process_process_id_get_with_http_info(self, process_id, **kwar
def update_processes_process_set_update_post(self, bulk_update_req, **kwargs): # noqa: E501
"""Update Processes # noqa: E501
- Do the required update for each process in the set. Return the number of updated entities. # noqa: E501
+ Do the required **update for each process in the set.** **Returns the number of updated entities.** # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_processes_process_set_update_post(bulk_update_req, async_req=True)
@@ -178,7 +178,7 @@ def update_processes_process_set_update_post(self, bulk_update_req, **kwargs):
def update_processes_process_set_update_post_with_http_info(self, bulk_update_req, **kwargs): # noqa: E501
"""Update Processes # noqa: E501
- Do the required update for each process in the set. Return the number of updated entities. # noqa: E501
+ Do the required **update for each process in the set.** **Returns the number of updated entities.** # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_processes_process_set_update_post_with_http_info(bulk_update_req, async_req=True)
diff --git a/to_back/ecotaxa_cli_py/api/projects_api.py b/to_back/ecotaxa_cli_py/api/projects_api.py
index 8d39c534..27902027 100644
--- a/to_back/ecotaxa_cli_py/api/projects_api.py
+++ b/to_back/ecotaxa_cli_py/api/projects_api.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -39,7 +39,7 @@ def __init__(self, api_client=None):
def create_project_projects_create_post(self, create_project_req, **kwargs): # noqa: E501
"""Create Project # noqa: E501
- Create an empty project with only a title, and return its number. The project will be managed by current user. The user has to be app administrator or project creator. # noqa: E501
+ **Create an empty project with only a title,** and **return the numeric id of this newly created project**. The project will be managed by current user. 🔒 The user has to be *app administrator* or *project creator*. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_project_projects_create_post(create_project_req, async_req=True)
@@ -54,7 +54,7 @@ def create_project_projects_create_post(self, create_project_req, **kwargs): #
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :return: object
+ :return: int
If the method is called asynchronously,
returns the request thread.
"""
@@ -64,7 +64,7 @@ def create_project_projects_create_post(self, create_project_req, **kwargs): #
def create_project_projects_create_post_with_http_info(self, create_project_req, **kwargs): # noqa: E501
"""Create Project # noqa: E501
- Create an empty project with only a title, and return its number. The project will be managed by current user. The user has to be app administrator or project creator. # noqa: E501
+ **Create an empty project with only a title,** and **return the numeric id of this newly created project**. The project will be managed by current user. 🔒 The user has to be *app administrator* or *project creator*. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_project_projects_create_post_with_http_info(create_project_req, async_req=True)
@@ -81,7 +81,7 @@ def create_project_projects_create_post_with_http_info(self, create_project_req,
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :return: tuple(object, status_code(int), headers(HTTPHeaderDict))
+ :return: tuple(int, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
@@ -146,7 +146,7 @@ def create_project_projects_create_post_with_http_info(self, create_project_req,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='object', # noqa: E501
+ response_type='int', # 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
@@ -157,15 +157,15 @@ def create_project_projects_create_post_with_http_info(self, create_project_req,
def erase_project_projects_project_id_delete(self, project_id, **kwargs): # noqa: E501
"""Erase Project # noqa: E501
- Delete the project. Optionally, if \"only_objects\" is set, the project structure is kept, but emptied from any object/sample/acquisition/process Otherwise, no trace of the project will remain in the database. # noqa: E501
+ **Delete the project.** Optionally, if \"only_objects\" is set, the project structure is kept, but emptied from any object, sample, acquisition and process. Otherwise, no trace of the project will remain in the database. **Returns** the number of : **deleted objects**, 0, **deleated image rows** and **deleated image files**. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.erase_project_projects_project_id_delete(project_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
- :param bool only_objects:
+ :param int project_id: Internal, numeric id of the project. (required)
+ :param bool only_objects: If set, the project structure is kept, but emptied from any object, sample, acquisition and process.
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -183,15 +183,15 @@ def erase_project_projects_project_id_delete(self, project_id, **kwargs): # noq
def erase_project_projects_project_id_delete_with_http_info(self, project_id, **kwargs): # noqa: E501
"""Erase Project # noqa: E501
- Delete the project. Optionally, if \"only_objects\" is set, the project structure is kept, but emptied from any object/sample/acquisition/process Otherwise, no trace of the project will remain in the database. # noqa: E501
+ **Delete the project.** Optionally, if \"only_objects\" is set, the project structure is kept, but emptied from any object, sample, acquisition and process. Otherwise, no trace of the project will remain in the database. **Returns** the number of : **deleted objects**, 0, **deleated image rows** and **deleated image files**. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.erase_project_projects_project_id_delete_with_http_info(project_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
- :param bool only_objects:
+ :param int project_id: Internal, numeric id of the project. (required)
+ :param bool only_objects: If set, the project structure is kept, but emptied from any object, sample, acquisition and process.
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -276,14 +276,14 @@ def erase_project_projects_project_id_delete_with_http_info(self, project_id, **
def import_file_file_import_project_id_post(self, project_id, import_req, **kwargs): # noqa: E501
"""Import File # noqa: E501
- Validate or do a real import of an EcoTaxa archive or directory. # noqa: E501
+ **Validate or do a real import** of an EcoTaxa archive or directory. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.import_file_file_import_project_id_post(project_id, import_req, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
+ :param int project_id: Internal, numeric id of the project. (required)
:param ImportReq import_req: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -302,14 +302,14 @@ def import_file_file_import_project_id_post(self, project_id, import_req, **kwar
def import_file_file_import_project_id_post_with_http_info(self, project_id, import_req, **kwargs): # noqa: E501
"""Import File # noqa: E501
- Validate or do a real import of an EcoTaxa archive or directory. # noqa: E501
+ **Validate or do a real import** of an EcoTaxa archive or directory. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.import_file_file_import_project_id_post_with_http_info(project_id, import_req, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
+ :param int project_id: Internal, numeric id of the project. (required)
:param ImportReq import_req: (required)
:param _return_http_data_only: response data without head status code
and headers
@@ -403,14 +403,14 @@ def import_file_file_import_project_id_post_with_http_info(self, project_id, imp
def project_check_projects_project_id_check_get(self, project_id, **kwargs): # noqa: E501
"""Project Check # noqa: E501
- Check consistency of a project. # noqa: E501
+ **Check consistency of a project**. With time and bugs, some consistency problems could be introduced in projects. This service aims at listing them. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.project_check_projects_project_id_check_get(project_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
+ :param int project_id: Internal, numeric id of the project. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -418,7 +418,7 @@ def project_check_projects_project_id_check_get(self, project_id, **kwargs): #
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :return: object
+ :return: list[str]
If the method is called asynchronously,
returns the request thread.
"""
@@ -428,14 +428,14 @@ def project_check_projects_project_id_check_get(self, project_id, **kwargs): #
def project_check_projects_project_id_check_get_with_http_info(self, project_id, **kwargs): # noqa: E501
"""Project Check # noqa: E501
- Check consistency of a project. # noqa: E501
+ **Check consistency of a project**. With time and bugs, some consistency problems could be introduced in projects. This service aims at listing them. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.project_check_projects_project_id_check_get_with_http_info(project_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
+ :param int project_id: Internal, numeric id of the project. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -445,7 +445,7 @@ def project_check_projects_project_id_check_get_with_http_info(self, project_id,
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :return: tuple(object, status_code(int), headers(HTTPHeaderDict))
+ :return: tuple(list[str], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
@@ -506,7 +506,7 @@ def project_check_projects_project_id_check_get_with_http_info(self, project_id,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='object', # noqa: E501
+ response_type='list[str]', # 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
@@ -517,16 +517,16 @@ def project_check_projects_project_id_check_get_with_http_info(self, project_id,
def project_merge_projects_project_id_merge_post(self, project_id, source_project_id, dry_run, **kwargs): # noqa: E501
"""Project Merge # noqa: E501
- Merge another project into this one. It's more a phagocytosis than a merge, as the source will see all its objects gone and will be erased. - param `dry_run`: If set, then only a diagnostic of doability will be done. # noqa: E501
+ **Merge another project into this one.** It's more a phagocytosis than a merge, as all objects from this source project will be moved to the project_id above and the source project itself will be deleted. TODO: Explain a bit with it might fail (too many free columns, unique orig_ids collision) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.project_merge_projects_project_id_merge_post(project_id, source_project_id, dry_run, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
- :param int source_project_id: (required)
- :param bool dry_run: (required)
+ :param int project_id: Internal, numeric id of the project. (required)
+ :param int source_project_id: Id of the other project. All objects from this source project will be moved to the project_id above and the source project itself will be deleted. (required)
+ :param bool dry_run: If set, then only a diagnostic of doability will be done. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -544,16 +544,16 @@ def project_merge_projects_project_id_merge_post(self, project_id, source_projec
def project_merge_projects_project_id_merge_post_with_http_info(self, project_id, source_project_id, dry_run, **kwargs): # noqa: E501
"""Project Merge # noqa: E501
- Merge another project into this one. It's more a phagocytosis than a merge, as the source will see all its objects gone and will be erased. - param `dry_run`: If set, then only a diagnostic of doability will be done. # noqa: E501
+ **Merge another project into this one.** It's more a phagocytosis than a merge, as all objects from this source project will be moved to the project_id above and the source project itself will be deleted. TODO: Explain a bit with it might fail (too many free columns, unique orig_ids collision) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.project_merge_projects_project_id_merge_post_with_http_info(project_id, source_project_id, dry_run, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
- :param int source_project_id: (required)
- :param bool dry_run: (required)
+ :param int project_id: Internal, numeric id of the project. (required)
+ :param int source_project_id: Id of the other project. All objects from this source project will be moved to the project_id above and the source project itself will be deleted. (required)
+ :param bool dry_run: If set, then only a diagnostic of doability will be done. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -649,15 +649,15 @@ def project_merge_projects_project_id_merge_post_with_http_info(self, project_id
def project_query_projects_project_id_get(self, project_id, **kwargs): # noqa: E501
"""Project Query # noqa: E501
- Read project if it exists for current user, eventually for managing it. # noqa: E501
+ **Returns project** if it exists for current user, eventually for managing it. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.project_query_projects_project_id_get(project_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
- :param bool for_managing:
+ :param int project_id: Internal, numeric id of the project. (required)
+ :param bool for_managing: For managing this project.
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -675,15 +675,15 @@ def project_query_projects_project_id_get(self, project_id, **kwargs): # noqa:
def project_query_projects_project_id_get_with_http_info(self, project_id, **kwargs): # noqa: E501
"""Project Query # noqa: E501
- Read project if it exists for current user, eventually for managing it. # noqa: E501
+ **Returns project** if it exists for current user, eventually for managing it. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.project_query_projects_project_id_get_with_http_info(project_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
- :param bool for_managing:
+ :param int project_id: Internal, numeric id of the project. (required)
+ :param bool for_managing: For managing this project.
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -768,14 +768,14 @@ def project_query_projects_project_id_get_with_http_info(self, project_id, **kwa
def project_recompute_geography_projects_project_id_recompute_geo_post(self, project_id, **kwargs): # noqa: E501
"""Project Recompute Geography # noqa: E501
- Recompute geography information for all samples in project. # noqa: E501
+ **Recompute geography information** for all samples in project. **Returns NULL upon success.** 🔒 The user has to be *project manager*. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.project_recompute_geography_projects_project_id_recompute_geo_post(project_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
+ :param int project_id: Internal, numeric id of the project. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -793,14 +793,14 @@ def project_recompute_geography_projects_project_id_recompute_geo_post(self, pro
def project_recompute_geography_projects_project_id_recompute_geo_post_with_http_info(self, project_id, **kwargs): # noqa: E501
"""Project Recompute Geography # noqa: E501
- Recompute geography information for all samples in project. # noqa: E501
+ **Recompute geography information** for all samples in project. **Returns NULL upon success.** 🔒 The user has to be *project manager*. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.project_recompute_geography_projects_project_id_recompute_geo_post_with_http_info(project_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
+ :param int project_id: Internal, numeric id of the project. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -879,18 +879,151 @@ def project_recompute_geography_projects_project_id_recompute_geo_post_with_http
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
+ def project_set_get_column_stats_project_set_column_stats_get(self, ids, names, **kwargs): # noqa: E501
+ """Project Set Get Column Stats # noqa: E501
+
+ **Returns projects validated data statistics**, for all named columns, in all given projects. The free columns here are named by the alias e.g. 'area', not technical name e.g. 'n43'. This allows getting stats on projects with different mappings, but common names. # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+ >>> thread = api.project_set_get_column_stats_project_set_column_stats_get(ids, names, async_req=True)
+ >>> result = thread.get()
+
+ :param async_req bool: execute request asynchronously
+ :param str ids: String containing the Project list, one or more id separated by non-num char. (required)
+ :param str names: Coma-separated prefixed columns, on which stats are needed. (required)
+ :param int limit: Only compute stats on this number of objects per category.
+ :param str categories: String containing the Categories, one or more id separated by non-num char.
+ :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: ProjectSetColumnStatsModel
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ return self.project_set_get_column_stats_project_set_column_stats_get_with_http_info(ids, names, **kwargs) # noqa: E501
+
+ def project_set_get_column_stats_project_set_column_stats_get_with_http_info(self, ids, names, **kwargs): # noqa: E501
+ """Project Set Get Column Stats # noqa: E501
+
+ **Returns projects validated data statistics**, for all named columns, in all given projects. The free columns here are named by the alias e.g. 'area', not technical name e.g. 'n43'. This allows getting stats on projects with different mappings, but common names. # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+ >>> thread = api.project_set_get_column_stats_project_set_column_stats_get_with_http_info(ids, names, async_req=True)
+ >>> result = thread.get()
+
+ :param async_req bool: execute request asynchronously
+ :param str ids: String containing the Project list, one or more id separated by non-num char. (required)
+ :param str names: Coma-separated prefixed columns, on which stats are needed. (required)
+ :param int limit: Only compute stats on this number of objects per category.
+ :param str categories: String containing the Categories, one or more id separated by non-num char.
+ :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(ProjectSetColumnStatsModel, status_code(int), headers(HTTPHeaderDict))
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ local_var_params = locals()
+
+ all_params = [
+ 'ids',
+ 'names',
+ 'limit',
+ 'categories'
+ ]
+ all_params.extend(
+ [
+ 'async_req',
+ '_return_http_data_only',
+ '_preload_content',
+ '_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 project_set_get_column_stats_project_set_column_stats_get" % key
+ )
+ local_var_params[key] = val
+ del local_var_params['kwargs']
+ # verify the required parameter 'ids' is set
+ if self.api_client.client_side_validation and ('ids' not in local_var_params or # noqa: E501
+ local_var_params['ids'] is None): # noqa: E501
+ raise ApiValueError("Missing the required parameter `ids` when calling `project_set_get_column_stats_project_set_column_stats_get`") # noqa: E501
+ # verify the required parameter 'names' is set
+ if self.api_client.client_side_validation and ('names' not in local_var_params or # noqa: E501
+ local_var_params['names'] is None): # noqa: E501
+ raise ApiValueError("Missing the required parameter `names` when calling `project_set_get_column_stats_project_set_column_stats_get`") # noqa: E501
+
+ collection_formats = {}
+
+ path_params = {}
+
+ query_params = []
+ if 'ids' in local_var_params and local_var_params['ids'] is not None: # noqa: E501
+ query_params.append(('ids', local_var_params['ids'])) # noqa: E501
+ if 'names' in local_var_params and local_var_params['names'] is not None: # noqa: E501
+ query_params.append(('names', local_var_params['names'])) # noqa: E501
+ if 'limit' in local_var_params and local_var_params['limit'] is not None: # noqa: E501
+ query_params.append(('limit', local_var_params['limit'])) # noqa: E501
+ if 'categories' in local_var_params and local_var_params['categories'] is not None: # noqa: E501
+ query_params.append(('categories', local_var_params['categories'])) # 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 = ['BearerOrCookieAuth'] # noqa: E501
+
+ return self.api_client.call_api(
+ '/project_set/column_stats', 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='ProjectSetColumnStatsModel', # 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 project_set_get_stats_project_set_taxo_stats_get(self, ids, **kwargs): # noqa: E501
"""Project Set Get Stats # noqa: E501
- Read projects statistics, i.e. used taxa and classification states. If several `ìds` are provided, one stat record will be returned per project. If several `taxa_ids` are provided, one stat record will be returned per requested taxa, if populated. If `taxa_ids` is 'all', all valued taxa in the project(s) are returned. # noqa: E501
+ **Returns projects statistics**, i.e. used taxa and classification states. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.project_set_get_stats_project_set_taxo_stats_get(ids, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param str ids: (required)
- :param str taxa_ids:
+ :param str ids: String containing the list of one or more id separated by non-num char. **If several ids are provided**, one stat record will be returned per project. (required)
+ :param str taxa_ids: **If several taxa_ids are provided**, one stat record will be returned per requested taxa, if populated. **If taxa_ids is all**, all valued taxa in the project(s) are returned.
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -908,15 +1041,15 @@ def project_set_get_stats_project_set_taxo_stats_get(self, ids, **kwargs): # no
def project_set_get_stats_project_set_taxo_stats_get_with_http_info(self, ids, **kwargs): # noqa: E501
"""Project Set Get Stats # noqa: E501
- Read projects statistics, i.e. used taxa and classification states. If several `ìds` are provided, one stat record will be returned per project. If several `taxa_ids` are provided, one stat record will be returned per requested taxa, if populated. If `taxa_ids` is 'all', all valued taxa in the project(s) are returned. # noqa: E501
+ **Returns projects statistics**, i.e. used taxa and classification states. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.project_set_get_stats_project_set_taxo_stats_get_with_http_info(ids, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param str ids: (required)
- :param str taxa_ids:
+ :param str ids: String containing the list of one or more id separated by non-num char. **If several ids are provided**, one stat record will be returned per project. (required)
+ :param str taxa_ids: **If several taxa_ids are provided**, one stat record will be returned per requested taxa, if populated. **If taxa_ids is all**, all valued taxa in the project(s) are returned.
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1001,14 +1134,14 @@ def project_set_get_stats_project_set_taxo_stats_get_with_http_info(self, ids, *
def project_set_get_user_stats_project_set_user_stats_get(self, ids, **kwargs): # noqa: E501
"""Project Set Get User Stats # noqa: E501
- Read projects user statistics, i.e. a summary of the work done by users in the required projects. The returned values are a detail _per project_, so size of input list equals size of output list. # noqa: E501
+ **Returns projects user statistics**, i.e. a summary of the work done by users in the required projects. The returned values are a detail per project, so size of input list equals size of output list. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.project_set_get_user_stats_project_set_user_stats_get(ids, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param str ids: (required)
+ :param str ids: String containing the list of one or more id separated by non-num char. **If several ids are provided**, one stat record will be returned per project. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1026,14 +1159,14 @@ def project_set_get_user_stats_project_set_user_stats_get(self, ids, **kwargs):
def project_set_get_user_stats_project_set_user_stats_get_with_http_info(self, ids, **kwargs): # noqa: E501
"""Project Set Get User Stats # noqa: E501
- Read projects user statistics, i.e. a summary of the work done by users in the required projects. The returned values are a detail _per project_, so size of input list equals size of output list. # noqa: E501
+ **Returns projects user statistics**, i.e. a summary of the work done by users in the required projects. The returned values are a detail per project, so size of input list equals size of output list. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.project_set_get_user_stats_project_set_user_stats_get_with_http_info(ids, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param str ids: (required)
+ :param str ids: String containing the list of one or more id separated by non-num char. **If several ids are provided**, one stat record will be returned per project. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1115,14 +1248,14 @@ def project_set_get_user_stats_project_set_user_stats_get_with_http_info(self, i
def project_stats_projects_project_id_stats_get(self, project_id, **kwargs): # noqa: E501
"""Project Stats # noqa: E501
- Check consistency of a project. # noqa: E501
+ **Returns stats** for a project. These stats will be returned as a list containing at index : - 0 : The **title** of the project, - 1 : A string containing all **freecols name and related column number**, - 2 : **\"(0):\"** - 3 : **\"Total: 0 values, dup 0 values\"** Then for each acquisition a pair of strings will be added to the list : - A string containing the **acquisition origin id** (the **number of objects for this acquisition**) : and then **small stats for an acquisition of a free column values inside** : [ min of values ; max of values ; distribution of the different values ; mode, i.e. freq of most frequent value] - A string containing the **number of total values** and the **number of duplicates values** \"Total: ... values, dup ... values\" # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.project_stats_projects_project_id_stats_get(project_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
+ :param int project_id: Internal, numeric id of the project. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1130,7 +1263,7 @@ def project_stats_projects_project_id_stats_get(self, project_id, **kwargs): #
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :return: object
+ :return: list[str]
If the method is called asynchronously,
returns the request thread.
"""
@@ -1140,14 +1273,14 @@ def project_stats_projects_project_id_stats_get(self, project_id, **kwargs): #
def project_stats_projects_project_id_stats_get_with_http_info(self, project_id, **kwargs): # noqa: E501
"""Project Stats # noqa: E501
- Check consistency of a project. # noqa: E501
+ **Returns stats** for a project. These stats will be returned as a list containing at index : - 0 : The **title** of the project, - 1 : A string containing all **freecols name and related column number**, - 2 : **\"(0):\"** - 3 : **\"Total: 0 values, dup 0 values\"** Then for each acquisition a pair of strings will be added to the list : - A string containing the **acquisition origin id** (the **number of objects for this acquisition**) : and then **small stats for an acquisition of a free column values inside** : [ min of values ; max of values ; distribution of the different values ; mode, i.e. freq of most frequent value] - A string containing the **number of total values** and the **number of duplicates values** \"Total: ... values, dup ... values\" # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.project_stats_projects_project_id_stats_get_with_http_info(project_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
+ :param int project_id: Internal, numeric id of the project. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1157,7 +1290,7 @@ def project_stats_projects_project_id_stats_get_with_http_info(self, project_id,
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :return: tuple(object, status_code(int), headers(HTTPHeaderDict))
+ :return: tuple(list[str], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
@@ -1218,7 +1351,7 @@ def project_stats_projects_project_id_stats_get_with_http_info(self, project_id,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='object', # noqa: E501
+ response_type='list[str]', # 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
@@ -1229,14 +1362,14 @@ def project_stats_projects_project_id_stats_get_with_http_info(self, project_id,
def project_subset_projects_project_id_subset_post(self, project_id, subset_req, **kwargs): # noqa: E501
"""Project Subset # noqa: E501
- Subset a project into another one. # noqa: E501
+ **Subset a project into another one.** # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.project_subset_projects_project_id_subset_post(project_id, subset_req, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
+ :param int project_id: Internal, numeric id of the project. (required)
:param SubsetReq subset_req: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -1255,14 +1388,14 @@ def project_subset_projects_project_id_subset_post(self, project_id, subset_req,
def project_subset_projects_project_id_subset_post_with_http_info(self, project_id, subset_req, **kwargs): # noqa: E501
"""Project Subset # noqa: E501
- Subset a project into another one. # noqa: E501
+ **Subset a project into another one.** # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.project_subset_projects_project_id_subset_post_with_http_info(project_id, subset_req, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
+ :param int project_id: Internal, numeric id of the project. (required)
:param SubsetReq subset_req: (required)
:param _return_http_data_only: response data without head status code
and headers
@@ -1356,7 +1489,7 @@ def project_subset_projects_project_id_subset_post_with_http_info(self, project_
def search_projects_projects_search_get(self, **kwargs): # noqa: E501
"""Search Projects # noqa: E501
- Return projects which the current user has explicit permission to access, with search options. - `param` not_granted: Return projects on which the current user has _no permission_, but visible to him/her - `param` for_managing: Return projects that can be written to (including erased) by the current user - `param` title_filter: Use this pattern for matching returned projects names - `param` instrument_filter: Only return projects where this instrument was used - `param` filter_subset: Only return projects having 'subset' in their names - `params` order_field, window_start, window_size: See accompanying description. Note that, for performance reasons, in returned ProjectModels, field 'highest_rank' is NOT valued (unlike in simple query). The same information can be found in 'managers', 'annotators' and 'viewers' lists. # noqa: E501
+ Returns **projects which the current user has explicit permission to access, with search options.** Note that, for performance reasons, in returned ProjectModels, field 'highest_rank' is NOT valued (unlike in simple query). The same information can be found in 'managers', 'annotators' and 'viewers' lists. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.search_projects_projects_search_get(async_req=True)
@@ -1364,14 +1497,14 @@ def search_projects_projects_search_get(self, **kwargs): # noqa: E501
:param async_req bool: execute request asynchronously
:param bool also_others:
- :param bool not_granted:
- :param bool for_managing:
- :param str title_filter:
- :param str instrument_filter:
- :param bool filter_subset:
- :param str order_field: One of ['instrument', 'highest_right', 'license', 'projid', 'title', 'visible', 'status', 'objcount', 'pctvalidated', 'pctclassified', 'classifsettings', 'classiffieldlist', 'popoverfieldlist', 'comments', 'projtype', 'rf_models_used', 'cnn_network_id']
- :param int window_start: Skip `window_start` before returning data
- :param int window_size: Return only `window_size` lines
+ :param bool not_granted: Return projects on which the current user has _no permission_, but visible to him/her.
+ :param bool for_managing: Return projects that can be written to (including erased) by the current user.
+ :param str title_filter: Use this pattern for matching returned projects names.
+ :param str instrument_filter: Only return projects where this instrument was used.
+ :param bool filter_subset: Only return projects having 'subset' in their names.
+ :param str order_field: One of ['instrument', 'highest_right', 'license', 'projid', 'title', 'visible', 'status', 'objcount', 'pctvalidated', 'pctclassified', 'classifsettings', 'classiffieldlist', 'popoverfieldlist', 'comments', 'description', 'rf_models_used', 'cnn_network_id']
+ :param int window_start: Skip `window_start` before returning data.
+ :param int window_size: Return only `window_size` lines.
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1389,7 +1522,7 @@ def search_projects_projects_search_get(self, **kwargs): # noqa: E501
def search_projects_projects_search_get_with_http_info(self, **kwargs): # noqa: E501
"""Search Projects # noqa: E501
- Return projects which the current user has explicit permission to access, with search options. - `param` not_granted: Return projects on which the current user has _no permission_, but visible to him/her - `param` for_managing: Return projects that can be written to (including erased) by the current user - `param` title_filter: Use this pattern for matching returned projects names - `param` instrument_filter: Only return projects where this instrument was used - `param` filter_subset: Only return projects having 'subset' in their names - `params` order_field, window_start, window_size: See accompanying description. Note that, for performance reasons, in returned ProjectModels, field 'highest_rank' is NOT valued (unlike in simple query). The same information can be found in 'managers', 'annotators' and 'viewers' lists. # noqa: E501
+ Returns **projects which the current user has explicit permission to access, with search options.** Note that, for performance reasons, in returned ProjectModels, field 'highest_rank' is NOT valued (unlike in simple query). The same information can be found in 'managers', 'annotators' and 'viewers' lists. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.search_projects_projects_search_get_with_http_info(async_req=True)
@@ -1397,14 +1530,14 @@ def search_projects_projects_search_get_with_http_info(self, **kwargs): # noqa:
:param async_req bool: execute request asynchronously
:param bool also_others:
- :param bool not_granted:
- :param bool for_managing:
- :param str title_filter:
- :param str instrument_filter:
- :param bool filter_subset:
- :param str order_field: One of ['instrument', 'highest_right', 'license', 'projid', 'title', 'visible', 'status', 'objcount', 'pctvalidated', 'pctclassified', 'classifsettings', 'classiffieldlist', 'popoverfieldlist', 'comments', 'projtype', 'rf_models_used', 'cnn_network_id']
- :param int window_start: Skip `window_start` before returning data
- :param int window_size: Return only `window_size` lines
+ :param bool not_granted: Return projects on which the current user has _no permission_, but visible to him/her.
+ :param bool for_managing: Return projects that can be written to (including erased) by the current user.
+ :param str title_filter: Use this pattern for matching returned projects names.
+ :param str instrument_filter: Only return projects where this instrument was used.
+ :param bool filter_subset: Only return projects having 'subset' in their names.
+ :param str order_field: One of ['instrument', 'highest_right', 'license', 'projid', 'title', 'visible', 'status', 'objcount', 'pctvalidated', 'pctclassified', 'classifsettings', 'classiffieldlist', 'popoverfieldlist', 'comments', 'description', 'rf_models_used', 'cnn_network_id']
+ :param int window_start: Skip `window_start` before returning data.
+ :param int window_size: Return only `window_size` lines.
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1503,18 +1636,141 @@ def search_projects_projects_search_get_with_http_info(self, **kwargs): # noqa:
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
+ def set_project_predict_settings_projects_project_id_prediction_settings_put(self, project_id, settings, **kwargs): # noqa: E501
+ """Set Project Predict Settings # noqa: E501
+
+ **Update the project's prediction settings**, return **NULL upon success.** 🔒 Unlike during full project update above, which needs high permissions, this entry point is accessible to **project annotators**, as it mirrors the prediction privileges. # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+ >>> thread = api.set_project_predict_settings_projects_project_id_prediction_settings_put(project_id, settings, async_req=True)
+ >>> result = thread.get()
+
+ :param async_req bool: execute request asynchronously
+ :param int project_id: Internal, numeric id of the project. (required)
+ :param str settings: The new prediction settings. (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: object
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ return self.set_project_predict_settings_projects_project_id_prediction_settings_put_with_http_info(project_id, settings, **kwargs) # noqa: E501
+
+ def set_project_predict_settings_projects_project_id_prediction_settings_put_with_http_info(self, project_id, settings, **kwargs): # noqa: E501
+ """Set Project Predict Settings # noqa: E501
+
+ **Update the project's prediction settings**, return **NULL upon success.** 🔒 Unlike during full project update above, which needs high permissions, this entry point is accessible to **project annotators**, as it mirrors the prediction privileges. # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+ >>> thread = api.set_project_predict_settings_projects_project_id_prediction_settings_put_with_http_info(project_id, settings, async_req=True)
+ >>> result = thread.get()
+
+ :param async_req bool: execute request asynchronously
+ :param int project_id: Internal, numeric id of the project. (required)
+ :param str settings: The new prediction settings. (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: tuple(object, status_code(int), headers(HTTPHeaderDict))
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ local_var_params = locals()
+
+ all_params = [
+ 'project_id',
+ 'settings'
+ ]
+ all_params.extend(
+ [
+ 'async_req',
+ '_return_http_data_only',
+ '_preload_content',
+ '_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 set_project_predict_settings_projects_project_id_prediction_settings_put" % key
+ )
+ local_var_params[key] = val
+ del local_var_params['kwargs']
+ # verify the required parameter 'project_id' is set
+ if self.api_client.client_side_validation and ('project_id' not in local_var_params or # noqa: E501
+ local_var_params['project_id'] is None): # noqa: E501
+ raise ApiValueError("Missing the required parameter `project_id` when calling `set_project_predict_settings_projects_project_id_prediction_settings_put`") # noqa: E501
+ # verify the required parameter 'settings' is set
+ if self.api_client.client_side_validation and ('settings' not in local_var_params or # noqa: E501
+ local_var_params['settings'] is None): # noqa: E501
+ raise ApiValueError("Missing the required parameter `settings` when calling `set_project_predict_settings_projects_project_id_prediction_settings_put`") # noqa: E501
+
+ collection_formats = {}
+
+ path_params = {}
+ if 'project_id' in local_var_params:
+ path_params['project_id'] = local_var_params['project_id'] # noqa: E501
+
+ query_params = []
+ if 'settings' in local_var_params and local_var_params['settings'] is not None: # noqa: E501
+ query_params.append(('settings', local_var_params['settings'])) # 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 = ['BearerOrCookieAuth'] # noqa: E501
+
+ return self.api_client.call_api(
+ '/projects/{project_id}/prediction_settings', 'PUT',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='object', # 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 simple_import_simple_import_project_id_post(self, project_id, dry_run, simple_import_req, **kwargs): # noqa: E501
"""Simple Import # noqa: E501
- Import images only, with same metadata for all. - param `dry_run`: If set, then _only_ a diagnostic of do-ability will be done. In this case, plain value check. If no dry_run, this call will create a background job. # noqa: E501
+ **Import images only**, with same metadata for all. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.simple_import_simple_import_project_id_post(project_id, dry_run, simple_import_req, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
- :param bool dry_run: (required)
+ :param int project_id: Internal, numeric id of the project. (required)
+ :param bool dry_run: If set, then only a diagnostic of doability will be done. In this case, plain value check. If no dry_run, this call will create a background job. (required)
:param SimpleImportReq simple_import_req: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -1533,15 +1789,15 @@ def simple_import_simple_import_project_id_post(self, project_id, dry_run, simpl
def simple_import_simple_import_project_id_post_with_http_info(self, project_id, dry_run, simple_import_req, **kwargs): # noqa: E501
"""Simple Import # noqa: E501
- Import images only, with same metadata for all. - param `dry_run`: If set, then _only_ a diagnostic of do-ability will be done. In this case, plain value check. If no dry_run, this call will create a background job. # noqa: E501
+ **Import images only**, with same metadata for all. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.simple_import_simple_import_project_id_post_with_http_info(project_id, dry_run, simple_import_req, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
- :param bool dry_run: (required)
+ :param int project_id: Internal, numeric id of the project. (required)
+ :param bool dry_run: If set, then only a diagnostic of doability will be done. In this case, plain value check. If no dry_run, this call will create a background job. (required)
:param SimpleImportReq simple_import_req: (required)
:param _return_http_data_only: response data without head status code
and headers
@@ -1642,14 +1898,14 @@ def simple_import_simple_import_project_id_post_with_http_info(self, project_id,
def update_project_projects_project_id_put(self, project_id, project_model, **kwargs): # noqa: E501
"""Update Project # noqa: E501
- Update the project. Note that some fields will NOT be updated and simply ignored, e.g. *free_cols. # noqa: E501
+ **Update the project**, return **NULL upon success.** Note that some fields will **NOT** be updated and simply ignored, e.g. *free_cols*. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_project_projects_project_id_put(project_id, project_model, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
+ :param int project_id: Internal, numeric id of the project. (required)
:param ProjectModel project_model: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -1668,14 +1924,14 @@ def update_project_projects_project_id_put(self, project_id, project_model, **kw
def update_project_projects_project_id_put_with_http_info(self, project_id, project_model, **kwargs): # noqa: E501
"""Update Project # noqa: E501
- Update the project. Note that some fields will NOT be updated and simply ignored, e.g. *free_cols. # noqa: E501
+ **Update the project**, return **NULL upon success.** Note that some fields will **NOT** be updated and simply ignored, e.g. *free_cols*. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_project_projects_project_id_put_with_http_info(project_id, project_model, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
+ :param int project_id: Internal, numeric id of the project. (required)
:param ProjectModel project_model: (required)
:param _return_http_data_only: response data without head status code
and headers
diff --git a/to_back/ecotaxa_cli_py/api/samples_api.py b/to_back/ecotaxa_cli_py/api/samples_api.py
index 7b81364a..54e71a49 100644
--- a/to_back/ecotaxa_cli_py/api/samples_api.py
+++ b/to_back/ecotaxa_cli_py/api/samples_api.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -39,14 +39,14 @@ def __init__(self, api_client=None):
def sample_query_sample_sample_id_get(self, sample_id, **kwargs): # noqa: E501
"""Sample Query # noqa: E501
- Read a single object. # noqa: E501
+ Returns **information about the sample** corresponding to the given id. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sample_query_sample_sample_id_get(sample_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int sample_id: (required)
+ :param int sample_id: Internal, the unique numeric id of this sample. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -64,14 +64,14 @@ def sample_query_sample_sample_id_get(self, sample_id, **kwargs): # noqa: E501
def sample_query_sample_sample_id_get_with_http_info(self, sample_id, **kwargs): # noqa: E501
"""Sample Query # noqa: E501
- Read a single object. # noqa: E501
+ Returns **information about the sample** corresponding to the given id. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sample_query_sample_sample_id_get_with_http_info(sample_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int sample_id: (required)
+ :param int sample_id: Internal, the unique numeric id of this sample. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -153,14 +153,14 @@ def sample_query_sample_sample_id_get_with_http_info(self, sample_id, **kwargs):
def sample_set_get_stats_sample_set_taxo_stats_get(self, sample_ids, **kwargs): # noqa: E501
"""Sample Set Get Stats # noqa: E501
- Read classification statistics for a set of samples. EXPECT A SLOW RESPONSE. No cache of such information anywhere. - sample_ids: any(non number)-separated list of sample numbers # noqa: E501
+ Returns **classification statistics** for the given set of samples. EXPECT A SLOW RESPONSE : No cache of such information anywhere. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sample_set_get_stats_sample_set_taxo_stats_get(sample_ids, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param str sample_ids: (required)
+ :param str sample_ids: String containing the list of one or more sample ids separated by non-num char. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -178,14 +178,14 @@ def sample_set_get_stats_sample_set_taxo_stats_get(self, sample_ids, **kwargs):
def sample_set_get_stats_sample_set_taxo_stats_get_with_http_info(self, sample_ids, **kwargs): # noqa: E501
"""Sample Set Get Stats # noqa: E501
- Read classification statistics for a set of samples. EXPECT A SLOW RESPONSE. No cache of such information anywhere. - sample_ids: any(non number)-separated list of sample numbers # noqa: E501
+ Returns **classification statistics** for the given set of samples. EXPECT A SLOW RESPONSE : No cache of such information anywhere. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sample_set_get_stats_sample_set_taxo_stats_get_with_http_info(sample_ids, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param str sample_ids: (required)
+ :param str sample_ids: String containing the list of one or more sample ids separated by non-num char. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -267,15 +267,15 @@ def sample_set_get_stats_sample_set_taxo_stats_get_with_http_info(self, sample_i
def samples_search_samples_search_get(self, project_ids, id_pattern, **kwargs): # noqa: E501
"""Samples Search # noqa: E501
- Read samples for a set of projects. - project_ids: any(non number)-separated list of project numbers - id_pattern: sample id textual pattern. Use * or '' for 'any matches'. Match is case-insensitive. # noqa: E501
+ **Search for samples.** # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.samples_search_samples_search_get(project_ids, id_pattern, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param str project_ids: (required)
- :param str id_pattern: (required)
+ :param str project_ids: String containing the list of one or more project id separated by non-num char. (required)
+ :param str id_pattern: Sample id textual pattern. Use * or '' for 'any matches'. Match is case-insensitive. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -293,15 +293,15 @@ def samples_search_samples_search_get(self, project_ids, id_pattern, **kwargs):
def samples_search_samples_search_get_with_http_info(self, project_ids, id_pattern, **kwargs): # noqa: E501
"""Samples Search # noqa: E501
- Read samples for a set of projects. - project_ids: any(non number)-separated list of project numbers - id_pattern: sample id textual pattern. Use * or '' for 'any matches'. Match is case-insensitive. # noqa: E501
+ **Search for samples.** # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.samples_search_samples_search_get_with_http_info(project_ids, id_pattern, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param str project_ids: (required)
- :param str id_pattern: (required)
+ :param str project_ids: String containing the list of one or more project id separated by non-num char. (required)
+ :param str id_pattern: Sample id textual pattern. Use * or '' for 'any matches'. Match is case-insensitive. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -390,7 +390,7 @@ def samples_search_samples_search_get_with_http_info(self, project_ids, id_patte
def update_samples_sample_set_update_post(self, bulk_update_req, **kwargs): # noqa: E501
"""Update Samples # noqa: E501
- Do the required update for each sample in the set. Any non-null field in the model is written to every impacted sample. Return the number of updated entities. # noqa: E501
+ Do the required **update for each sample in the set.** Any non-null field in the model is written to every impacted sample. **Returns the number of updated entities.** # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_samples_sample_set_update_post(bulk_update_req, async_req=True)
@@ -405,7 +405,7 @@ def update_samples_sample_set_update_post(self, bulk_update_req, **kwargs): # n
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :return: object
+ :return: int
If the method is called asynchronously,
returns the request thread.
"""
@@ -415,7 +415,7 @@ def update_samples_sample_set_update_post(self, bulk_update_req, **kwargs): # n
def update_samples_sample_set_update_post_with_http_info(self, bulk_update_req, **kwargs): # noqa: E501
"""Update Samples # noqa: E501
- Do the required update for each sample in the set. Any non-null field in the model is written to every impacted sample. Return the number of updated entities. # noqa: E501
+ Do the required **update for each sample in the set.** Any non-null field in the model is written to every impacted sample. **Returns the number of updated entities.** # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_samples_sample_set_update_post_with_http_info(bulk_update_req, async_req=True)
@@ -432,7 +432,7 @@ def update_samples_sample_set_update_post_with_http_info(self, bulk_update_req,
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :return: tuple(object, status_code(int), headers(HTTPHeaderDict))
+ :return: tuple(int, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
@@ -497,7 +497,7 @@ def update_samples_sample_set_update_post_with_http_info(self, bulk_update_req,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='object', # noqa: E501
+ response_type='int', # 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
diff --git a/to_back/ecotaxa_cli_py/api/taxonomy_tree_api.py b/to_back/ecotaxa_cli_py/api/taxonomy_tree_api.py
index ce0bef17..4b25ac4e 100644
--- a/to_back/ecotaxa_cli_py/api/taxonomy_tree_api.py
+++ b/to_back/ecotaxa_cli_py/api/taxonomy_tree_api.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -39,19 +39,19 @@ def __init__(self, api_client=None):
def add_taxon_in_central_taxon_central_put(self, name, parent_id, taxotype, creator_email, **kwargs): # noqa: E501
"""Add Taxon In Central # noqa: E501
- Create a taxon on EcoTaxoServer. Logged user must be manager (on any project) or application admin. # noqa: E501
+ **Create a taxon** on EcoTaxoServer. 🔒 Logged user must be manager (on any project) or application admin. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.add_taxon_in_central_taxon_central_put(name, parent_id, taxotype, creator_email, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param str name: (required)
- :param int parent_id: (required)
- :param str taxotype: (required)
- :param str creator_email: (required)
- :param str source_desc:
- :param str source_url:
+ :param str name: The taxon/category verbatim name. (required)
+ :param int parent_id: It's not possible to create a root taxon. (required)
+ :param str taxotype: The taxon type, 'M' for Morpho or 'P' for Phylo. (required)
+ :param str creator_email: The email of the taxo creator. (required)
+ :param str source_desc: The source description.
+ :param str source_url: The source url.
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -69,19 +69,19 @@ def add_taxon_in_central_taxon_central_put(self, name, parent_id, taxotype, crea
def add_taxon_in_central_taxon_central_put_with_http_info(self, name, parent_id, taxotype, creator_email, **kwargs): # noqa: E501
"""Add Taxon In Central # noqa: E501
- Create a taxon on EcoTaxoServer. Logged user must be manager (on any project) or application admin. # noqa: E501
+ **Create a taxon** on EcoTaxoServer. 🔒 Logged user must be manager (on any project) or application admin. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.add_taxon_in_central_taxon_central_put_with_http_info(name, parent_id, taxotype, creator_email, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param str name: (required)
- :param int parent_id: (required)
- :param str taxotype: (required)
- :param str creator_email: (required)
- :param str source_desc:
- :param str source_url:
+ :param str name: The taxon/category verbatim name. (required)
+ :param int parent_id: It's not possible to create a root taxon. (required)
+ :param str taxotype: The taxon type, 'M' for Morpho or 'P' for Phylo. (required)
+ :param str creator_email: The email of the taxo creator. (required)
+ :param str source_desc: The source description.
+ :param str source_url: The source url.
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -190,14 +190,14 @@ def add_taxon_in_central_taxon_central_put_with_http_info(self, name, parent_id,
def get_taxon_in_central_taxon_central_taxon_id_get(self, taxon_id, **kwargs): # noqa: E501
"""Get Taxon In Central # noqa: E501
- Get EcoTaxoServer full record for this taxon. # noqa: E501
+ Return **EcoTaxoServer full record for this taxon**. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_taxon_in_central_taxon_central_taxon_id_get(taxon_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int taxon_id: (required)
+ :param int taxon_id: Internal, the unique numeric id of this taxon. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -205,7 +205,7 @@ def get_taxon_in_central_taxon_central_taxon_id_get(self, taxon_id, **kwargs):
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :return: object
+ :return: list[TaxonCentral]
If the method is called asynchronously,
returns the request thread.
"""
@@ -215,14 +215,14 @@ def get_taxon_in_central_taxon_central_taxon_id_get(self, taxon_id, **kwargs):
def get_taxon_in_central_taxon_central_taxon_id_get_with_http_info(self, taxon_id, **kwargs): # noqa: E501
"""Get Taxon In Central # noqa: E501
- Get EcoTaxoServer full record for this taxon. # noqa: E501
+ Return **EcoTaxoServer full record for this taxon**. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_taxon_in_central_taxon_central_taxon_id_get_with_http_info(taxon_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int taxon_id: (required)
+ :param int taxon_id: Internal, the unique numeric id of this taxon. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -232,7 +232,7 @@ def get_taxon_in_central_taxon_central_taxon_id_get_with_http_info(self, taxon_i
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :return: tuple(object, status_code(int), headers(HTTPHeaderDict))
+ :return: tuple(list[TaxonCentral], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
@@ -293,7 +293,7 @@ def get_taxon_in_central_taxon_central_taxon_id_get_with_http_info(self, taxon_i
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='object', # noqa: E501
+ response_type='list[TaxonCentral]', # 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
@@ -304,7 +304,7 @@ def get_taxon_in_central_taxon_central_taxon_id_get_with_http_info(self, taxon_i
def pull_taxa_update_from_central_taxa_pull_from_central_get(self, **kwargs): # noqa: E501
"""Pull Taxa Update From Central # noqa: E501
- Get what changed in EcoTaxoServer managed tree and update local tree accordingly. # noqa: E501
+ **Returns what changed in EcoTaxoServer managed tree** and update local tree accordingly. i.e. : the number of inserts as nbr_inserts, updates as nbr_updates and errors as errors. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.pull_taxa_update_from_central_taxa_pull_from_central_get(async_req=True)
@@ -328,7 +328,7 @@ def pull_taxa_update_from_central_taxa_pull_from_central_get(self, **kwargs): #
def pull_taxa_update_from_central_taxa_pull_from_central_get_with_http_info(self, **kwargs): # noqa: E501
"""Pull Taxa Update From Central # noqa: E501
- Get what changed in EcoTaxoServer managed tree and update local tree accordingly. # noqa: E501
+ **Returns what changed in EcoTaxoServer managed tree** and update local tree accordingly. i.e. : the number of inserts as nbr_inserts, updates as nbr_updates and errors as errors. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.pull_taxa_update_from_central_taxa_pull_from_central_get_with_http_info(async_req=True)
@@ -409,7 +409,7 @@ def pull_taxa_update_from_central_taxa_pull_from_central_get_with_http_info(self
def push_taxa_stats_in_central_taxa_stats_push_to_central_get(self, **kwargs): # noqa: E501
"""Push Taxa Stats In Central # noqa: E501
- Push present instance stats into EcoTaxoServer. # noqa: E501
+ **Push present instance stats**, into EcoTaxoServer. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.push_taxa_stats_in_central_taxa_stats_push_to_central_get(async_req=True)
@@ -433,7 +433,7 @@ def push_taxa_stats_in_central_taxa_stats_push_to_central_get(self, **kwargs):
def push_taxa_stats_in_central_taxa_stats_push_to_central_get_with_http_info(self, **kwargs): # noqa: E501
"""Push Taxa Stats In Central # noqa: E501
- Push present instance stats into EcoTaxoServer. # noqa: E501
+ **Push present instance stats**, into EcoTaxoServer. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.push_taxa_stats_in_central_taxa_stats_push_to_central_get_with_http_info(async_req=True)
@@ -514,7 +514,7 @@ def push_taxa_stats_in_central_taxa_stats_push_to_central_get_with_http_info(sel
def query_root_taxa_taxa_get(self, **kwargs): # noqa: E501
"""Query Root Taxa # noqa: E501
- Return all taxa with no parent. # noqa: E501
+ **Return all taxa with no parent.** # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.query_root_taxa_taxa_get(async_req=True)
@@ -538,7 +538,7 @@ def query_root_taxa_taxa_get(self, **kwargs): # noqa: E501
def query_root_taxa_taxa_get_with_http_info(self, **kwargs): # noqa: E501
"""Query Root Taxa # noqa: E501
- Return all taxa with no parent. # noqa: E501
+ **Return all taxa with no parent.** # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.query_root_taxa_taxa_get_with_http_info(async_req=True)
@@ -619,14 +619,14 @@ def query_root_taxa_taxa_get_with_http_info(self, **kwargs): # noqa: E501
def query_taxa_set_taxon_set_query_get(self, ids, **kwargs): # noqa: E501
"""Query Taxa Set # noqa: E501
- Information about several taxa, including their lineage. The separator between numbers is arbitrary non-digit, e.g. \":\", \"|\" or \",\" # noqa: E501
+ Returns **information about several taxa**, including their lineage. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.query_taxa_set_taxon_set_query_get(ids, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param str ids: (required)
+ :param str ids: The separator between numbers is arbitrary non-digit, e.g. ':', '|' or ','. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -644,14 +644,14 @@ def query_taxa_set_taxon_set_query_get(self, ids, **kwargs): # noqa: E501
def query_taxa_set_taxon_set_query_get_with_http_info(self, ids, **kwargs): # noqa: E501
"""Query Taxa Set # noqa: E501
- Information about several taxa, including their lineage. The separator between numbers is arbitrary non-digit, e.g. \":\", \"|\" or \",\" # noqa: E501
+ Returns **information about several taxa**, including their lineage. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.query_taxa_set_taxon_set_query_get_with_http_info(ids, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param str ids: (required)
+ :param str ids: The separator between numbers is arbitrary non-digit, e.g. ':', '|' or ','. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -733,14 +733,14 @@ def query_taxa_set_taxon_set_query_get_with_http_info(self, ids, **kwargs): # n
def query_taxa_taxon_taxon_id_get(self, taxon_id, **kwargs): # noqa: E501
"""Query Taxa # noqa: E501
- Information about a single taxon, including its lineage. # noqa: E501
+ Returns **information about the taxon** corresponding to the given id, including its lineage. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.query_taxa_taxon_taxon_id_get(taxon_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int taxon_id: (required)
+ :param int taxon_id: Internal, the unique numeric id of this taxon. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -758,14 +758,14 @@ def query_taxa_taxon_taxon_id_get(self, taxon_id, **kwargs): # noqa: E501
def query_taxa_taxon_taxon_id_get_with_http_info(self, taxon_id, **kwargs): # noqa: E501
"""Query Taxa # noqa: E501
- Information about a single taxon, including its lineage. # noqa: E501
+ Returns **information about the taxon** corresponding to the given id, including its lineage. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.query_taxa_taxon_taxon_id_get_with_http_info(taxon_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int taxon_id: (required)
+ :param int taxon_id: Internal, the unique numeric id of this taxon. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -847,14 +847,14 @@ def query_taxa_taxon_taxon_id_get_with_http_info(self, taxon_id, **kwargs): # n
def query_taxa_usage_taxon_taxon_id_usage_get(self, taxon_id, **kwargs): # noqa: E501
"""Query Taxa Usage # noqa: E501
- Where a given taxon is used. Only validated uses are returned. # noqa: E501
+ **Where a given taxon is used.** Only validated uses are returned. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.query_taxa_usage_taxon_taxon_id_usage_get(taxon_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int taxon_id: (required)
+ :param int taxon_id: Internal, the unique numeric id of this taxon. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -872,14 +872,14 @@ def query_taxa_usage_taxon_taxon_id_usage_get(self, taxon_id, **kwargs): # noqa
def query_taxa_usage_taxon_taxon_id_usage_get_with_http_info(self, taxon_id, **kwargs): # noqa: E501
"""Query Taxa Usage # noqa: E501
- Where a given taxon is used. Only validated uses are returned. # noqa: E501
+ **Where a given taxon is used.** Only validated uses are returned. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.query_taxa_usage_taxon_taxon_id_usage_get_with_http_info(taxon_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int taxon_id: (required)
+ :param int taxon_id: Internal, the unique numeric id of this taxon. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -961,14 +961,14 @@ def query_taxa_usage_taxon_taxon_id_usage_get_with_http_info(self, taxon_id, **k
def reclassif_project_stats_taxa_reclassification_history_project_id_get(self, project_id, **kwargs): # noqa: E501
"""Reclassif Project Stats # noqa: E501
- Dig into reclassification logs and return the associations source->target for previous reclassifications. # noqa: E501
+ Dig into reclassification logs and **return the associations (source → target) for previous reclassifications.** # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.reclassif_project_stats_taxa_reclassification_history_project_id_get(project_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
+ :param int project_id: Internal, numeric id of the project. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -976,7 +976,7 @@ def reclassif_project_stats_taxa_reclassification_history_project_id_get(self, p
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :return: object
+ :return: list[object]
If the method is called asynchronously,
returns the request thread.
"""
@@ -986,14 +986,14 @@ def reclassif_project_stats_taxa_reclassification_history_project_id_get(self, p
def reclassif_project_stats_taxa_reclassification_history_project_id_get_with_http_info(self, project_id, **kwargs): # noqa: E501
"""Reclassif Project Stats # noqa: E501
- Dig into reclassification logs and return the associations source->target for previous reclassifications. # noqa: E501
+ Dig into reclassification logs and **return the associations (source → target) for previous reclassifications.** # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.reclassif_project_stats_taxa_reclassification_history_project_id_get_with_http_info(project_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
+ :param int project_id: Internal, numeric id of the project. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1003,7 +1003,7 @@ def reclassif_project_stats_taxa_reclassification_history_project_id_get_with_ht
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :return: tuple(object, status_code(int), headers(HTTPHeaderDict))
+ :return: tuple(list[object], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
@@ -1064,7 +1064,7 @@ def reclassif_project_stats_taxa_reclassification_history_project_id_get_with_ht
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='object', # noqa: E501
+ response_type='list[object]', # 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
@@ -1075,14 +1075,14 @@ def reclassif_project_stats_taxa_reclassification_history_project_id_get_with_ht
def reclassif_stats_taxa_reclassification_stats_get(self, taxa_ids, **kwargs): # noqa: E501
"""Reclassif Stats # noqa: E501
- Dig into reclassification logs and, for each input category id, determine the most chosen target category, excluding the advised one. By convention, if nothing relevant is found, the input category itself is returned. So one can expect that the returned list has the same size as the required one. # noqa: E501
+ Dig into reclassification logs and, for each input category id, **determine the most chosen target category, excluding the advised one.** By convention, if nothing relevant is found, the input category itself is returned. So one can expect that the returned list has the same size as the required one. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.reclassif_stats_taxa_reclassification_stats_get(taxa_ids, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param str taxa_ids: (required)
+ :param str taxa_ids: String containing the list of one or more taxa id separated by non-num char. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1100,14 +1100,14 @@ def reclassif_stats_taxa_reclassification_stats_get(self, taxa_ids, **kwargs):
def reclassif_stats_taxa_reclassification_stats_get_with_http_info(self, taxa_ids, **kwargs): # noqa: E501
"""Reclassif Stats # noqa: E501
- Dig into reclassification logs and, for each input category id, determine the most chosen target category, excluding the advised one. By convention, if nothing relevant is found, the input category itself is returned. So one can expect that the returned list has the same size as the required one. # noqa: E501
+ Dig into reclassification logs and, for each input category id, **determine the most chosen target category, excluding the advised one.** By convention, if nothing relevant is found, the input category itself is returned. So one can expect that the returned list has the same size as the required one. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.reclassif_stats_taxa_reclassification_stats_get_with_http_info(taxa_ids, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param str taxa_ids: (required)
+ :param str taxa_ids: String containing the list of one or more taxa id separated by non-num char. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1189,15 +1189,15 @@ def reclassif_stats_taxa_reclassification_stats_get_with_http_info(self, taxa_id
def search_taxa_taxon_set_search_get(self, query, **kwargs): # noqa: E501
"""Search Taxa # noqa: E501
- Search for taxa by name. Queries can be 'small', i.e. of length < 3 and even zero-length. For a public, unauthenticated call: - zero-length and small queries always return nothing. - otherwise, a full search is done and results are returned in alphabetical order. Behavior for an authenticated call: - zero-length queries: return the MRU list in full. - small queries: the MRU list is searched, so that taxa in the recent list are returned, if matching. - otherwise, a full search is done. Results are ordered so that taxa in the project list are in first, and are signalled as such in the response. # noqa: E501
+ **Search for taxa by name.** Queries can be 'small', i.e. of length ﹤3 and even zero-length. 🔓 For a public, unauthenticated call : - zero-length and small queries always return nothing. - otherwise, a full search is done and results are returned in alphabetical order. 🔒 For an authenticated call : - zero-length queries: return the MRU list in full. - small queries: the MRU list is searched, so that taxa in the recent list are returned, if matching. - otherwise, a full search is done. Results are ordered so that taxa in the project list are in first, and are signalled as such in the response. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.search_taxa_taxon_set_search_get(query, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param str query: (required)
- :param int project_id:
+ :param str query: Use this query for matching returned taxa names. (required)
+ :param int project_id: Internal, numeric id of the project.
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1215,15 +1215,15 @@ def search_taxa_taxon_set_search_get(self, query, **kwargs): # noqa: E501
def search_taxa_taxon_set_search_get_with_http_info(self, query, **kwargs): # noqa: E501
"""Search Taxa # noqa: E501
- Search for taxa by name. Queries can be 'small', i.e. of length < 3 and even zero-length. For a public, unauthenticated call: - zero-length and small queries always return nothing. - otherwise, a full search is done and results are returned in alphabetical order. Behavior for an authenticated call: - zero-length queries: return the MRU list in full. - small queries: the MRU list is searched, so that taxa in the recent list are returned, if matching. - otherwise, a full search is done. Results are ordered so that taxa in the project list are in first, and are signalled as such in the response. # noqa: E501
+ **Search for taxa by name.** Queries can be 'small', i.e. of length ﹤3 and even zero-length. 🔓 For a public, unauthenticated call : - zero-length and small queries always return nothing. - otherwise, a full search is done and results are returned in alphabetical order. 🔒 For an authenticated call : - zero-length queries: return the MRU list in full. - small queries: the MRU list is searched, so that taxa in the recent list are returned, if matching. - otherwise, a full search is done. Results are ordered so that taxa in the project list are in first, and are signalled as such in the response. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.search_taxa_taxon_set_search_get_with_http_info(query, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param str query: (required)
- :param int project_id:
+ :param str query: Use this query for matching returned taxa names. (required)
+ :param int project_id: Internal, numeric id of the project.
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1308,7 +1308,7 @@ def search_taxa_taxon_set_search_get_with_http_info(self, query, **kwargs): # n
def taxa_tree_status_taxa_status_get(self, **kwargs): # noqa: E501
"""Taxa Tree Status # noqa: E501
- Return the status of taxonomy tree w/r to freshness. # noqa: E501
+ **Return the status of taxonomy tree** w/r to freshness. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.taxa_tree_status_taxa_status_get(async_req=True)
@@ -1332,7 +1332,7 @@ def taxa_tree_status_taxa_status_get(self, **kwargs): # noqa: E501
def taxa_tree_status_taxa_status_get_with_http_info(self, **kwargs): # noqa: E501
"""Taxa Tree Status # noqa: E501
- Return the status of taxonomy tree w/r to freshness. # noqa: E501
+ **Return the status of taxonomy tree** w/r to freshness. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.taxa_tree_status_taxa_status_get_with_http_info(async_req=True)
diff --git a/to_back/ecotaxa_cli_py/api/users_api.py b/to_back/ecotaxa_cli_py/api/users_api.py
index 08f30a18..406cb365 100644
--- a/to_back/ecotaxa_cli_py/api/users_api.py
+++ b/to_back/ecotaxa_cli_py/api/users_api.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -39,15 +39,15 @@ def __init__(self, api_client=None):
def get_current_user_prefs_users_my_preferences_project_id_get(self, project_id, key, **kwargs): # noqa: E501
"""Get Current User Prefs # noqa: E501
- Return one preference, for project and currently authenticated user. # noqa: E501
+ **Returns one preference**, for a project and the currently authenticated user. Available keys are **cwd**, **img_import** and **filters**. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_current_user_prefs_users_my_preferences_project_id_get(project_id, key, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
- :param str key: (required)
+ :param int project_id: Internal, numeric id of the project. (required)
+ :param str key: The preference key, as text. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -65,15 +65,15 @@ def get_current_user_prefs_users_my_preferences_project_id_get(self, project_id,
def get_current_user_prefs_users_my_preferences_project_id_get_with_http_info(self, project_id, key, **kwargs): # noqa: E501
"""Get Current User Prefs # noqa: E501
- Return one preference, for project and currently authenticated user. # noqa: E501
+ **Returns one preference**, for a project and the currently authenticated user. Available keys are **cwd**, **img_import** and **filters**. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_current_user_prefs_users_my_preferences_project_id_get_with_http_info(project_id, key, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
- :param str key: (required)
+ :param int project_id: Internal, numeric id of the project. (required)
+ :param str key: The preference key, as text. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -162,14 +162,14 @@ def get_current_user_prefs_users_my_preferences_project_id_get_with_http_info(se
def get_user_users_user_id_get(self, user_id, **kwargs): # noqa: E501
"""Get User # noqa: E501
- Return a single user by its id. # noqa: E501
+ Returns **information about the user** corresponding to the given id. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_user_users_user_id_get(user_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int user_id: (required)
+ :param int user_id: Internal, the unique numeric id of this user. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -187,14 +187,14 @@ def get_user_users_user_id_get(self, user_id, **kwargs): # noqa: E501
def get_user_users_user_id_get_with_http_info(self, user_id, **kwargs): # noqa: E501
"""Get User # noqa: E501
- Return a single user by its id. # noqa: E501
+ Returns **information about the user** corresponding to the given id. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_user_users_user_id_get_with_http_info(user_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int user_id: (required)
+ :param int user_id: Internal, the unique numeric id of this user. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -276,7 +276,7 @@ def get_user_users_user_id_get_with_http_info(self, user_id, **kwargs): # noqa:
def get_users_users_get(self, **kwargs): # noqa: E501
"""Get Users # noqa: E501
- Return the list of users. For admins only. # noqa: E501
+ Returns the list of **all users** with their information. 🔒 *For admins only.* # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_users_users_get(async_req=True)
@@ -300,7 +300,7 @@ def get_users_users_get(self, **kwargs): # noqa: E501
def get_users_users_get_with_http_info(self, **kwargs): # noqa: E501
"""Get Users # noqa: E501
- Return the list of users. For admins only. # noqa: E501
+ Returns the list of **all users** with their information. 🔒 *For admins only.* # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_users_users_get_with_http_info(async_req=True)
@@ -381,14 +381,14 @@ def get_users_users_get_with_http_info(self, **kwargs): # noqa: E501
def search_user_users_search_get(self, **kwargs): # noqa: E501
"""Search User # noqa: E501
- Search users using various criteria, search is case insensitive and might contain % chars. # noqa: E501
+ **Search users using various criteria**, search is case insensitive and might contain % chars. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.search_user_users_search_get(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param str by_name:
+ :param str by_name: Search by name, use % for searching with 'any char'.
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -406,14 +406,14 @@ def search_user_users_search_get(self, **kwargs): # noqa: E501
def search_user_users_search_get_with_http_info(self, **kwargs): # noqa: E501
"""Search User # noqa: E501
- Search users using various criteria, search is case insensitive and might contain % chars. # noqa: E501
+ **Search users using various criteria**, search is case insensitive and might contain % chars. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.search_user_users_search_get_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param str by_name:
+ :param str by_name: Search by name, use % for searching with 'any char'.
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -491,16 +491,16 @@ def search_user_users_search_get_with_http_info(self, **kwargs): # noqa: E501
def set_current_user_prefs_users_my_preferences_project_id_put(self, project_id, key, value, **kwargs): # noqa: E501
"""Set Current User Prefs # noqa: E501
- Set one preference, for project and currently authenticated user. -`key`: The preference key -`value`: The value to set this preference to. # noqa: E501
+ **Sets one preference**, for a project and for the currently authenticated user. Available keys are **cwd**, **img_import** and **filters**. The key disappears if set to empty string. **Returns NULL upon success.** # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.set_current_user_prefs_users_my_preferences_project_id_put(project_id, key, value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
- :param str key: (required)
- :param str value: (required)
+ :param int project_id: Internal, numeric id of the project. (required)
+ :param str key: The preference key, as text. (required)
+ :param str value: The value to set this preference to, as text. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -518,16 +518,16 @@ def set_current_user_prefs_users_my_preferences_project_id_put(self, project_id,
def set_current_user_prefs_users_my_preferences_project_id_put_with_http_info(self, project_id, key, value, **kwargs): # noqa: E501
"""Set Current User Prefs # noqa: E501
- Set one preference, for project and currently authenticated user. -`key`: The preference key -`value`: The value to set this preference to. # noqa: E501
+ **Sets one preference**, for a project and for the currently authenticated user. Available keys are **cwd**, **img_import** and **filters**. The key disappears if set to empty string. **Returns NULL upon success.** # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.set_current_user_prefs_users_my_preferences_project_id_put_with_http_info(project_id, key, value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
- :param int project_id: (required)
- :param str key: (required)
- :param str value: (required)
+ :param int project_id: Internal, numeric id of the project. (required)
+ :param str key: The preference key, as text. (required)
+ :param str value: The value to set this preference to, as text. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -623,7 +623,7 @@ def set_current_user_prefs_users_my_preferences_project_id_put_with_http_info(se
def show_current_user_users_me_get(self, **kwargs): # noqa: E501
"""Show Current User # noqa: E501
- Return currently authenticated user. On top of DB fields, 'can_do' lists the allowed system-wide actions: CREATE_PROJECT = 1 ADMINISTRATE_APP = 2 ADMINISTRATE_USERS = 3 CREATE_TAXON = 4 # noqa: E501
+ Returns **currently authenticated user's** (i.e. you) information, permissions and last used projects. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_current_user_users_me_get(async_req=True)
@@ -647,7 +647,7 @@ def show_current_user_users_me_get(self, **kwargs): # noqa: E501
def show_current_user_users_me_get_with_http_info(self, **kwargs): # noqa: E501
"""Show Current User # noqa: E501
- Return currently authenticated user. On top of DB fields, 'can_do' lists the allowed system-wide actions: CREATE_PROJECT = 1 ADMINISTRATE_APP = 2 ADMINISTRATE_USERS = 3 CREATE_TAXON = 4 # noqa: E501
+ Returns **currently authenticated user's** (i.e. you) information, permissions and last used projects. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_current_user_users_me_get_with_http_info(async_req=True)
diff --git a/to_back/ecotaxa_cli_py/api/wip_api.py b/to_back/ecotaxa_cli_py/api/wip_api.py
index 0c6eb18d..0cf86ac7 100644
--- a/to_back/ecotaxa_cli_py/api/wip_api.py
+++ b/to_back/ecotaxa_cli_py/api/wip_api.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -39,7 +39,7 @@ def __init__(self, api_client=None):
def system_status_status_get(self, **kwargs): # noqa: E501
"""System Status # noqa: E501
- Report the status, mainly used for verifying that the server is up. # noqa: E501
+ **Report the status**, mainly used for verifying that the server is up. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.system_status_status_get(async_req=True)
@@ -63,7 +63,7 @@ def system_status_status_get(self, **kwargs): # noqa: E501
def system_status_status_get_with_http_info(self, **kwargs): # noqa: E501
"""System Status # noqa: E501
- Report the status, mainly used for verifying that the server is up. # noqa: E501
+ **Report the status**, mainly used for verifying that the server is up. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.system_status_status_get_with_http_info(async_req=True)
diff --git a/to_back/ecotaxa_cli_py/api_client.py b/to_back/ecotaxa_cli_py/api_client.py
index 28ec00a0..99eff1ec 100644
--- a/to_back/ecotaxa_cli_py/api_client.py
+++ b/to_back/ecotaxa_cli_py/api_client.py
@@ -4,7 +4,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
diff --git a/to_back/ecotaxa_cli_py/configuration.py b/to_back/ecotaxa_cli_py/configuration.py
index 8428f5f9..cba29e81 100644
--- a/to_back/ecotaxa_cli_py/configuration.py
+++ b/to_back/ecotaxa_cli_py/configuration.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -335,7 +335,7 @@ def to_debug_report(self):
return "Python SDK Debug Report:\n"\
"OS: {env}\n"\
"Python Version: {pyversion}\n"\
- "Version of the API: 0.0.17\n"\
+ "Version of the API: 0.0.23\n"\
"SDK Package Version: 1.0.0".\
format(env=sys.platform, pyversion=sys.version)
diff --git a/to_back/ecotaxa_cli_py/exceptions.py b/to_back/ecotaxa_cli_py/exceptions.py
index 67fb77ad..962a2fea 100644
--- a/to_back/ecotaxa_cli_py/exceptions.py
+++ b/to_back/ecotaxa_cli_py/exceptions.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
diff --git a/to_back/ecotaxa_cli_py/models/__init__.py b/to_back/ecotaxa_cli_py/models/__init__.py
index 82881900..35ba007e 100644
--- a/to_back/ecotaxa_cli_py/models/__init__.py
+++ b/to_back/ecotaxa_cli_py/models/__init__.py
@@ -6,7 +6,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -16,6 +16,7 @@
# import models into model package
from to_back.ecotaxa_cli_py.models.acquisition_model import AcquisitionModel
from to_back.ecotaxa_cli_py.models.body_export_object_set_object_set_export_post import BodyExportObjectSetObjectSetExportPost
+from to_back.ecotaxa_cli_py.models.body_predict_object_set_object_set_predict_post import BodyPredictObjectSetObjectSetPredictPost
from to_back.ecotaxa_cli_py.models.body_put_user_file_my_files_post import BodyPutUserFileMyFilesPost
from to_back.ecotaxa_cli_py.models.bulk_update_req import BulkUpdateReq
from to_back.ecotaxa_cli_py.models.classify_auto_req import ClassifyAutoReq
@@ -47,9 +48,12 @@
from to_back.ecotaxa_cli_py.models.object_set_query_rsp import ObjectSetQueryRsp
from to_back.ecotaxa_cli_py.models.object_set_revert_to_history_rsp import ObjectSetRevertToHistoryRsp
from to_back.ecotaxa_cli_py.models.object_set_summary_rsp import ObjectSetSummaryRsp
+from to_back.ecotaxa_cli_py.models.prediction_req import PredictionReq
+from to_back.ecotaxa_cli_py.models.prediction_rsp import PredictionRsp
from to_back.ecotaxa_cli_py.models.process_model import ProcessModel
from to_back.ecotaxa_cli_py.models.project_filters import ProjectFilters
from to_back.ecotaxa_cli_py.models.project_model import ProjectModel
+from to_back.ecotaxa_cli_py.models.project_set_column_stats_model import ProjectSetColumnStatsModel
from to_back.ecotaxa_cli_py.models.project_summary_model import ProjectSummaryModel
from to_back.ecotaxa_cli_py.models.project_taxo_stats_model import ProjectTaxoStatsModel
from to_back.ecotaxa_cli_py.models.project_user_stats_model import ProjectUserStatsModel
@@ -60,6 +64,7 @@
from to_back.ecotaxa_cli_py.models.subset_req import SubsetReq
from to_back.ecotaxa_cli_py.models.subset_rsp import SubsetRsp
from to_back.ecotaxa_cli_py.models.taxa_search_rsp import TaxaSearchRsp
+from to_back.ecotaxa_cli_py.models.taxon_central import TaxonCentral
from to_back.ecotaxa_cli_py.models.taxon_model import TaxonModel
from to_back.ecotaxa_cli_py.models.taxon_usage_model import TaxonUsageModel
from to_back.ecotaxa_cli_py.models.taxonomy_tree_status import TaxonomyTreeStatus
diff --git a/to_back/ecotaxa_cli_py/models/acquisition_model.py b/to_back/ecotaxa_cli_py/models/acquisition_model.py
index bea3cc83..76ebb7c4 100644
--- a/to_back/ecotaxa_cli_py/models/acquisition_model.py
+++ b/to_back/ecotaxa_cli_py/models/acquisition_model.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -61,8 +61,7 @@ def __init__(self, acquisid=None, acq_sample_id=None, orig_id=None, instrument=N
self._free_columns = None
self.discriminator = None
- if acquisid is not None:
- self.acquisid = acquisid
+ self.acquisid = acquisid
self.acq_sample_id = acq_sample_id
self.orig_id = orig_id
if instrument is not None:
@@ -74,6 +73,7 @@ def __init__(self, acquisid=None, acq_sample_id=None, orig_id=None, instrument=N
def acquisid(self):
"""Gets the acquisid of this AcquisitionModel. # noqa: E501
+ The acquisition Id. # noqa: E501
:return: The acquisid of this AcquisitionModel. # noqa: E501
:rtype: int
@@ -84,10 +84,13 @@ def acquisid(self):
def acquisid(self, acquisid):
"""Sets the acquisid of this AcquisitionModel.
+ The acquisition Id. # noqa: E501
:param acquisid: The acquisid of this AcquisitionModel. # noqa: E501
:type: int
"""
+ if self.local_vars_configuration.client_side_validation and acquisid is None: # noqa: E501
+ raise ValueError("Invalid value for `acquisid`, must not be `None`") # noqa: E501
self._acquisid = acquisid
@@ -95,6 +98,7 @@ def acquisid(self, acquisid):
def acq_sample_id(self):
"""Gets the acq_sample_id of this AcquisitionModel. # noqa: E501
+ The acquisition sample Id. # noqa: E501
:return: The acq_sample_id of this AcquisitionModel. # noqa: E501
:rtype: int
@@ -105,6 +109,7 @@ def acq_sample_id(self):
def acq_sample_id(self, acq_sample_id):
"""Sets the acq_sample_id of this AcquisitionModel.
+ The acquisition sample Id. # noqa: E501
:param acq_sample_id: The acq_sample_id of this AcquisitionModel. # noqa: E501
:type: int
@@ -118,6 +123,7 @@ def acq_sample_id(self, acq_sample_id):
def orig_id(self):
"""Gets the orig_id of this AcquisitionModel. # noqa: E501
+ Original acquisition ID from initial TSV load. # noqa: E501
:return: The orig_id of this AcquisitionModel. # noqa: E501
:rtype: str
@@ -128,6 +134,7 @@ def orig_id(self):
def orig_id(self, orig_id):
"""Sets the orig_id of this AcquisitionModel.
+ Original acquisition ID from initial TSV load. # noqa: E501
:param orig_id: The orig_id of this AcquisitionModel. # noqa: E501
:type: str
@@ -141,6 +148,7 @@ def orig_id(self, orig_id):
def instrument(self):
"""Gets the instrument of this AcquisitionModel. # noqa: E501
+ Instrument used. # noqa: E501
:return: The instrument of this AcquisitionModel. # noqa: E501
:rtype: str
@@ -151,6 +159,7 @@ def instrument(self):
def instrument(self, instrument):
"""Sets the instrument of this AcquisitionModel.
+ Instrument used. # noqa: E501
:param instrument: The instrument of this AcquisitionModel. # noqa: E501
:type: str
@@ -162,6 +171,7 @@ def instrument(self, instrument):
def free_columns(self):
"""Gets the free_columns of this AcquisitionModel. # noqa: E501
+ Free columns from acquisition mapping in project. # noqa: E501
:return: The free_columns of this AcquisitionModel. # noqa: E501
:rtype: object
@@ -172,6 +182,7 @@ def free_columns(self):
def free_columns(self, free_columns):
"""Sets the free_columns of this AcquisitionModel.
+ Free columns from acquisition mapping in project. # noqa: E501
:param free_columns: The free_columns of this AcquisitionModel. # noqa: E501
:type: object
diff --git a/to_back/ecotaxa_cli_py/models/body_export_object_set_object_set_export_post.py b/to_back/ecotaxa_cli_py/models/body_export_object_set_object_set_export_post.py
index 68d1f4d1..1357b90a 100644
--- a/to_back/ecotaxa_cli_py/models/body_export_object_set_object_set_export_post.py
+++ b/to_back/ecotaxa_cli_py/models/body_export_object_set_object_set_export_post.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
diff --git a/to_back/ecotaxa_cli_py/models/body_predict_object_set_object_set_predict_post.py b/to_back/ecotaxa_cli_py/models/body_predict_object_set_object_set_predict_post.py
new file mode 100644
index 00000000..214cb399
--- /dev/null
+++ b/to_back/ecotaxa_cli_py/models/body_predict_object_set_object_set_predict_post.py
@@ -0,0 +1,148 @@
+# coding: utf-8
+
+"""
+ EcoTaxa
+
+ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
+
+ The version of the OpenAPI document: 0.0.23
+ Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from to_back.ecotaxa_cli_py.configuration import Configuration
+
+
+class BodyPredictObjectSetObjectSetPredictPost(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 = {
+ 'filters': 'ProjectFilters',
+ 'request': 'PredictionReq'
+ }
+
+ attribute_map = {
+ 'filters': 'filters',
+ 'request': 'request'
+ }
+
+ def __init__(self, filters=None, request=None, local_vars_configuration=None): # noqa: E501
+ """BodyPredictObjectSetObjectSetPredictPost - a model defined in OpenAPI""" # noqa: E501
+ if local_vars_configuration is None:
+ local_vars_configuration = Configuration()
+ self.local_vars_configuration = local_vars_configuration
+
+ self._filters = None
+ self._request = None
+ self.discriminator = None
+
+ self.filters = filters
+ self.request = request
+
+ @property
+ def filters(self):
+ """Gets the filters of this BodyPredictObjectSetObjectSetPredictPost. # noqa: E501
+
+
+ :return: The filters of this BodyPredictObjectSetObjectSetPredictPost. # noqa: E501
+ :rtype: ProjectFilters
+ """
+ return self._filters
+
+ @filters.setter
+ def filters(self, filters):
+ """Sets the filters of this BodyPredictObjectSetObjectSetPredictPost.
+
+
+ :param filters: The filters of this BodyPredictObjectSetObjectSetPredictPost. # noqa: E501
+ :type: ProjectFilters
+ """
+ if self.local_vars_configuration.client_side_validation and filters is None: # noqa: E501
+ raise ValueError("Invalid value for `filters`, must not be `None`") # noqa: E501
+
+ self._filters = filters
+
+ @property
+ def request(self):
+ """Gets the request of this BodyPredictObjectSetObjectSetPredictPost. # noqa: E501
+
+
+ :return: The request of this BodyPredictObjectSetObjectSetPredictPost. # noqa: E501
+ :rtype: PredictionReq
+ """
+ return self._request
+
+ @request.setter
+ def request(self, request):
+ """Sets the request of this BodyPredictObjectSetObjectSetPredictPost.
+
+
+ :param request: The request of this BodyPredictObjectSetObjectSetPredictPost. # noqa: E501
+ :type: PredictionReq
+ """
+ if self.local_vars_configuration.client_side_validation and request is None: # noqa: E501
+ raise ValueError("Invalid value for `request`, must not be `None`") # noqa: E501
+
+ self._request = request
+
+ 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, BodyPredictObjectSetObjectSetPredictPost):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, BodyPredictObjectSetObjectSetPredictPost):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/to_back/ecotaxa_cli_py/models/body_put_user_file_my_files_post.py b/to_back/ecotaxa_cli_py/models/body_put_user_file_my_files_post.py
index 3c77e50b..4584e59d 100644
--- a/to_back/ecotaxa_cli_py/models/body_put_user_file_my_files_post.py
+++ b/to_back/ecotaxa_cli_py/models/body_put_user_file_my_files_post.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -88,6 +88,7 @@ def file(self, file):
def path(self):
"""Gets the path of this BodyPutUserFileMyFilesPost. # noqa: E501
+ The client-side full path of the file. # noqa: E501
:return: The path of this BodyPutUserFileMyFilesPost. # noqa: E501
:rtype: str
@@ -98,6 +99,7 @@ def path(self):
def path(self, path):
"""Sets the path of this BodyPutUserFileMyFilesPost.
+ The client-side full path of the file. # noqa: E501
:param path: The path of this BodyPutUserFileMyFilesPost. # noqa: E501
:type: str
@@ -109,6 +111,7 @@ def path(self, path):
def tag(self):
"""Gets the tag of this BodyPutUserFileMyFilesPost. # noqa: E501
+ If a tag is provided, then all files with the same tag are grouped (in a sub-directory). Otherwise, a temp directory with only this file will be created. # noqa: E501
:return: The tag of this BodyPutUserFileMyFilesPost. # noqa: E501
:rtype: str
@@ -119,6 +122,7 @@ def tag(self):
def tag(self, tag):
"""Sets the tag of this BodyPutUserFileMyFilesPost.
+ If a tag is provided, then all files with the same tag are grouped (in a sub-directory). Otherwise, a temp directory with only this file will be created. # noqa: E501
:param tag: The tag of this BodyPutUserFileMyFilesPost. # noqa: E501
:type: str
diff --git a/to_back/ecotaxa_cli_py/models/bulk_update_req.py b/to_back/ecotaxa_cli_py/models/bulk_update_req.py
index 2314cf10..fbcd3f36 100644
--- a/to_back/ecotaxa_cli_py/models/bulk_update_req.py
+++ b/to_back/ecotaxa_cli_py/models/bulk_update_req.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -59,6 +59,7 @@ def __init__(self, target_ids=None, updates=None, local_vars_configuration=None)
def target_ids(self):
"""Gets the target_ids of this BulkUpdateReq. # noqa: E501
+ The IDs of the target entities. # noqa: E501
:return: The target_ids of this BulkUpdateReq. # noqa: E501
:rtype: list[int]
@@ -69,6 +70,7 @@ def target_ids(self):
def target_ids(self, target_ids):
"""Sets the target_ids of this BulkUpdateReq.
+ The IDs of the target entities. # noqa: E501
:param target_ids: The target_ids of this BulkUpdateReq. # noqa: E501
:type: list[int]
@@ -82,6 +84,7 @@ def target_ids(self, target_ids):
def updates(self):
"""Gets the updates of this BulkUpdateReq. # noqa: E501
+ The list of updates, to do on all impacted entities. { ucol : A column name, pseudo-columns AKA free ones, are OK. uval : The new value to set, always as a string } # noqa: E501
:return: The updates of this BulkUpdateReq. # noqa: E501
:rtype: list[object]
@@ -92,6 +95,7 @@ def updates(self):
def updates(self, updates):
"""Sets the updates of this BulkUpdateReq.
+ The list of updates, to do on all impacted entities. { ucol : A column name, pseudo-columns AKA free ones, are OK. uval : The new value to set, always as a string } # noqa: E501
:param updates: The updates of this BulkUpdateReq. # noqa: E501
:type: list[object]
diff --git a/to_back/ecotaxa_cli_py/models/classify_auto_req.py b/to_back/ecotaxa_cli_py/models/classify_auto_req.py
index 005a3091..24e84784 100644
--- a/to_back/ecotaxa_cli_py/models/classify_auto_req.py
+++ b/to_back/ecotaxa_cli_py/models/classify_auto_req.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -67,6 +67,7 @@ def __init__(self, target_ids=None, classifications=None, scores=None, keep_log=
def target_ids(self):
"""Gets the target_ids of this ClassifyAutoReq. # noqa: E501
+ The IDs of the target objects. # noqa: E501
:return: The target_ids of this ClassifyAutoReq. # noqa: E501
:rtype: list[int]
@@ -77,6 +78,7 @@ def target_ids(self):
def target_ids(self, target_ids):
"""Sets the target_ids of this ClassifyAutoReq.
+ The IDs of the target objects. # noqa: E501
:param target_ids: The target_ids of this ClassifyAutoReq. # noqa: E501
:type: list[int]
@@ -90,6 +92,7 @@ def target_ids(self, target_ids):
def classifications(self):
"""Gets the classifications of this ClassifyAutoReq. # noqa: E501
+ The wanted new classifications, i.e. taxon ID, one for each object. # noqa: E501
:return: The classifications of this ClassifyAutoReq. # noqa: E501
:rtype: list[int]
@@ -100,6 +103,7 @@ def classifications(self):
def classifications(self, classifications):
"""Sets the classifications of this ClassifyAutoReq.
+ The wanted new classifications, i.e. taxon ID, one for each object. # noqa: E501
:param classifications: The classifications of this ClassifyAutoReq. # noqa: E501
:type: list[int]
@@ -113,6 +117,7 @@ def classifications(self, classifications):
def scores(self):
"""Gets the scores of this ClassifyAutoReq. # noqa: E501
+ The classification score is generally between 0 and 1. It indicates the probability that the taxon prediction of this object is correct. # noqa: E501
:return: The scores of this ClassifyAutoReq. # noqa: E501
:rtype: list[float]
@@ -123,6 +128,7 @@ def scores(self):
def scores(self, scores):
"""Sets the scores of this ClassifyAutoReq.
+ The classification score is generally between 0 and 1. It indicates the probability that the taxon prediction of this object is correct. # noqa: E501
:param scores: The scores of this ClassifyAutoReq. # noqa: E501
:type: list[float]
@@ -136,6 +142,7 @@ def scores(self, scores):
def keep_log(self):
"""Gets the keep_log of this ClassifyAutoReq. # noqa: E501
+ Set if former automatic classification history is needed. # noqa: E501
:return: The keep_log of this ClassifyAutoReq. # noqa: E501
:rtype: bool
@@ -146,6 +153,7 @@ def keep_log(self):
def keep_log(self, keep_log):
"""Sets the keep_log of this ClassifyAutoReq.
+ Set if former automatic classification history is needed. # noqa: E501
:param keep_log: The keep_log of this ClassifyAutoReq. # noqa: E501
:type: bool
diff --git a/to_back/ecotaxa_cli_py/models/classify_req.py b/to_back/ecotaxa_cli_py/models/classify_req.py
index 2be51b73..a71d6025 100644
--- a/to_back/ecotaxa_cli_py/models/classify_req.py
+++ b/to_back/ecotaxa_cli_py/models/classify_req.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -63,6 +63,7 @@ def __init__(self, target_ids=None, classifications=None, wanted_qualification=N
def target_ids(self):
"""Gets the target_ids of this ClassifyReq. # noqa: E501
+ The IDs of the target objects. # noqa: E501
:return: The target_ids of this ClassifyReq. # noqa: E501
:rtype: list[int]
@@ -73,6 +74,7 @@ def target_ids(self):
def target_ids(self, target_ids):
"""Sets the target_ids of this ClassifyReq.
+ The IDs of the target objects. # noqa: E501
:param target_ids: The target_ids of this ClassifyReq. # noqa: E501
:type: list[int]
@@ -86,6 +88,7 @@ def target_ids(self, target_ids):
def classifications(self):
"""Gets the classifications of this ClassifyReq. # noqa: E501
+ The wanted new classifications, i.e. taxon ID, one for each object. Use -1 to keep present one. # noqa: E501
:return: The classifications of this ClassifyReq. # noqa: E501
:rtype: list[int]
@@ -96,6 +99,7 @@ def classifications(self):
def classifications(self, classifications):
"""Sets the classifications of this ClassifyReq.
+ The wanted new classifications, i.e. taxon ID, one for each object. Use -1 to keep present one. # noqa: E501
:param classifications: The classifications of this ClassifyReq. # noqa: E501
:type: list[int]
@@ -109,6 +113,7 @@ def classifications(self, classifications):
def wanted_qualification(self):
"""Gets the wanted_qualification of this ClassifyReq. # noqa: E501
+ The wanted qualifications for all objects. 'V' or 'P'. # noqa: E501
:return: The wanted_qualification of this ClassifyReq. # noqa: E501
:rtype: str
@@ -119,6 +124,7 @@ def wanted_qualification(self):
def wanted_qualification(self, wanted_qualification):
"""Sets the wanted_qualification of this ClassifyReq.
+ The wanted qualifications for all objects. 'V' or 'P'. # noqa: E501
:param wanted_qualification: The wanted_qualification of this ClassifyReq. # noqa: E501
:type: str
diff --git a/to_back/ecotaxa_cli_py/models/collection_model.py b/to_back/ecotaxa_cli_py/models/collection_model.py
index 959b5c5c..eab77982 100644
--- a/to_back/ecotaxa_cli_py/models/collection_model.py
+++ b/to_back/ecotaxa_cli_py/models/collection_model.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -107,8 +107,7 @@ def __init__(self, project_ids=None, provider_user=None, contact_user=None, crea
self.associate_users = associate_users
if associate_organisations is not None:
self.associate_organisations = associate_organisations
- if id is not None:
- self.id = id
+ self.id = id
self.external_id = external_id
self.external_id_system = external_id_system
self.title = title
@@ -127,6 +126,7 @@ def __init__(self, project_ids=None, provider_user=None, contact_user=None, crea
def project_ids(self):
"""Gets the project_ids of this CollectionModel. # noqa: E501
+ The list of composing project IDs. # noqa: E501
:return: The project_ids of this CollectionModel. # noqa: E501
:rtype: list[int]
@@ -137,6 +137,7 @@ def project_ids(self):
def project_ids(self, project_ids):
"""Sets the project_ids of this CollectionModel.
+ The list of composing project IDs. # noqa: E501
:param project_ids: The project_ids of this CollectionModel. # noqa: E501
:type: list[int]
@@ -150,6 +151,7 @@ def project_ids(self, project_ids):
def provider_user(self):
"""Gets the provider_user of this CollectionModel. # noqa: E501
+ Is the person who is responsible for the content of this metadata record. Writer of the title and abstract. # noqa: E501
:return: The provider_user of this CollectionModel. # noqa: E501
:rtype: UserModel
@@ -160,6 +162,7 @@ def provider_user(self):
def provider_user(self, provider_user):
"""Sets the provider_user of this CollectionModel.
+ Is the person who is responsible for the content of this metadata record. Writer of the title and abstract. # noqa: E501
:param provider_user: The provider_user of this CollectionModel. # noqa: E501
:type: UserModel
@@ -171,6 +174,7 @@ def provider_user(self, provider_user):
def contact_user(self):
"""Gets the contact_user of this CollectionModel. # noqa: E501
+ Is the person who should be contacted in cases of questions regarding the content of the dataset or any data restrictions. This is also the person who is most likely to stay involved in the dataset the longest. # noqa: E501
:return: The contact_user of this CollectionModel. # noqa: E501
:rtype: UserModel
@@ -181,6 +185,7 @@ def contact_user(self):
def contact_user(self, contact_user):
"""Sets the contact_user of this CollectionModel.
+ Is the person who should be contacted in cases of questions regarding the content of the dataset or any data restrictions. This is also the person who is most likely to stay involved in the dataset the longest. # noqa: E501
:param contact_user: The contact_user of this CollectionModel. # noqa: E501
:type: UserModel
@@ -192,6 +197,7 @@ def contact_user(self, contact_user):
def creator_users(self):
"""Gets the creator_users of this CollectionModel. # noqa: E501
+ All people who are responsible for the creation of the collection. Data creators should receive credit for their work and should therefore be included in the citation. # noqa: E501
:return: The creator_users of this CollectionModel. # noqa: E501
:rtype: list[UserModel]
@@ -202,6 +208,7 @@ def creator_users(self):
def creator_users(self, creator_users):
"""Sets the creator_users of this CollectionModel.
+ All people who are responsible for the creation of the collection. Data creators should receive credit for their work and should therefore be included in the citation. # noqa: E501
:param creator_users: The creator_users of this CollectionModel. # noqa: E501
:type: list[UserModel]
@@ -213,6 +220,7 @@ def creator_users(self, creator_users):
def creator_organisations(self):
"""Gets the creator_organisations of this CollectionModel. # noqa: E501
+ All organisations who are responsible for the creation of the collection. Data creators should receive credit for their work and should therefore be included in the citation. # noqa: E501
:return: The creator_organisations of this CollectionModel. # noqa: E501
:rtype: list[str]
@@ -223,6 +231,7 @@ def creator_organisations(self):
def creator_organisations(self, creator_organisations):
"""Sets the creator_organisations of this CollectionModel.
+ All organisations who are responsible for the creation of the collection. Data creators should receive credit for their work and should therefore be included in the citation. # noqa: E501
:param creator_organisations: The creator_organisations of this CollectionModel. # noqa: E501
:type: list[str]
@@ -234,6 +243,7 @@ def creator_organisations(self, creator_organisations):
def associate_users(self):
"""Gets the associate_users of this CollectionModel. # noqa: E501
+ Other person(s) associated with the collection. # noqa: E501
:return: The associate_users of this CollectionModel. # noqa: E501
:rtype: list[UserModel]
@@ -244,6 +254,7 @@ def associate_users(self):
def associate_users(self, associate_users):
"""Sets the associate_users of this CollectionModel.
+ Other person(s) associated with the collection. # noqa: E501
:param associate_users: The associate_users of this CollectionModel. # noqa: E501
:type: list[UserModel]
@@ -255,6 +266,7 @@ def associate_users(self, associate_users):
def associate_organisations(self):
"""Gets the associate_organisations of this CollectionModel. # noqa: E501
+ Other organisation(s) associated with the collection. # noqa: E501
:return: The associate_organisations of this CollectionModel. # noqa: E501
:rtype: list[str]
@@ -265,6 +277,7 @@ def associate_organisations(self):
def associate_organisations(self, associate_organisations):
"""Sets the associate_organisations of this CollectionModel.
+ Other organisation(s) associated with the collection. # noqa: E501
:param associate_organisations: The associate_organisations of this CollectionModel. # noqa: E501
:type: list[str]
@@ -276,6 +289,7 @@ def associate_organisations(self, associate_organisations):
def id(self):
"""Gets the id of this CollectionModel. # noqa: E501
+ The collection Id. # noqa: E501
:return: The id of this CollectionModel. # noqa: E501
:rtype: int
@@ -286,10 +300,13 @@ def id(self):
def id(self, id):
"""Sets the id of this CollectionModel.
+ The collection Id. # noqa: E501
:param id: The id of this CollectionModel. # noqa: E501
:type: int
"""
+ if self.local_vars_configuration.client_side_validation and id is None: # noqa: E501
+ raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501
self._id = id
@@ -297,6 +314,7 @@ def id(self, id):
def external_id(self):
"""Gets the external_id of this CollectionModel. # noqa: E501
+ The external Id. # noqa: E501
:return: The external_id of this CollectionModel. # noqa: E501
:rtype: str
@@ -307,6 +325,7 @@ def external_id(self):
def external_id(self, external_id):
"""Sets the external_id of this CollectionModel.
+ The external Id. # noqa: E501
:param external_id: The external_id of this CollectionModel. # noqa: E501
:type: str
@@ -320,6 +339,7 @@ def external_id(self, external_id):
def external_id_system(self):
"""Gets the external_id_system of this CollectionModel. # noqa: E501
+ The external Id system. # noqa: E501
:return: The external_id_system of this CollectionModel. # noqa: E501
:rtype: str
@@ -330,6 +350,7 @@ def external_id_system(self):
def external_id_system(self, external_id_system):
"""Sets the external_id_system of this CollectionModel.
+ The external Id system. # noqa: E501
:param external_id_system: The external_id_system of this CollectionModel. # noqa: E501
:type: str
@@ -343,6 +364,7 @@ def external_id_system(self, external_id_system):
def title(self):
"""Gets the title of this CollectionModel. # noqa: E501
+ The collection title. # noqa: E501
:return: The title of this CollectionModel. # noqa: E501
:rtype: str
@@ -353,6 +375,7 @@ def title(self):
def title(self, title):
"""Sets the title of this CollectionModel.
+ The collection title. # noqa: E501
:param title: The title of this CollectionModel. # noqa: E501
:type: str
@@ -366,6 +389,7 @@ def title(self, title):
def short_title(self):
"""Gets the short_title of this CollectionModel. # noqa: E501
+ The collection short title. # noqa: E501
:return: The short_title of this CollectionModel. # noqa: E501
:rtype: str
@@ -376,6 +400,7 @@ def short_title(self):
def short_title(self, short_title):
"""Sets the short_title of this CollectionModel.
+ The collection short title. # noqa: E501
:param short_title: The short_title of this CollectionModel. # noqa: E501
:type: str
@@ -387,6 +412,7 @@ def short_title(self, short_title):
def citation(self):
"""Gets the citation of this CollectionModel. # noqa: E501
+ The collection citation. # noqa: E501
:return: The citation of this CollectionModel. # noqa: E501
:rtype: str
@@ -397,6 +423,7 @@ def citation(self):
def citation(self, citation):
"""Sets the citation of this CollectionModel.
+ The collection citation. # noqa: E501
:param citation: The citation of this CollectionModel. # noqa: E501
:type: str
@@ -408,6 +435,7 @@ def citation(self, citation):
def license(self):
"""Gets the license of this CollectionModel. # noqa: E501
+ The collection license. # noqa: E501
:return: The license of this CollectionModel. # noqa: E501
:rtype: str
@@ -418,6 +446,7 @@ def license(self):
def license(self, license):
"""Sets the license of this CollectionModel.
+ The collection license. # noqa: E501
:param license: The license of this CollectionModel. # noqa: E501
:type: str
@@ -429,6 +458,7 @@ def license(self, license):
def abstract(self):
"""Gets the abstract of this CollectionModel. # noqa: E501
+ The collection abstract. # noqa: E501
:return: The abstract of this CollectionModel. # noqa: E501
:rtype: str
@@ -439,6 +469,7 @@ def abstract(self):
def abstract(self, abstract):
"""Sets the abstract of this CollectionModel.
+ The collection abstract. # noqa: E501
:param abstract: The abstract of this CollectionModel. # noqa: E501
:type: str
@@ -450,6 +481,7 @@ def abstract(self, abstract):
def description(self):
"""Gets the description of this CollectionModel. # noqa: E501
+ The collection description. # noqa: E501
:return: The description of this CollectionModel. # noqa: E501
:rtype: str
@@ -460,6 +492,7 @@ def description(self):
def description(self, description):
"""Sets the description of this CollectionModel.
+ The collection description. # noqa: E501
:param description: The description of this CollectionModel. # noqa: E501
:type: str
diff --git a/to_back/ecotaxa_cli_py/models/constants.py b/to_back/ecotaxa_cli_py/models/constants.py
index 191213b0..a6ce69f3 100644
--- a/to_back/ecotaxa_cli_py/models/constants.py
+++ b/to_back/ecotaxa_cli_py/models/constants.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -61,6 +61,7 @@ def __init__(self, license_texts=None, app_manager=["",""], local_vars_configura
def license_texts(self):
"""Gets the license_texts of this Constants. # noqa: E501
+ The supported licenses and help text/links. # noqa: E501
:return: The license_texts of this Constants. # noqa: E501
:rtype: dict(str, str)
@@ -71,6 +72,7 @@ def license_texts(self):
def license_texts(self, license_texts):
"""Sets the license_texts of this Constants.
+ The supported licenses and help text/links. # noqa: E501
:param license_texts: The license_texts of this Constants. # noqa: E501
:type: dict(str, str)
@@ -82,6 +84,7 @@ def license_texts(self, license_texts):
def app_manager(self):
"""Gets the app_manager of this Constants. # noqa: E501
+ The application manager identity (name, mail), from config file. # noqa: E501
:return: The app_manager of this Constants. # noqa: E501
:rtype: list[str]
@@ -92,6 +95,7 @@ def app_manager(self):
def app_manager(self, app_manager):
"""Sets the app_manager of this Constants.
+ The application manager identity (name, mail), from config file. # noqa: E501
:param app_manager: The app_manager of this Constants. # noqa: E501
:type: list[str]
diff --git a/to_back/ecotaxa_cli_py/models/create_collection_req.py b/to_back/ecotaxa_cli_py/models/create_collection_req.py
index ccb40828..0360a930 100644
--- a/to_back/ecotaxa_cli_py/models/create_collection_req.py
+++ b/to_back/ecotaxa_cli_py/models/create_collection_req.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -59,6 +59,7 @@ def __init__(self, title=None, project_ids=None, local_vars_configuration=None):
def title(self):
"""Gets the title of this CreateCollectionReq. # noqa: E501
+ The collection title. # noqa: E501
:return: The title of this CreateCollectionReq. # noqa: E501
:rtype: str
@@ -69,6 +70,7 @@ def title(self):
def title(self, title):
"""Sets the title of this CreateCollectionReq.
+ The collection title. # noqa: E501
:param title: The title of this CreateCollectionReq. # noqa: E501
:type: str
@@ -82,6 +84,7 @@ def title(self, title):
def project_ids(self):
"""Gets the project_ids of this CreateCollectionReq. # noqa: E501
+ The list of composing project IDs. # noqa: E501
:return: The project_ids of this CreateCollectionReq. # noqa: E501
:rtype: list[int]
@@ -92,6 +95,7 @@ def project_ids(self):
def project_ids(self, project_ids):
"""Sets the project_ids of this CreateCollectionReq.
+ The list of composing project IDs. # noqa: E501
:param project_ids: The project_ids of this CreateCollectionReq. # noqa: E501
:type: list[int]
diff --git a/to_back/ecotaxa_cli_py/models/create_project_req.py b/to_back/ecotaxa_cli_py/models/create_project_req.py
index 84d46099..ec7ca1e5 100644
--- a/to_back/ecotaxa_cli_py/models/create_project_req.py
+++ b/to_back/ecotaxa_cli_py/models/create_project_req.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -65,6 +65,7 @@ def __init__(self, clone_of_id=None, title=None, visible=True, local_vars_config
def clone_of_id(self):
"""Gets the clone_of_id of this CreateProjectReq. # noqa: E501
+ Internal, numeric id of a project to clone as a new one. By default it does not clone anything. # noqa: E501
:return: The clone_of_id of this CreateProjectReq. # noqa: E501
:rtype: int
@@ -75,6 +76,7 @@ def clone_of_id(self):
def clone_of_id(self, clone_of_id):
"""Sets the clone_of_id of this CreateProjectReq.
+ Internal, numeric id of a project to clone as a new one. By default it does not clone anything. # noqa: E501
:param clone_of_id: The clone_of_id of this CreateProjectReq. # noqa: E501
:type: int
@@ -86,6 +88,7 @@ def clone_of_id(self, clone_of_id):
def title(self):
"""Gets the title of this CreateProjectReq. # noqa: E501
+ The project title, as text. # noqa: E501
:return: The title of this CreateProjectReq. # noqa: E501
:rtype: str
@@ -96,6 +99,7 @@ def title(self):
def title(self, title):
"""Sets the title of this CreateProjectReq.
+ The project title, as text. # noqa: E501
:param title: The title of this CreateProjectReq. # noqa: E501
:type: str
@@ -109,6 +113,7 @@ def title(self, title):
def visible(self):
"""Gets the visible of this CreateProjectReq. # noqa: E501
+ When TRUE, the project is created visible by all users. # noqa: E501
:return: The visible of this CreateProjectReq. # noqa: E501
:rtype: bool
@@ -119,6 +124,7 @@ def visible(self):
def visible(self, visible):
"""Sets the visible of this CreateProjectReq.
+ When TRUE, the project is created visible by all users. # noqa: E501
:param visible: The visible of this CreateProjectReq. # noqa: E501
:type: bool
diff --git a/to_back/ecotaxa_cli_py/models/directory_entry_model.py b/to_back/ecotaxa_cli_py/models/directory_entry_model.py
index a48446e5..03c0599b 100644
--- a/to_back/ecotaxa_cli_py/models/directory_entry_model.py
+++ b/to_back/ecotaxa_cli_py/models/directory_entry_model.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -67,6 +67,7 @@ def __init__(self, name=None, type=None, size=None, mtime=None, local_vars_confi
def name(self):
"""Gets the name of this DirectoryEntryModel. # noqa: E501
+ atomic entry name. # noqa: E501
:return: The name of this DirectoryEntryModel. # noqa: E501
:rtype: str
@@ -77,6 +78,7 @@ def name(self):
def name(self, name):
"""Sets the name of this DirectoryEntryModel.
+ atomic entry name. # noqa: E501
:param name: The name of this DirectoryEntryModel. # noqa: E501
:type: str
@@ -90,6 +92,7 @@ def name(self, name):
def type(self):
"""Gets the type of this DirectoryEntryModel. # noqa: E501
+ entry type, 'D' for directory, 'F' for file. # noqa: E501
:return: The type of this DirectoryEntryModel. # noqa: E501
:rtype: str
@@ -100,6 +103,7 @@ def type(self):
def type(self, type):
"""Sets the type of this DirectoryEntryModel.
+ entry type, 'D' for directory, 'F' for file. # noqa: E501
:param type: The type of this DirectoryEntryModel. # noqa: E501
:type: str
@@ -113,6 +117,7 @@ def type(self, type):
def size(self):
"""Gets the size of this DirectoryEntryModel. # noqa: E501
+ Entry size, for zips. # noqa: E501
:return: The size of this DirectoryEntryModel. # noqa: E501
:rtype: int
@@ -123,6 +128,7 @@ def size(self):
def size(self, size):
"""Sets the size of this DirectoryEntryModel.
+ Entry size, for zips. # noqa: E501
:param size: The size of this DirectoryEntryModel. # noqa: E501
:type: int
@@ -136,6 +142,7 @@ def size(self, size):
def mtime(self):
"""Gets the mtime of this DirectoryEntryModel. # noqa: E501
+ Modification time, in ISO format. # noqa: E501
:return: The mtime of this DirectoryEntryModel. # noqa: E501
:rtype: str
@@ -146,6 +153,7 @@ def mtime(self):
def mtime(self, mtime):
"""Sets the mtime of this DirectoryEntryModel.
+ Modification time, in ISO format. # noqa: E501
:param mtime: The mtime of this DirectoryEntryModel. # noqa: E501
:type: str
diff --git a/to_back/ecotaxa_cli_py/models/directory_model.py b/to_back/ecotaxa_cli_py/models/directory_model.py
index e2047acf..d0029602 100644
--- a/to_back/ecotaxa_cli_py/models/directory_model.py
+++ b/to_back/ecotaxa_cli_py/models/directory_model.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -59,6 +59,7 @@ def __init__(self, path=None, entries=None, local_vars_configuration=None): # n
def path(self):
"""Gets the path of this DirectoryModel. # noqa: E501
+ A /-separated path from root to this directory. # noqa: E501
:return: The path of this DirectoryModel. # noqa: E501
:rtype: str
@@ -69,6 +70,7 @@ def path(self):
def path(self, path):
"""Sets the path of this DirectoryModel.
+ A /-separated path from root to this directory. # noqa: E501
:param path: The path of this DirectoryModel. # noqa: E501
:type: str
@@ -82,6 +84,7 @@ def path(self, path):
def entries(self):
"""Gets the entries of this DirectoryModel. # noqa: E501
+ Entries, i.e. subdirectories or contained files.All entries are readable, i.e. can be used as input or navigated into. # noqa: E501
:return: The entries of this DirectoryModel. # noqa: E501
:rtype: list[DirectoryEntryModel]
@@ -92,6 +95,7 @@ def entries(self):
def entries(self, entries):
"""Sets the entries of this DirectoryModel.
+ Entries, i.e. subdirectories or contained files.All entries are readable, i.e. can be used as input or navigated into. # noqa: E501
:param entries: The entries of this DirectoryModel. # noqa: E501
:type: list[DirectoryEntryModel]
diff --git a/to_back/ecotaxa_cli_py/models/emo_dnet_export_rsp.py b/to_back/ecotaxa_cli_py/models/emo_dnet_export_rsp.py
index 46c64329..1c79a04b 100644
--- a/to_back/ecotaxa_cli_py/models/emo_dnet_export_rsp.py
+++ b/to_back/ecotaxa_cli_py/models/emo_dnet_export_rsp.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -66,6 +66,7 @@ def __init__(self, errors=[], warnings=[], job_id=0, local_vars_configuration=No
def errors(self):
"""Gets the errors of this EMODnetExportRsp. # noqa: E501
+ Showstopper problems found while building the archive. # noqa: E501
:return: The errors of this EMODnetExportRsp. # noqa: E501
:rtype: list[str]
@@ -76,6 +77,7 @@ def errors(self):
def errors(self, errors):
"""Sets the errors of this EMODnetExportRsp.
+ Showstopper problems found while building the archive. # noqa: E501
:param errors: The errors of this EMODnetExportRsp. # noqa: E501
:type: list[str]
@@ -87,6 +89,7 @@ def errors(self, errors):
def warnings(self):
"""Gets the warnings of this EMODnetExportRsp. # noqa: E501
+ Problems found while building the archive, which do not prevent producing it. # noqa: E501
:return: The warnings of this EMODnetExportRsp. # noqa: E501
:rtype: list[str]
@@ -97,6 +100,7 @@ def warnings(self):
def warnings(self, warnings):
"""Sets the warnings of this EMODnetExportRsp.
+ Problems found while building the archive, which do not prevent producing it. # noqa: E501
:param warnings: The warnings of this EMODnetExportRsp. # noqa: E501
:type: list[str]
@@ -108,6 +112,7 @@ def warnings(self, warnings):
def job_id(self):
"""Gets the job_id of this EMODnetExportRsp. # noqa: E501
+ The created job, 0 if there were problems. # noqa: E501
:return: The job_id of this EMODnetExportRsp. # noqa: E501
:rtype: int
@@ -118,6 +123,7 @@ def job_id(self):
def job_id(self, job_id):
"""Sets the job_id of this EMODnetExportRsp.
+ The created job, 0 if there were problems. # noqa: E501
:param job_id: The job_id of this EMODnetExportRsp. # noqa: E501
:type: int
diff --git a/to_back/ecotaxa_cli_py/models/export_req.py b/to_back/ecotaxa_cli_py/models/export_req.py
index 81c8df52..13f4e7ac 100644
--- a/to_back/ecotaxa_cli_py/models/export_req.py
+++ b/to_back/ecotaxa_cli_py/models/export_req.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -100,6 +100,7 @@ def __init__(self, project_id=None, exp_type=None, use_latin1=False, tsv_entitie
def project_id(self):
"""Gets the project_id of this ExportReq. # noqa: E501
+ The project to export. # noqa: E501
:return: The project_id of this ExportReq. # noqa: E501
:rtype: int
@@ -110,6 +111,7 @@ def project_id(self):
def project_id(self, project_id):
"""Sets the project_id of this ExportReq.
+ The project to export. # noqa: E501
:param project_id: The project_id of this ExportReq. # noqa: E501
:type: int
@@ -123,6 +125,7 @@ def project_id(self, project_id):
def exp_type(self):
"""Gets the exp_type of this ExportReq. # noqa: E501
+ The export type: 'TSV', 'BAK', 'DOI' or 'SUM'. # noqa: E501
:return: The exp_type of this ExportReq. # noqa: E501
:rtype: ExportTypeEnum
@@ -133,6 +136,7 @@ def exp_type(self):
def exp_type(self, exp_type):
"""Sets the exp_type of this ExportReq.
+ The export type: 'TSV', 'BAK', 'DOI' or 'SUM'. # noqa: E501
:param exp_type: The exp_type of this ExportReq. # noqa: E501
:type: ExportTypeEnum
@@ -146,6 +150,7 @@ def exp_type(self, exp_type):
def use_latin1(self):
"""Gets the use_latin1 of this ExportReq. # noqa: E501
+ Export using latin 1 character set, AKA iso-8859-1. Default is utf-8. # noqa: E501
:return: The use_latin1 of this ExportReq. # noqa: E501
:rtype: bool
@@ -156,6 +161,7 @@ def use_latin1(self):
def use_latin1(self, use_latin1):
"""Sets the use_latin1 of this ExportReq.
+ Export using latin 1 character set, AKA iso-8859-1. Default is utf-8. # noqa: E501
:param use_latin1: The use_latin1 of this ExportReq. # noqa: E501
:type: bool
@@ -167,6 +173,7 @@ def use_latin1(self, use_latin1):
def tsv_entities(self):
"""Gets the tsv_entities of this ExportReq. # noqa: E501
+ For 'TSV' type, the entities to export, one letter for each of O(bject), P(rocess), A(cquisition), S(ample), classification H(istory), C(omments). # noqa: E501
:return: The tsv_entities of this ExportReq. # noqa: E501
:rtype: str
@@ -177,6 +184,7 @@ def tsv_entities(self):
def tsv_entities(self, tsv_entities):
"""Sets the tsv_entities of this ExportReq.
+ For 'TSV' type, the entities to export, one letter for each of O(bject), P(rocess), A(cquisition), S(ample), classification H(istory), C(omments). # noqa: E501
:param tsv_entities: The tsv_entities of this ExportReq. # noqa: E501
:type: str
@@ -190,6 +198,7 @@ def tsv_entities(self, tsv_entities):
def split_by(self):
"""Gets the split_by of this ExportReq. # noqa: E501
+ For 'TSV' type, inside archives, split in one directory per... 'sample', 'taxo' or '' (no split). # noqa: E501
:return: The split_by of this ExportReq. # noqa: E501
:rtype: str
@@ -200,6 +209,7 @@ def split_by(self):
def split_by(self, split_by):
"""Sets the split_by of this ExportReq.
+ For 'TSV' type, inside archives, split in one directory per... 'sample', 'taxo' or '' (no split). # noqa: E501
:param split_by: The split_by of this ExportReq. # noqa: E501
:type: str
@@ -213,6 +223,7 @@ def split_by(self, split_by):
def coma_as_separator(self):
"""Gets the coma_as_separator of this ExportReq. # noqa: E501
+ For 'TSV' type, use a , instead of . for decimal separator. # noqa: E501
:return: The coma_as_separator of this ExportReq. # noqa: E501
:rtype: bool
@@ -223,6 +234,7 @@ def coma_as_separator(self):
def coma_as_separator(self, coma_as_separator):
"""Sets the coma_as_separator of this ExportReq.
+ For 'TSV' type, use a , instead of . for decimal separator. # noqa: E501
:param coma_as_separator: The coma_as_separator of this ExportReq. # noqa: E501
:type: bool
@@ -236,6 +248,7 @@ def coma_as_separator(self, coma_as_separator):
def format_dates_times(self):
"""Gets the format_dates_times of this ExportReq. # noqa: E501
+ For 'TSV' type, format dates and times using - and : respectively. # noqa: E501
:return: The format_dates_times of this ExportReq. # noqa: E501
:rtype: bool
@@ -246,6 +259,7 @@ def format_dates_times(self):
def format_dates_times(self, format_dates_times):
"""Sets the format_dates_times of this ExportReq.
+ For 'TSV' type, format dates and times using - and : respectively. # noqa: E501
:param format_dates_times: The format_dates_times of this ExportReq. # noqa: E501
:type: bool
@@ -259,6 +273,7 @@ def format_dates_times(self, format_dates_times):
def with_images(self):
"""Gets the with_images of this ExportReq. # noqa: E501
+ For 'BAK' and 'DOI' types, export images as well. # noqa: E501
:return: The with_images of this ExportReq. # noqa: E501
:rtype: bool
@@ -269,6 +284,7 @@ def with_images(self):
def with_images(self, with_images):
"""Sets the with_images of this ExportReq.
+ For 'BAK' and 'DOI' types, export images as well. # noqa: E501
:param with_images: The with_images of this ExportReq. # noqa: E501
:type: bool
@@ -282,6 +298,7 @@ def with_images(self, with_images):
def with_internal_ids(self):
"""Gets the with_internal_ids of this ExportReq. # noqa: E501
+ For 'BAK' and 'DOI' types, export internal DB IDs. # noqa: E501
:return: The with_internal_ids of this ExportReq. # noqa: E501
:rtype: bool
@@ -292,6 +309,7 @@ def with_internal_ids(self):
def with_internal_ids(self, with_internal_ids):
"""Sets the with_internal_ids of this ExportReq.
+ For 'BAK' and 'DOI' types, export internal DB IDs. # noqa: E501
:param with_internal_ids: The with_internal_ids of this ExportReq. # noqa: E501
:type: bool
@@ -305,6 +323,7 @@ def with_internal_ids(self, with_internal_ids):
def only_first_image(self):
"""Gets the only_first_image of this ExportReq. # noqa: E501
+ For 'DOI' type, export only first (displayed) image. # noqa: E501
:return: The only_first_image of this ExportReq. # noqa: E501
:rtype: bool
@@ -315,6 +334,7 @@ def only_first_image(self):
def only_first_image(self, only_first_image):
"""Sets the only_first_image of this ExportReq.
+ For 'DOI' type, export only first (displayed) image. # noqa: E501
:param only_first_image: The only_first_image of this ExportReq. # noqa: E501
:type: bool
@@ -328,6 +348,7 @@ def only_first_image(self, only_first_image):
def sum_subtotal(self):
"""Gets the sum_subtotal of this ExportReq. # noqa: E501
+ For 'SUM' type, how subtotals should be calculated. Per A(cquisition) or S(ample) or ''. # noqa: E501
:return: The sum_subtotal of this ExportReq. # noqa: E501
:rtype: str
@@ -338,6 +359,7 @@ def sum_subtotal(self):
def sum_subtotal(self, sum_subtotal):
"""Sets the sum_subtotal of this ExportReq.
+ For 'SUM' type, how subtotals should be calculated. Per A(cquisition) or S(ample) or ''. # noqa: E501
:param sum_subtotal: The sum_subtotal of this ExportReq. # noqa: E501
:type: str
@@ -351,6 +373,7 @@ def sum_subtotal(self, sum_subtotal):
def out_to_ftp(self):
"""Gets the out_to_ftp of this ExportReq. # noqa: E501
+ Copy result file to FTP area. Original file is still available. # noqa: E501
:return: The out_to_ftp of this ExportReq. # noqa: E501
:rtype: bool
@@ -361,6 +384,7 @@ def out_to_ftp(self):
def out_to_ftp(self, out_to_ftp):
"""Sets the out_to_ftp of this ExportReq.
+ Copy result file to FTP area. Original file is still available. # noqa: E501
:param out_to_ftp: The out_to_ftp of this ExportReq. # noqa: E501
:type: bool
diff --git a/to_back/ecotaxa_cli_py/models/export_rsp.py b/to_back/ecotaxa_cli_py/models/export_rsp.py
index 9480998b..0339829c 100644
--- a/to_back/ecotaxa_cli_py/models/export_rsp.py
+++ b/to_back/ecotaxa_cli_py/models/export_rsp.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -66,6 +66,7 @@ def __init__(self, errors=[], warnings=[], job_id=0, local_vars_configuration=No
def errors(self):
"""Gets the errors of this ExportRsp. # noqa: E501
+ Showstopper problems found while building the archive. # noqa: E501
:return: The errors of this ExportRsp. # noqa: E501
:rtype: list[str]
@@ -76,6 +77,7 @@ def errors(self):
def errors(self, errors):
"""Sets the errors of this ExportRsp.
+ Showstopper problems found while building the archive. # noqa: E501
:param errors: The errors of this ExportRsp. # noqa: E501
:type: list[str]
@@ -87,6 +89,7 @@ def errors(self, errors):
def warnings(self):
"""Gets the warnings of this ExportRsp. # noqa: E501
+ Problems found while building the archive, which do not prevent producing it. # noqa: E501
:return: The warnings of this ExportRsp. # noqa: E501
:rtype: list[str]
@@ -97,6 +100,7 @@ def warnings(self):
def warnings(self, warnings):
"""Sets the warnings of this ExportRsp.
+ Problems found while building the archive, which do not prevent producing it. # noqa: E501
:param warnings: The warnings of this ExportRsp. # noqa: E501
:type: list[str]
@@ -108,6 +112,7 @@ def warnings(self, warnings):
def job_id(self):
"""Gets the job_id of this ExportRsp. # noqa: E501
+ The created job, 0 if there were problems. # noqa: E501
:return: The job_id of this ExportRsp. # noqa: E501
:rtype: int
@@ -118,6 +123,7 @@ def job_id(self):
def job_id(self, job_id):
"""Sets the job_id of this ExportRsp.
+ The created job, 0 if there were problems. # noqa: E501
:param job_id: The job_id of this ExportRsp. # noqa: E501
:type: int
diff --git a/to_back/ecotaxa_cli_py/models/export_type_enum.py b/to_back/ecotaxa_cli_py/models/export_type_enum.py
index 24c2daef..9eed06f8 100644
--- a/to_back/ecotaxa_cli_py/models/export_type_enum.py
+++ b/to_back/ecotaxa_cli_py/models/export_type_enum.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
diff --git a/to_back/ecotaxa_cli_py/models/group_definitions.py b/to_back/ecotaxa_cli_py/models/group_definitions.py
index 2b44c125..19e78584 100644
--- a/to_back/ecotaxa_cli_py/models/group_definitions.py
+++ b/to_back/ecotaxa_cli_py/models/group_definitions.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
diff --git a/to_back/ecotaxa_cli_py/models/historical_classification.py b/to_back/ecotaxa_cli_py/models/historical_classification.py
index e3e229af..4272a720 100644
--- a/to_back/ecotaxa_cli_py/models/historical_classification.py
+++ b/to_back/ecotaxa_cli_py/models/historical_classification.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -96,6 +96,7 @@ def __init__(self, objid=None, classif_id=None, classif_date=None, classif_who=N
def objid(self):
"""Gets the objid of this HistoricalClassification. # noqa: E501
+ The object Id. # noqa: E501
:return: The objid of this HistoricalClassification. # noqa: E501
:rtype: int
@@ -106,6 +107,7 @@ def objid(self):
def objid(self, objid):
"""Sets the objid of this HistoricalClassification.
+ The object Id. # noqa: E501
:param objid: The objid of this HistoricalClassification. # noqa: E501
:type: int
@@ -117,6 +119,7 @@ def objid(self, objid):
def classif_id(self):
"""Gets the classif_id of this HistoricalClassification. # noqa: E501
+ The classification Id. # noqa: E501
:return: The classif_id of this HistoricalClassification. # noqa: E501
:rtype: int
@@ -127,6 +130,7 @@ def classif_id(self):
def classif_id(self, classif_id):
"""Sets the classif_id of this HistoricalClassification.
+ The classification Id. # noqa: E501
:param classif_id: The classif_id of this HistoricalClassification. # noqa: E501
:type: int
@@ -138,6 +142,7 @@ def classif_id(self, classif_id):
def classif_date(self):
"""Gets the classif_date of this HistoricalClassification. # noqa: E501
+ The classification date. # noqa: E501
:return: The classif_date of this HistoricalClassification. # noqa: E501
:rtype: datetime
@@ -148,6 +153,7 @@ def classif_date(self):
def classif_date(self, classif_date):
"""Sets the classif_date of this HistoricalClassification.
+ The classification date. # noqa: E501
:param classif_date: The classif_date of this HistoricalClassification. # noqa: E501
:type: datetime
@@ -159,6 +165,7 @@ def classif_date(self, classif_date):
def classif_who(self):
"""Gets the classif_who of this HistoricalClassification. # noqa: E501
+ The user who manualy classify this object. # noqa: E501
:return: The classif_who of this HistoricalClassification. # noqa: E501
:rtype: int
@@ -169,6 +176,7 @@ def classif_who(self):
def classif_who(self, classif_who):
"""Sets the classif_who of this HistoricalClassification.
+ The user who manualy classify this object. # noqa: E501
:param classif_who: The classif_who of this HistoricalClassification. # noqa: E501
:type: int
@@ -180,6 +188,7 @@ def classif_who(self, classif_who):
def classif_type(self):
"""Gets the classif_type of this HistoricalClassification. # noqa: E501
+ The type of classification. Could be **A** for Automatic or **M** for Manual. # noqa: E501
:return: The classif_type of this HistoricalClassification. # noqa: E501
:rtype: str
@@ -190,6 +199,7 @@ def classif_type(self):
def classif_type(self, classif_type):
"""Sets the classif_type of this HistoricalClassification.
+ The type of classification. Could be **A** for Automatic or **M** for Manual. # noqa: E501
:param classif_type: The classif_type of this HistoricalClassification. # noqa: E501
:type: str
@@ -201,6 +211,7 @@ def classif_type(self, classif_type):
def classif_qual(self):
"""Gets the classif_qual of this HistoricalClassification. # noqa: E501
+ The classification qualification. Could be **P** for predicted, **V** for validated or **D** for Dubious. # noqa: E501
:return: The classif_qual of this HistoricalClassification. # noqa: E501
:rtype: str
@@ -211,6 +222,7 @@ def classif_qual(self):
def classif_qual(self, classif_qual):
"""Sets the classif_qual of this HistoricalClassification.
+ The classification qualification. Could be **P** for predicted, **V** for validated or **D** for Dubious. # noqa: E501
:param classif_qual: The classif_qual of this HistoricalClassification. # noqa: E501
:type: str
@@ -222,6 +234,7 @@ def classif_qual(self, classif_qual):
def classif_score(self):
"""Gets the classif_score of this HistoricalClassification. # noqa: E501
+ The classification score is generally between 0 and 1. This is a confidence score, in the fact that, the taxon prediction for this object is correct. # noqa: E501
:return: The classif_score of this HistoricalClassification. # noqa: E501
:rtype: float
@@ -232,6 +245,7 @@ def classif_score(self):
def classif_score(self, classif_score):
"""Sets the classif_score of this HistoricalClassification.
+ The classification score is generally between 0 and 1. This is a confidence score, in the fact that, the taxon prediction for this object is correct. # noqa: E501
:param classif_score: The classif_score of this HistoricalClassification. # noqa: E501
:type: float
@@ -243,6 +257,7 @@ def classif_score(self, classif_score):
def user_name(self):
"""Gets the user_name of this HistoricalClassification. # noqa: E501
+ The name of the user who classified this object. # noqa: E501
:return: The user_name of this HistoricalClassification. # noqa: E501
:rtype: str
@@ -253,6 +268,7 @@ def user_name(self):
def user_name(self, user_name):
"""Sets the user_name of this HistoricalClassification.
+ The name of the user who classified this object. # noqa: E501
:param user_name: The user_name of this HistoricalClassification. # noqa: E501
:type: str
@@ -264,6 +280,7 @@ def user_name(self, user_name):
def taxon_name(self):
"""Gets the taxon_name of this HistoricalClassification. # noqa: E501
+ The taxon name of the object. # noqa: E501
:return: The taxon_name of this HistoricalClassification. # noqa: E501
:rtype: str
@@ -274,6 +291,7 @@ def taxon_name(self):
def taxon_name(self, taxon_name):
"""Sets the taxon_name of this HistoricalClassification.
+ The taxon name of the object. # noqa: E501
:param taxon_name: The taxon_name of this HistoricalClassification. # noqa: E501
:type: str
diff --git a/to_back/ecotaxa_cli_py/models/historical_last_classif.py b/to_back/ecotaxa_cli_py/models/historical_last_classif.py
index 70678298..addd530d 100644
--- a/to_back/ecotaxa_cli_py/models/historical_last_classif.py
+++ b/to_back/ecotaxa_cli_py/models/historical_last_classif.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -86,6 +86,7 @@ def __init__(self, objid=None, classif_id=None, histo_classif_date=None, histo_c
def objid(self):
"""Gets the objid of this HistoricalLastClassif. # noqa: E501
+ The object Id. # noqa: E501
:return: The objid of this HistoricalLastClassif. # noqa: E501
:rtype: int
@@ -96,6 +97,7 @@ def objid(self):
def objid(self, objid):
"""Sets the objid of this HistoricalLastClassif.
+ The object Id. # noqa: E501
:param objid: The objid of this HistoricalLastClassif. # noqa: E501
:type: int
@@ -107,6 +109,7 @@ def objid(self, objid):
def classif_id(self):
"""Gets the classif_id of this HistoricalLastClassif. # noqa: E501
+ The classification Id. # noqa: E501
:return: The classif_id of this HistoricalLastClassif. # noqa: E501
:rtype: int
@@ -117,6 +120,7 @@ def classif_id(self):
def classif_id(self, classif_id):
"""Sets the classif_id of this HistoricalLastClassif.
+ The classification Id. # noqa: E501
:param classif_id: The classif_id of this HistoricalLastClassif. # noqa: E501
:type: int
@@ -128,6 +132,7 @@ def classif_id(self, classif_id):
def histo_classif_date(self):
"""Gets the histo_classif_date of this HistoricalLastClassif. # noqa: E501
+ The classification date. # noqa: E501
:return: The histo_classif_date of this HistoricalLastClassif. # noqa: E501
:rtype: datetime
@@ -138,6 +143,7 @@ def histo_classif_date(self):
def histo_classif_date(self, histo_classif_date):
"""Sets the histo_classif_date of this HistoricalLastClassif.
+ The classification date. # noqa: E501
:param histo_classif_date: The histo_classif_date of this HistoricalLastClassif. # noqa: E501
:type: datetime
@@ -149,6 +155,7 @@ def histo_classif_date(self, histo_classif_date):
def histo_classif_type(self):
"""Gets the histo_classif_type of this HistoricalLastClassif. # noqa: E501
+ The type of classification. Could be **A** for Automatic or **M** for Manual. # noqa: E501
:return: The histo_classif_type of this HistoricalLastClassif. # noqa: E501
:rtype: str
@@ -159,6 +166,7 @@ def histo_classif_type(self):
def histo_classif_type(self, histo_classif_type):
"""Sets the histo_classif_type of this HistoricalLastClassif.
+ The type of classification. Could be **A** for Automatic or **M** for Manual. # noqa: E501
:param histo_classif_type: The histo_classif_type of this HistoricalLastClassif. # noqa: E501
:type: str
@@ -170,6 +178,7 @@ def histo_classif_type(self, histo_classif_type):
def histo_classif_id(self):
"""Gets the histo_classif_id of this HistoricalLastClassif. # noqa: E501
+ The classification Id. # noqa: E501
:return: The histo_classif_id of this HistoricalLastClassif. # noqa: E501
:rtype: int
@@ -180,6 +189,7 @@ def histo_classif_id(self):
def histo_classif_id(self, histo_classif_id):
"""Sets the histo_classif_id of this HistoricalLastClassif.
+ The classification Id. # noqa: E501
:param histo_classif_id: The histo_classif_id of this HistoricalLastClassif. # noqa: E501
:type: int
@@ -191,6 +201,7 @@ def histo_classif_id(self, histo_classif_id):
def histo_classif_qual(self):
"""Gets the histo_classif_qual of this HistoricalLastClassif. # noqa: E501
+ The classification qualification. Could be **P** for predicted, **V** for validated or **D** for Dubious. # noqa: E501
:return: The histo_classif_qual of this HistoricalLastClassif. # noqa: E501
:rtype: str
@@ -201,6 +212,7 @@ def histo_classif_qual(self):
def histo_classif_qual(self, histo_classif_qual):
"""Sets the histo_classif_qual of this HistoricalLastClassif.
+ The classification qualification. Could be **P** for predicted, **V** for validated or **D** for Dubious. # noqa: E501
:param histo_classif_qual: The histo_classif_qual of this HistoricalLastClassif. # noqa: E501
:type: str
@@ -212,6 +224,7 @@ def histo_classif_qual(self, histo_classif_qual):
def histo_classif_who(self):
"""Gets the histo_classif_who of this HistoricalLastClassif. # noqa: E501
+ The user who manualy classify this object. # noqa: E501
:return: The histo_classif_who of this HistoricalLastClassif. # noqa: E501
:rtype: int
@@ -222,6 +235,7 @@ def histo_classif_who(self):
def histo_classif_who(self, histo_classif_who):
"""Sets the histo_classif_who of this HistoricalLastClassif.
+ The user who manualy classify this object. # noqa: E501
:param histo_classif_who: The histo_classif_who of this HistoricalLastClassif. # noqa: E501
:type: int
diff --git a/to_back/ecotaxa_cli_py/models/http_validation_error.py b/to_back/ecotaxa_cli_py/models/http_validation_error.py
index 7696f802..cf9c373d 100644
--- a/to_back/ecotaxa_cli_py/models/http_validation_error.py
+++ b/to_back/ecotaxa_cli_py/models/http_validation_error.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
diff --git a/to_back/ecotaxa_cli_py/models/image_model.py b/to_back/ecotaxa_cli_py/models/image_model.py
index cbac40dc..a0c9f876 100644
--- a/to_back/ecotaxa_cli_py/models/image_model.py
+++ b/to_back/ecotaxa_cli_py/models/image_model.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -76,8 +76,7 @@ def __init__(self, imgid=None, objid=None, imgrank=None, file_name=None, orig_fi
self._thumb_height = None
self.discriminator = None
- if imgid is not None:
- self.imgid = imgid
+ self.imgid = imgid
if objid is not None:
self.objid = objid
self.imgrank = imgrank
@@ -96,6 +95,7 @@ def __init__(self, imgid=None, objid=None, imgrank=None, file_name=None, orig_fi
def imgid(self):
"""Gets the imgid of this ImageModel. # noqa: E501
+ The id of the image. # noqa: E501
:return: The imgid of this ImageModel. # noqa: E501
:rtype: int
@@ -106,10 +106,13 @@ def imgid(self):
def imgid(self, imgid):
"""Sets the imgid of this ImageModel.
+ The id of the image. # noqa: E501
:param imgid: The imgid of this ImageModel. # noqa: E501
:type: int
"""
+ if self.local_vars_configuration.client_side_validation and imgid is None: # noqa: E501
+ raise ValueError("Invalid value for `imgid`, must not be `None`") # noqa: E501
self._imgid = imgid
@@ -117,6 +120,7 @@ def imgid(self, imgid):
def objid(self):
"""Gets the objid of this ImageModel. # noqa: E501
+ The id of the object related to the image. # noqa: E501
:return: The objid of this ImageModel. # noqa: E501
:rtype: int
@@ -127,6 +131,7 @@ def objid(self):
def objid(self, objid):
"""Sets the objid of this ImageModel.
+ The id of the object related to the image. # noqa: E501
:param objid: The objid of this ImageModel. # noqa: E501
:type: int
@@ -138,6 +143,7 @@ def objid(self, objid):
def imgrank(self):
"""Gets the imgrank of this ImageModel. # noqa: E501
+ The rank of the image. # noqa: E501
:return: The imgrank of this ImageModel. # noqa: E501
:rtype: int
@@ -148,6 +154,7 @@ def imgrank(self):
def imgrank(self, imgrank):
"""Sets the imgrank of this ImageModel.
+ The rank of the image. # noqa: E501
:param imgrank: The imgrank of this ImageModel. # noqa: E501
:type: int
@@ -161,6 +168,7 @@ def imgrank(self, imgrank):
def file_name(self):
"""Gets the file_name of this ImageModel. # noqa: E501
+ The file name. # noqa: E501
:return: The file_name of this ImageModel. # noqa: E501
:rtype: str
@@ -171,6 +179,7 @@ def file_name(self):
def file_name(self, file_name):
"""Sets the file_name of this ImageModel.
+ The file name. # noqa: E501
:param file_name: The file_name of this ImageModel. # noqa: E501
:type: str
@@ -184,6 +193,7 @@ def file_name(self, file_name):
def orig_file_name(self):
"""Gets the orig_file_name of this ImageModel. # noqa: E501
+ The file name of the original image. # noqa: E501
:return: The orig_file_name of this ImageModel. # noqa: E501
:rtype: str
@@ -194,6 +204,7 @@ def orig_file_name(self):
def orig_file_name(self, orig_file_name):
"""Sets the orig_file_name of this ImageModel.
+ The file name of the original image. # noqa: E501
:param orig_file_name: The orig_file_name of this ImageModel. # noqa: E501
:type: str
@@ -207,6 +218,7 @@ def orig_file_name(self, orig_file_name):
def width(self):
"""Gets the width of this ImageModel. # noqa: E501
+ The width of the image. # noqa: E501
:return: The width of this ImageModel. # noqa: E501
:rtype: int
@@ -217,6 +229,7 @@ def width(self):
def width(self, width):
"""Sets the width of this ImageModel.
+ The width of the image. # noqa: E501
:param width: The width of this ImageModel. # noqa: E501
:type: int
@@ -230,6 +243,7 @@ def width(self, width):
def height(self):
"""Gets the height of this ImageModel. # noqa: E501
+ The height of the image. # noqa: E501
:return: The height of this ImageModel. # noqa: E501
:rtype: int
@@ -240,6 +254,7 @@ def height(self):
def height(self, height):
"""Sets the height of this ImageModel.
+ The height of the image. # noqa: E501
:param height: The height of this ImageModel. # noqa: E501
:type: int
@@ -253,6 +268,7 @@ def height(self, height):
def thumb_file_name(self):
"""Gets the thumb_file_name of this ImageModel. # noqa: E501
+ Generate thumbnail if image is too large. This generated thumbnail file name. # noqa: E501
:return: The thumb_file_name of this ImageModel. # noqa: E501
:rtype: str
@@ -263,6 +279,7 @@ def thumb_file_name(self):
def thumb_file_name(self, thumb_file_name):
"""Sets the thumb_file_name of this ImageModel.
+ Generate thumbnail if image is too large. This generated thumbnail file name. # noqa: E501
:param thumb_file_name: The thumb_file_name of this ImageModel. # noqa: E501
:type: str
@@ -274,6 +291,7 @@ def thumb_file_name(self, thumb_file_name):
def thumb_width(self):
"""Gets the thumb_width of this ImageModel. # noqa: E501
+ Generate thumbnail if image is too large. This generated thumbnail width. # noqa: E501
:return: The thumb_width of this ImageModel. # noqa: E501
:rtype: int
@@ -284,6 +302,7 @@ def thumb_width(self):
def thumb_width(self, thumb_width):
"""Sets the thumb_width of this ImageModel.
+ Generate thumbnail if image is too large. This generated thumbnail width. # noqa: E501
:param thumb_width: The thumb_width of this ImageModel. # noqa: E501
:type: int
@@ -295,6 +314,7 @@ def thumb_width(self, thumb_width):
def thumb_height(self):
"""Gets the thumb_height of this ImageModel. # noqa: E501
+ Generate thumbnail if image is too large. The thumb height of the image. # noqa: E501
:return: The thumb_height of this ImageModel. # noqa: E501
:rtype: int
@@ -305,6 +325,7 @@ def thumb_height(self):
def thumb_height(self, thumb_height):
"""Sets the thumb_height of this ImageModel.
+ Generate thumbnail if image is too large. The thumb height of the image. # noqa: E501
:param thumb_height: The thumb_height of this ImageModel. # noqa: E501
:type: int
diff --git a/to_back/ecotaxa_cli_py/models/import_req.py b/to_back/ecotaxa_cli_py/models/import_req.py
index 6f780f48..9a95341b 100644
--- a/to_back/ecotaxa_cli_py/models/import_req.py
+++ b/to_back/ecotaxa_cli_py/models/import_req.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -75,6 +75,7 @@ def __init__(self, source_path=None, taxo_mappings=None, skip_loaded_files=False
def source_path(self):
"""Gets the source_path of this ImportReq. # noqa: E501
+ Source path on server, to zip or plain directory. The path can be returned by a file upload (absolute), otherwise it's relative to shared file area root. # noqa: E501
:return: The source_path of this ImportReq. # noqa: E501
:rtype: str
@@ -85,6 +86,7 @@ def source_path(self):
def source_path(self, source_path):
"""Sets the source_path of this ImportReq.
+ Source path on server, to zip or plain directory. The path can be returned by a file upload (absolute), otherwise it's relative to shared file area root. # noqa: E501
:param source_path: The source_path of this ImportReq. # noqa: E501
:type: str
@@ -98,6 +100,7 @@ def source_path(self, source_path):
def taxo_mappings(self):
"""Gets the taxo_mappings of this ImportReq. # noqa: E501
+ Optional taxonomy mapping, the key specifies the taxonomy ID found in file and the value specifies the final taxonomy ID to write. # noqa: E501
:return: The taxo_mappings of this ImportReq. # noqa: E501
:rtype: dict(str, str)
@@ -108,6 +111,7 @@ def taxo_mappings(self):
def taxo_mappings(self, taxo_mappings):
"""Sets the taxo_mappings of this ImportReq.
+ Optional taxonomy mapping, the key specifies the taxonomy ID found in file and the value specifies the final taxonomy ID to write. # noqa: E501
:param taxo_mappings: The taxo_mappings of this ImportReq. # noqa: E501
:type: dict(str, str)
@@ -119,6 +123,7 @@ def taxo_mappings(self, taxo_mappings):
def skip_loaded_files(self):
"""Gets the skip_loaded_files of this ImportReq. # noqa: E501
+ If true skip loaded files, else don't. # noqa: E501
:return: The skip_loaded_files of this ImportReq. # noqa: E501
:rtype: bool
@@ -129,6 +134,7 @@ def skip_loaded_files(self):
def skip_loaded_files(self, skip_loaded_files):
"""Sets the skip_loaded_files of this ImportReq.
+ If true skip loaded files, else don't. # noqa: E501
:param skip_loaded_files: The skip_loaded_files of this ImportReq. # noqa: E501
:type: bool
@@ -140,6 +146,7 @@ def skip_loaded_files(self, skip_loaded_files):
def skip_existing_objects(self):
"""Gets the skip_existing_objects of this ImportReq. # noqa: E501
+ If true skip existing objects, else don't. # noqa: E501
:return: The skip_existing_objects of this ImportReq. # noqa: E501
:rtype: bool
@@ -150,6 +157,7 @@ def skip_existing_objects(self):
def skip_existing_objects(self, skip_existing_objects):
"""Sets the skip_existing_objects of this ImportReq.
+ If true skip existing objects, else don't. # noqa: E501
:param skip_existing_objects: The skip_existing_objects of this ImportReq. # noqa: E501
:type: bool
@@ -161,6 +169,7 @@ def skip_existing_objects(self, skip_existing_objects):
def update_mode(self):
"""Gets the update_mode of this ImportReq. # noqa: E501
+ Update data ('Yes'), including classification ('Cla'). # noqa: E501
:return: The update_mode of this ImportReq. # noqa: E501
:rtype: str
@@ -171,6 +180,7 @@ def update_mode(self):
def update_mode(self, update_mode):
"""Sets the update_mode of this ImportReq.
+ Update data ('Yes'), including classification ('Cla'). # noqa: E501
:param update_mode: The update_mode of this ImportReq. # noqa: E501
:type: str
diff --git a/to_back/ecotaxa_cli_py/models/import_rsp.py b/to_back/ecotaxa_cli_py/models/import_rsp.py
index a769363a..fd16e5b8 100644
--- a/to_back/ecotaxa_cli_py/models/import_rsp.py
+++ b/to_back/ecotaxa_cli_py/models/import_rsp.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -60,6 +60,7 @@ def __init__(self, job_id=None, errors=[], local_vars_configuration=None): # no
def job_id(self):
"""Gets the job_id of this ImportRsp. # noqa: E501
+ The job which was created for the run. # noqa: E501
:return: The job_id of this ImportRsp. # noqa: E501
:rtype: int
@@ -70,6 +71,7 @@ def job_id(self):
def job_id(self, job_id):
"""Sets the job_id of this ImportRsp.
+ The job which was created for the run. # noqa: E501
:param job_id: The job_id of this ImportRsp. # noqa: E501
:type: int
@@ -83,6 +85,7 @@ def job_id(self, job_id):
def errors(self):
"""Gets the errors of this ImportRsp. # noqa: E501
+ Errors from analysis. # noqa: E501
:return: The errors of this ImportRsp. # noqa: E501
:rtype: list[str]
@@ -93,6 +96,7 @@ def errors(self):
def errors(self, errors):
"""Sets the errors of this ImportRsp.
+ Errors from analysis. # noqa: E501
:param errors: The errors of this ImportRsp. # noqa: E501
:type: list[str]
diff --git a/to_back/ecotaxa_cli_py/models/job_model.py b/to_back/ecotaxa_cli_py/models/job_model.py
index 102a11eb..555c4891 100644
--- a/to_back/ecotaxa_cli_py/models/job_model.py
+++ b/to_back/ecotaxa_cli_py/models/job_model.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -103,8 +103,7 @@ def __init__(self, params=None, result=None, errors=[], question=None, reply=Non
self.reply = reply
if inside is not None:
self.inside = inside
- if id is not None:
- self.id = id
+ self.id = id
self.owner_id = owner_id
self.type = type
if state is not None:
@@ -122,6 +121,7 @@ def __init__(self, params=None, result=None, errors=[], question=None, reply=Non
def params(self):
"""Gets the params of this JobModel. # noqa: E501
+ Creation parameters. # noqa: E501
:return: The params of this JobModel. # noqa: E501
:rtype: object
@@ -132,6 +132,7 @@ def params(self):
def params(self, params):
"""Sets the params of this JobModel.
+ Creation parameters. # noqa: E501
:param params: The params of this JobModel. # noqa: E501
:type: object
@@ -143,6 +144,7 @@ def params(self, params):
def result(self):
"""Gets the result of this JobModel. # noqa: E501
+ Final result of the run. # noqa: E501
:return: The result of this JobModel. # noqa: E501
:rtype: object
@@ -153,6 +155,7 @@ def result(self):
def result(self, result):
"""Sets the result of this JobModel.
+ Final result of the run. # noqa: E501
:param result: The result of this JobModel. # noqa: E501
:type: object
@@ -164,6 +167,7 @@ def result(self, result):
def errors(self):
"""Gets the errors of this JobModel. # noqa: E501
+ The errors seen during last step. # noqa: E501
:return: The errors of this JobModel. # noqa: E501
:rtype: list[str]
@@ -174,6 +178,7 @@ def errors(self):
def errors(self, errors):
"""Sets the errors of this JobModel.
+ The errors seen during last step. # noqa: E501
:param errors: The errors of this JobModel. # noqa: E501
:type: list[str]
@@ -185,6 +190,7 @@ def errors(self, errors):
def question(self):
"""Gets the question of this JobModel. # noqa: E501
+ The data provoking job move to Asking state. # noqa: E501
:return: The question of this JobModel. # noqa: E501
:rtype: object
@@ -195,6 +201,7 @@ def question(self):
def question(self, question):
"""Sets the question of this JobModel.
+ The data provoking job move to Asking state. # noqa: E501
:param question: The question of this JobModel. # noqa: E501
:type: object
@@ -206,6 +213,7 @@ def question(self, question):
def reply(self):
"""Gets the reply of this JobModel. # noqa: E501
+ The data provided as a reply to the question. # noqa: E501
:return: The reply of this JobModel. # noqa: E501
:rtype: object
@@ -216,6 +224,7 @@ def reply(self):
def reply(self, reply):
"""Sets the reply of this JobModel.
+ The data provided as a reply to the question. # noqa: E501
:param reply: The reply of this JobModel. # noqa: E501
:type: object
@@ -227,6 +236,7 @@ def reply(self, reply):
def inside(self):
"""Gets the inside of this JobModel. # noqa: E501
+ Internal state of the job. # noqa: E501
:return: The inside of this JobModel. # noqa: E501
:rtype: object
@@ -237,6 +247,7 @@ def inside(self):
def inside(self, inside):
"""Sets the inside of this JobModel.
+ Internal state of the job. # noqa: E501
:param inside: The inside of this JobModel. # noqa: E501
:type: object
@@ -248,6 +259,7 @@ def inside(self, inside):
def id(self):
"""Gets the id of this JobModel. # noqa: E501
+ Job unique identifier. # noqa: E501
:return: The id of this JobModel. # noqa: E501
:rtype: int
@@ -258,10 +270,13 @@ def id(self):
def id(self, id):
"""Sets the id of this JobModel.
+ Job unique identifier. # noqa: E501
:param id: The id of this JobModel. # noqa: E501
:type: int
"""
+ if self.local_vars_configuration.client_side_validation and id is None: # noqa: E501
+ raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501
self._id = id
@@ -269,6 +284,7 @@ def id(self, id):
def owner_id(self):
"""Gets the owner_id of this JobModel. # noqa: E501
+ The user who created and thus owns the job. # noqa: E501
:return: The owner_id of this JobModel. # noqa: E501
:rtype: int
@@ -279,6 +295,7 @@ def owner_id(self):
def owner_id(self, owner_id):
"""Sets the owner_id of this JobModel.
+ The user who created and thus owns the job. # noqa: E501
:param owner_id: The owner_id of this JobModel. # noqa: E501
:type: int
@@ -292,6 +309,7 @@ def owner_id(self, owner_id):
def type(self):
"""Gets the type of this JobModel. # noqa: E501
+ The job type, e.g. import, export... # noqa: E501
:return: The type of this JobModel. # noqa: E501
:rtype: str
@@ -302,6 +320,7 @@ def type(self):
def type(self, type):
"""Sets the type of this JobModel.
+ The job type, e.g. import, export... # noqa: E501
:param type: The type of this JobModel. # noqa: E501
:type: str
@@ -315,6 +334,7 @@ def type(self, type):
def state(self):
"""Gets the state of this JobModel. # noqa: E501
+ What the job is doing. Could be 'P' for Pending (Waiting for an execution thread), 'R' for Running (Being executed inside a thread), 'A' for Asking (Needing user information before resuming), 'E' for Error (Stopped with error), 'F' for Finished (Done). # noqa: E501
:return: The state of this JobModel. # noqa: E501
:rtype: str
@@ -325,6 +345,7 @@ def state(self):
def state(self, state):
"""Sets the state of this JobModel.
+ What the job is doing. Could be 'P' for Pending (Waiting for an execution thread), 'R' for Running (Being executed inside a thread), 'A' for Asking (Needing user information before resuming), 'E' for Error (Stopped with error), 'F' for Finished (Done). # noqa: E501
:param state: The state of this JobModel. # noqa: E501
:type: str
@@ -336,6 +357,7 @@ def state(self, state):
def step(self):
"""Gets the step of this JobModel. # noqa: E501
+ Where in the workflow the job is. # noqa: E501
:return: The step of this JobModel. # noqa: E501
:rtype: int
@@ -346,6 +368,7 @@ def step(self):
def step(self, step):
"""Sets the step of this JobModel.
+ Where in the workflow the job is. # noqa: E501
:param step: The step of this JobModel. # noqa: E501
:type: int
@@ -357,6 +380,7 @@ def step(self, step):
def progress_pct(self):
"""Gets the progress_pct of this JobModel. # noqa: E501
+ The progress percentage for UI. # noqa: E501
:return: The progress_pct of this JobModel. # noqa: E501
:rtype: int
@@ -367,6 +391,7 @@ def progress_pct(self):
def progress_pct(self, progress_pct):
"""Sets the progress_pct of this JobModel.
+ The progress percentage for UI. # noqa: E501
:param progress_pct: The progress_pct of this JobModel. # noqa: E501
:type: int
@@ -378,6 +403,7 @@ def progress_pct(self, progress_pct):
def progress_msg(self):
"""Gets the progress_msg of this JobModel. # noqa: E501
+ The message for UI, short version. # noqa: E501
:return: The progress_msg of this JobModel. # noqa: E501
:rtype: str
@@ -388,6 +414,7 @@ def progress_msg(self):
def progress_msg(self, progress_msg):
"""Sets the progress_msg of this JobModel.
+ The message for UI, short version. # noqa: E501
:param progress_msg: The progress_msg of this JobModel. # noqa: E501
:type: str
@@ -399,6 +426,7 @@ def progress_msg(self, progress_msg):
def creation_date(self):
"""Gets the creation_date of this JobModel. # noqa: E501
+ The date of creation of the Job, as text formatted according to the ISO 8601 standard. # noqa: E501
:return: The creation_date of this JobModel. # noqa: E501
:rtype: datetime
@@ -409,6 +437,7 @@ def creation_date(self):
def creation_date(self, creation_date):
"""Sets the creation_date of this JobModel.
+ The date of creation of the Job, as text formatted according to the ISO 8601 standard. # noqa: E501
:param creation_date: The creation_date of this JobModel. # noqa: E501
:type: datetime
@@ -422,6 +451,7 @@ def creation_date(self, creation_date):
def updated_on(self):
"""Gets the updated_on of this JobModel. # noqa: E501
+ Last time that anything changed in present line. # noqa: E501
:return: The updated_on of this JobModel. # noqa: E501
:rtype: datetime
@@ -432,6 +462,7 @@ def updated_on(self):
def updated_on(self, updated_on):
"""Sets the updated_on of this JobModel.
+ Last time that anything changed in present line. # noqa: E501
:param updated_on: The updated_on of this JobModel. # noqa: E501
:type: datetime
diff --git a/to_back/ecotaxa_cli_py/models/limit_methods.py b/to_back/ecotaxa_cli_py/models/limit_methods.py
index ed14605c..8b94dddc 100644
--- a/to_back/ecotaxa_cli_py/models/limit_methods.py
+++ b/to_back/ecotaxa_cli_py/models/limit_methods.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
diff --git a/to_back/ecotaxa_cli_py/models/login_req.py b/to_back/ecotaxa_cli_py/models/login_req.py
index fadd922c..47490484 100644
--- a/to_back/ecotaxa_cli_py/models/login_req.py
+++ b/to_back/ecotaxa_cli_py/models/login_req.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -33,71 +33,75 @@ class LoginReq(object):
and the value is json key in definition.
"""
openapi_types = {
- 'username': 'str',
- 'password': 'str'
+ 'password': 'str',
+ 'username': 'str'
}
attribute_map = {
- 'username': 'username',
- 'password': 'password'
+ 'password': 'password',
+ 'username': 'username'
}
- def __init__(self, username='User email, like in Web UI', password='User password', local_vars_configuration=None): # noqa: E501
+ def __init__(self, password=None, username=None, local_vars_configuration=None): # noqa: E501
"""LoginReq - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
self.local_vars_configuration = local_vars_configuration
- self._username = None
self._password = None
+ self._username = None
self.discriminator = None
- if username is not None:
- self.username = username
if password is not None:
self.password = password
+ if username is not None:
+ self.username = username
@property
- def username(self):
- """Gets the username of this LoginReq. # noqa: E501
+ def password(self):
+ """Gets the password of this LoginReq. # noqa: E501
+ User password. # noqa: E501
- :return: The username of this LoginReq. # noqa: E501
+ :return: The password of this LoginReq. # noqa: E501
:rtype: str
"""
- return self._username
+ return self._password
- @username.setter
- def username(self, username):
- """Sets the username of this LoginReq.
+ @password.setter
+ def password(self, password):
+ """Sets the password of this LoginReq.
+ User password. # noqa: E501
- :param username: The username of this LoginReq. # noqa: E501
+ :param password: The password of this LoginReq. # noqa: E501
:type: str
"""
- self._username = username
+ self._password = password
@property
- def password(self):
- """Gets the password of this LoginReq. # noqa: E501
+ def username(self):
+ """Gets the username of this LoginReq. # noqa: E501
+ User email used during registration. # noqa: E501
- :return: The password of this LoginReq. # noqa: E501
+ :return: The username of this LoginReq. # noqa: E501
:rtype: str
"""
- return self._password
+ return self._username
- @password.setter
- def password(self, password):
- """Sets the password of this LoginReq.
+ @username.setter
+ def username(self, username):
+ """Sets the username of this LoginReq.
+ User email used during registration. # noqa: E501
- :param password: The password of this LoginReq. # noqa: E501
+ :param username: The username of this LoginReq. # noqa: E501
:type: str
"""
- self._password = password
+ self._username = username
def to_dict(self):
"""Returns the model properties as a dict"""
diff --git a/to_back/ecotaxa_cli_py/models/merge_rsp.py b/to_back/ecotaxa_cli_py/models/merge_rsp.py
index 26846818..9c2d5b20 100644
--- a/to_back/ecotaxa_cli_py/models/merge_rsp.py
+++ b/to_back/ecotaxa_cli_py/models/merge_rsp.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -56,6 +56,7 @@ def __init__(self, errors=[], local_vars_configuration=None): # noqa: E501
def errors(self):
"""Gets the errors of this MergeRsp. # noqa: E501
+ The errors found during processing. # noqa: E501
:return: The errors of this MergeRsp. # noqa: E501
:rtype: list[str]
@@ -66,6 +67,7 @@ def errors(self):
def errors(self, errors):
"""Sets the errors of this MergeRsp.
+ The errors found during processing. # noqa: E501
:param errors: The errors of this MergeRsp. # noqa: E501
:type: list[str]
diff --git a/to_back/ecotaxa_cli_py/models/minimal_user_bo.py b/to_back/ecotaxa_cli_py/models/minimal_user_bo.py
index ab02522a..719a7e64 100644
--- a/to_back/ecotaxa_cli_py/models/minimal_user_bo.py
+++ b/to_back/ecotaxa_cli_py/models/minimal_user_bo.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
diff --git a/to_back/ecotaxa_cli_py/models/object_header_model.py b/to_back/ecotaxa_cli_py/models/object_header_model.py
index 4ed3cca0..d774cddf 100644
--- a/to_back/ecotaxa_cli_py/models/object_header_model.py
+++ b/to_back/ecotaxa_cli_py/models/object_header_model.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -112,8 +112,7 @@ def __init__(self, objid=None, acquisid=None, orig_id=None, objdate=None, objtim
self._object_link = None
self.discriminator = None
- if objid is not None:
- self.objid = objid
+ self.objid = objid
self.acquisid = acquisid
self.orig_id = orig_id
if objdate is not None:
@@ -159,6 +158,7 @@ def __init__(self, objid=None, acquisid=None, orig_id=None, objdate=None, objtim
def objid(self):
"""Gets the objid of this ObjectHeaderModel. # noqa: E501
+ The object Id. # noqa: E501
:return: The objid of this ObjectHeaderModel. # noqa: E501
:rtype: int
@@ -169,10 +169,13 @@ def objid(self):
def objid(self, objid):
"""Sets the objid of this ObjectHeaderModel.
+ The object Id. # noqa: E501
:param objid: The objid of this ObjectHeaderModel. # noqa: E501
:type: int
"""
+ if self.local_vars_configuration.client_side_validation and objid is None: # noqa: E501
+ raise ValueError("Invalid value for `objid`, must not be `None`") # noqa: E501
self._objid = objid
@@ -180,6 +183,7 @@ def objid(self, objid):
def acquisid(self):
"""Gets the acquisid of this ObjectHeaderModel. # noqa: E501
+ The parent acquisition Id. # noqa: E501
:return: The acquisid of this ObjectHeaderModel. # noqa: E501
:rtype: int
@@ -190,6 +194,7 @@ def acquisid(self):
def acquisid(self, acquisid):
"""Sets the acquisid of this ObjectHeaderModel.
+ The parent acquisition Id. # noqa: E501
:param acquisid: The acquisid of this ObjectHeaderModel. # noqa: E501
:type: int
@@ -203,6 +208,7 @@ def acquisid(self, acquisid):
def orig_id(self):
"""Gets the orig_id of this ObjectHeaderModel. # noqa: E501
+ Original object ID from initial TSV load. # noqa: E501
:return: The orig_id of this ObjectHeaderModel. # noqa: E501
:rtype: str
@@ -213,6 +219,7 @@ def orig_id(self):
def orig_id(self, orig_id):
"""Sets the orig_id of this ObjectHeaderModel.
+ Original object ID from initial TSV load. # noqa: E501
:param orig_id: The orig_id of this ObjectHeaderModel. # noqa: E501
:type: str
@@ -268,6 +275,7 @@ def objtime(self, objtime):
def latitude(self):
"""Gets the latitude of this ObjectHeaderModel. # noqa: E501
+ The latitude. # noqa: E501
:return: The latitude of this ObjectHeaderModel. # noqa: E501
:rtype: float
@@ -278,6 +286,7 @@ def latitude(self):
def latitude(self, latitude):
"""Sets the latitude of this ObjectHeaderModel.
+ The latitude. # noqa: E501
:param latitude: The latitude of this ObjectHeaderModel. # noqa: E501
:type: float
@@ -289,6 +298,7 @@ def latitude(self, latitude):
def longitude(self):
"""Gets the longitude of this ObjectHeaderModel. # noqa: E501
+ The longitude. # noqa: E501
:return: The longitude of this ObjectHeaderModel. # noqa: E501
:rtype: float
@@ -299,6 +309,7 @@ def longitude(self):
def longitude(self, longitude):
"""Sets the longitude of this ObjectHeaderModel.
+ The longitude. # noqa: E501
:param longitude: The longitude of this ObjectHeaderModel. # noqa: E501
:type: float
@@ -310,6 +321,7 @@ def longitude(self, longitude):
def depth_min(self):
"""Gets the depth_min of this ObjectHeaderModel. # noqa: E501
+ The min depth. # noqa: E501
:return: The depth_min of this ObjectHeaderModel. # noqa: E501
:rtype: float
@@ -320,6 +332,7 @@ def depth_min(self):
def depth_min(self, depth_min):
"""Sets the depth_min of this ObjectHeaderModel.
+ The min depth. # noqa: E501
:param depth_min: The depth_min of this ObjectHeaderModel. # noqa: E501
:type: float
@@ -331,6 +344,7 @@ def depth_min(self, depth_min):
def depth_max(self):
"""Gets the depth_max of this ObjectHeaderModel. # noqa: E501
+ The min depth. # noqa: E501
:return: The depth_max of this ObjectHeaderModel. # noqa: E501
:rtype: float
@@ -341,6 +355,7 @@ def depth_max(self):
def depth_max(self, depth_max):
"""Sets the depth_max of this ObjectHeaderModel.
+ The min depth. # noqa: E501
:param depth_max: The depth_max of this ObjectHeaderModel. # noqa: E501
:type: float
@@ -352,6 +367,7 @@ def depth_max(self, depth_max):
def sunpos(self):
"""Gets the sunpos of this ObjectHeaderModel. # noqa: E501
+ Sun position, from date, time and coords. # noqa: E501
:return: The sunpos of this ObjectHeaderModel. # noqa: E501
:rtype: str
@@ -362,6 +378,7 @@ def sunpos(self):
def sunpos(self, sunpos):
"""Sets the sunpos of this ObjectHeaderModel.
+ Sun position, from date, time and coords. # noqa: E501
:param sunpos: The sunpos of this ObjectHeaderModel. # noqa: E501
:type: str
@@ -373,6 +390,7 @@ def sunpos(self, sunpos):
def classif_id(self):
"""Gets the classif_id of this ObjectHeaderModel. # noqa: E501
+ The classification Id. # noqa: E501
:return: The classif_id of this ObjectHeaderModel. # noqa: E501
:rtype: int
@@ -383,6 +401,7 @@ def classif_id(self):
def classif_id(self, classif_id):
"""Sets the classif_id of this ObjectHeaderModel.
+ The classification Id. # noqa: E501
:param classif_id: The classif_id of this ObjectHeaderModel. # noqa: E501
:type: int
@@ -394,6 +413,7 @@ def classif_id(self, classif_id):
def classif_qual(self):
"""Gets the classif_qual of this ObjectHeaderModel. # noqa: E501
+ The classification qualification. Could be **P** for predicted, **V** for validated or **D** for Dubious. # noqa: E501
:return: The classif_qual of this ObjectHeaderModel. # noqa: E501
:rtype: str
@@ -404,6 +424,7 @@ def classif_qual(self):
def classif_qual(self, classif_qual):
"""Sets the classif_qual of this ObjectHeaderModel.
+ The classification qualification. Could be **P** for predicted, **V** for validated or **D** for Dubious. # noqa: E501
:param classif_qual: The classif_qual of this ObjectHeaderModel. # noqa: E501
:type: str
@@ -415,6 +436,7 @@ def classif_qual(self, classif_qual):
def classif_who(self):
"""Gets the classif_who of this ObjectHeaderModel. # noqa: E501
+ The user who manualy classify this object. # noqa: E501
:return: The classif_who of this ObjectHeaderModel. # noqa: E501
:rtype: int
@@ -425,6 +447,7 @@ def classif_who(self):
def classif_who(self, classif_who):
"""Sets the classif_who of this ObjectHeaderModel.
+ The user who manualy classify this object. # noqa: E501
:param classif_who: The classif_who of this ObjectHeaderModel. # noqa: E501
:type: int
@@ -436,6 +459,7 @@ def classif_who(self, classif_who):
def classif_when(self):
"""Gets the classif_when of this ObjectHeaderModel. # noqa: E501
+ The classification date. # noqa: E501
:return: The classif_when of this ObjectHeaderModel. # noqa: E501
:rtype: datetime
@@ -446,6 +470,7 @@ def classif_when(self):
def classif_when(self, classif_when):
"""Sets the classif_when of this ObjectHeaderModel.
+ The classification date. # noqa: E501
:param classif_when: The classif_when of this ObjectHeaderModel. # noqa: E501
:type: datetime
@@ -457,6 +482,7 @@ def classif_when(self, classif_when):
def classif_auto_id(self):
"""Gets the classif_auto_id of this ObjectHeaderModel. # noqa: E501
+ Set if the object was ever predicted, remain forever with these value. Reflect the 'last state' only if classif_qual is 'P'. # noqa: E501
:return: The classif_auto_id of this ObjectHeaderModel. # noqa: E501
:rtype: int
@@ -467,6 +493,7 @@ def classif_auto_id(self):
def classif_auto_id(self, classif_auto_id):
"""Sets the classif_auto_id of this ObjectHeaderModel.
+ Set if the object was ever predicted, remain forever with these value. Reflect the 'last state' only if classif_qual is 'P'. # noqa: E501
:param classif_auto_id: The classif_auto_id of this ObjectHeaderModel. # noqa: E501
:type: int
@@ -478,6 +505,7 @@ def classif_auto_id(self, classif_auto_id):
def classif_auto_score(self):
"""Gets the classif_auto_score of this ObjectHeaderModel. # noqa: E501
+ Set if the object was ever predicted, remain forever with these value. Reflect the 'last state' only if classif_qual is 'P'. The classification auto score is generally between 0 and 1. This is a confidence score, in the fact that, the taxon prediction for this object is correct. # noqa: E501
:return: The classif_auto_score of this ObjectHeaderModel. # noqa: E501
:rtype: float
@@ -488,6 +516,7 @@ def classif_auto_score(self):
def classif_auto_score(self, classif_auto_score):
"""Sets the classif_auto_score of this ObjectHeaderModel.
+ Set if the object was ever predicted, remain forever with these value. Reflect the 'last state' only if classif_qual is 'P'. The classification auto score is generally between 0 and 1. This is a confidence score, in the fact that, the taxon prediction for this object is correct. # noqa: E501
:param classif_auto_score: The classif_auto_score of this ObjectHeaderModel. # noqa: E501
:type: float
@@ -499,6 +528,7 @@ def classif_auto_score(self, classif_auto_score):
def classif_auto_when(self):
"""Gets the classif_auto_when of this ObjectHeaderModel. # noqa: E501
+ Set if the object was ever predicted, remain forever with these value. Reflect the 'last state' only if classif_qual is 'P'. The classification date. # noqa: E501
:return: The classif_auto_when of this ObjectHeaderModel. # noqa: E501
:rtype: datetime
@@ -509,6 +539,7 @@ def classif_auto_when(self):
def classif_auto_when(self, classif_auto_when):
"""Sets the classif_auto_when of this ObjectHeaderModel.
+ Set if the object was ever predicted, remain forever with these value. Reflect the 'last state' only if classif_qual is 'P'. The classification date. # noqa: E501
:param classif_auto_when: The classif_auto_when of this ObjectHeaderModel. # noqa: E501
:type: datetime
@@ -520,6 +551,7 @@ def classif_auto_when(self, classif_auto_when):
def classif_crossvalidation_id(self):
"""Gets the classif_crossvalidation_id of this ObjectHeaderModel. # noqa: E501
+ Always NULL in prod. # noqa: E501
:return: The classif_crossvalidation_id of this ObjectHeaderModel. # noqa: E501
:rtype: int
@@ -530,6 +562,7 @@ def classif_crossvalidation_id(self):
def classif_crossvalidation_id(self, classif_crossvalidation_id):
"""Sets the classif_crossvalidation_id of this ObjectHeaderModel.
+ Always NULL in prod. # noqa: E501
:param classif_crossvalidation_id: The classif_crossvalidation_id of this ObjectHeaderModel. # noqa: E501
:type: int
@@ -562,6 +595,7 @@ def complement_info(self, complement_info):
def similarity(self):
"""Gets the similarity of this ObjectHeaderModel. # noqa: E501
+ Always NULL in prod. # noqa: E501
:return: The similarity of this ObjectHeaderModel. # noqa: E501
:rtype: float
@@ -572,6 +606,7 @@ def similarity(self):
def similarity(self, similarity):
"""Sets the similarity of this ObjectHeaderModel.
+ Always NULL in prod. # noqa: E501
:param similarity: The similarity of this ObjectHeaderModel. # noqa: E501
:type: float
@@ -604,6 +639,7 @@ def random_value(self, random_value):
def object_link(self):
"""Gets the object_link of this ObjectHeaderModel. # noqa: E501
+ Object link. # noqa: E501
:return: The object_link of this ObjectHeaderModel. # noqa: E501
:rtype: str
@@ -614,6 +650,7 @@ def object_link(self):
def object_link(self, object_link):
"""Sets the object_link of this ObjectHeaderModel.
+ Object link. # noqa: E501
:param object_link: The object_link of this ObjectHeaderModel. # noqa: E501
:type: str
diff --git a/to_back/ecotaxa_cli_py/models/object_model.py b/to_back/ecotaxa_cli_py/models/object_model.py
index a44b3273..d8e7643e 100644
--- a/to_back/ecotaxa_cli_py/models/object_model.py
+++ b/to_back/ecotaxa_cli_py/models/object_model.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -124,8 +124,7 @@ def __init__(self, objid=None, acquisid=None, orig_id=None, objdate=None, objtim
self._free_columns = None
self.discriminator = None
- if objid is not None:
- self.objid = objid
+ self.objid = objid
self.acquisid = acquisid
self.orig_id = orig_id
if objdate is not None:
@@ -177,6 +176,7 @@ def __init__(self, objid=None, acquisid=None, orig_id=None, objdate=None, objtim
def objid(self):
"""Gets the objid of this ObjectModel. # noqa: E501
+ The object Id. # noqa: E501
:return: The objid of this ObjectModel. # noqa: E501
:rtype: int
@@ -187,10 +187,13 @@ def objid(self):
def objid(self, objid):
"""Sets the objid of this ObjectModel.
+ The object Id. # noqa: E501
:param objid: The objid of this ObjectModel. # noqa: E501
:type: int
"""
+ if self.local_vars_configuration.client_side_validation and objid is None: # noqa: E501
+ raise ValueError("Invalid value for `objid`, must not be `None`") # noqa: E501
self._objid = objid
@@ -198,6 +201,7 @@ def objid(self, objid):
def acquisid(self):
"""Gets the acquisid of this ObjectModel. # noqa: E501
+ The parent acquisition Id. # noqa: E501
:return: The acquisid of this ObjectModel. # noqa: E501
:rtype: int
@@ -208,6 +212,7 @@ def acquisid(self):
def acquisid(self, acquisid):
"""Sets the acquisid of this ObjectModel.
+ The parent acquisition Id. # noqa: E501
:param acquisid: The acquisid of this ObjectModel. # noqa: E501
:type: int
@@ -221,6 +226,7 @@ def acquisid(self, acquisid):
def orig_id(self):
"""Gets the orig_id of this ObjectModel. # noqa: E501
+ Original object ID from initial TSV load. # noqa: E501
:return: The orig_id of this ObjectModel. # noqa: E501
:rtype: str
@@ -231,6 +237,7 @@ def orig_id(self):
def orig_id(self, orig_id):
"""Sets the orig_id of this ObjectModel.
+ Original object ID from initial TSV load. # noqa: E501
:param orig_id: The orig_id of this ObjectModel. # noqa: E501
:type: str
@@ -286,6 +293,7 @@ def objtime(self, objtime):
def latitude(self):
"""Gets the latitude of this ObjectModel. # noqa: E501
+ The latitude. # noqa: E501
:return: The latitude of this ObjectModel. # noqa: E501
:rtype: float
@@ -296,6 +304,7 @@ def latitude(self):
def latitude(self, latitude):
"""Sets the latitude of this ObjectModel.
+ The latitude. # noqa: E501
:param latitude: The latitude of this ObjectModel. # noqa: E501
:type: float
@@ -307,6 +316,7 @@ def latitude(self, latitude):
def longitude(self):
"""Gets the longitude of this ObjectModel. # noqa: E501
+ The longitude. # noqa: E501
:return: The longitude of this ObjectModel. # noqa: E501
:rtype: float
@@ -317,6 +327,7 @@ def longitude(self):
def longitude(self, longitude):
"""Sets the longitude of this ObjectModel.
+ The longitude. # noqa: E501
:param longitude: The longitude of this ObjectModel. # noqa: E501
:type: float
@@ -328,6 +339,7 @@ def longitude(self, longitude):
def depth_min(self):
"""Gets the depth_min of this ObjectModel. # noqa: E501
+ The min depth. # noqa: E501
:return: The depth_min of this ObjectModel. # noqa: E501
:rtype: float
@@ -338,6 +350,7 @@ def depth_min(self):
def depth_min(self, depth_min):
"""Sets the depth_min of this ObjectModel.
+ The min depth. # noqa: E501
:param depth_min: The depth_min of this ObjectModel. # noqa: E501
:type: float
@@ -349,6 +362,7 @@ def depth_min(self, depth_min):
def depth_max(self):
"""Gets the depth_max of this ObjectModel. # noqa: E501
+ The min depth. # noqa: E501
:return: The depth_max of this ObjectModel. # noqa: E501
:rtype: float
@@ -359,6 +373,7 @@ def depth_max(self):
def depth_max(self, depth_max):
"""Sets the depth_max of this ObjectModel.
+ The min depth. # noqa: E501
:param depth_max: The depth_max of this ObjectModel. # noqa: E501
:type: float
@@ -370,6 +385,7 @@ def depth_max(self, depth_max):
def sunpos(self):
"""Gets the sunpos of this ObjectModel. # noqa: E501
+ Sun position, from date, time and coords. # noqa: E501
:return: The sunpos of this ObjectModel. # noqa: E501
:rtype: str
@@ -380,6 +396,7 @@ def sunpos(self):
def sunpos(self, sunpos):
"""Sets the sunpos of this ObjectModel.
+ Sun position, from date, time and coords. # noqa: E501
:param sunpos: The sunpos of this ObjectModel. # noqa: E501
:type: str
@@ -391,6 +408,7 @@ def sunpos(self, sunpos):
def classif_id(self):
"""Gets the classif_id of this ObjectModel. # noqa: E501
+ The classification Id. # noqa: E501
:return: The classif_id of this ObjectModel. # noqa: E501
:rtype: int
@@ -401,6 +419,7 @@ def classif_id(self):
def classif_id(self, classif_id):
"""Sets the classif_id of this ObjectModel.
+ The classification Id. # noqa: E501
:param classif_id: The classif_id of this ObjectModel. # noqa: E501
:type: int
@@ -412,6 +431,7 @@ def classif_id(self, classif_id):
def classif_qual(self):
"""Gets the classif_qual of this ObjectModel. # noqa: E501
+ The classification qualification. Could be **P** for predicted, **V** for validated or **D** for Dubious. # noqa: E501
:return: The classif_qual of this ObjectModel. # noqa: E501
:rtype: str
@@ -422,6 +442,7 @@ def classif_qual(self):
def classif_qual(self, classif_qual):
"""Sets the classif_qual of this ObjectModel.
+ The classification qualification. Could be **P** for predicted, **V** for validated or **D** for Dubious. # noqa: E501
:param classif_qual: The classif_qual of this ObjectModel. # noqa: E501
:type: str
@@ -433,6 +454,7 @@ def classif_qual(self, classif_qual):
def classif_who(self):
"""Gets the classif_who of this ObjectModel. # noqa: E501
+ The user who manualy classify this object. # noqa: E501
:return: The classif_who of this ObjectModel. # noqa: E501
:rtype: int
@@ -443,6 +465,7 @@ def classif_who(self):
def classif_who(self, classif_who):
"""Sets the classif_who of this ObjectModel.
+ The user who manualy classify this object. # noqa: E501
:param classif_who: The classif_who of this ObjectModel. # noqa: E501
:type: int
@@ -454,6 +477,7 @@ def classif_who(self, classif_who):
def classif_when(self):
"""Gets the classif_when of this ObjectModel. # noqa: E501
+ The classification date. # noqa: E501
:return: The classif_when of this ObjectModel. # noqa: E501
:rtype: datetime
@@ -464,6 +488,7 @@ def classif_when(self):
def classif_when(self, classif_when):
"""Sets the classif_when of this ObjectModel.
+ The classification date. # noqa: E501
:param classif_when: The classif_when of this ObjectModel. # noqa: E501
:type: datetime
@@ -475,6 +500,7 @@ def classif_when(self, classif_when):
def classif_auto_id(self):
"""Gets the classif_auto_id of this ObjectModel. # noqa: E501
+ Set if the object was ever predicted, remain forever with these value. Reflect the 'last state' only if classif_qual is 'P'. # noqa: E501
:return: The classif_auto_id of this ObjectModel. # noqa: E501
:rtype: int
@@ -485,6 +511,7 @@ def classif_auto_id(self):
def classif_auto_id(self, classif_auto_id):
"""Sets the classif_auto_id of this ObjectModel.
+ Set if the object was ever predicted, remain forever with these value. Reflect the 'last state' only if classif_qual is 'P'. # noqa: E501
:param classif_auto_id: The classif_auto_id of this ObjectModel. # noqa: E501
:type: int
@@ -496,6 +523,7 @@ def classif_auto_id(self, classif_auto_id):
def classif_auto_score(self):
"""Gets the classif_auto_score of this ObjectModel. # noqa: E501
+ Set if the object was ever predicted, remain forever with these value. Reflect the 'last state' only if classif_qual is 'P'. The classification auto score is generally between 0 and 1. This is a confidence score, in the fact that, the taxon prediction for this object is correct. # noqa: E501
:return: The classif_auto_score of this ObjectModel. # noqa: E501
:rtype: float
@@ -506,6 +534,7 @@ def classif_auto_score(self):
def classif_auto_score(self, classif_auto_score):
"""Sets the classif_auto_score of this ObjectModel.
+ Set if the object was ever predicted, remain forever with these value. Reflect the 'last state' only if classif_qual is 'P'. The classification auto score is generally between 0 and 1. This is a confidence score, in the fact that, the taxon prediction for this object is correct. # noqa: E501
:param classif_auto_score: The classif_auto_score of this ObjectModel. # noqa: E501
:type: float
@@ -517,6 +546,7 @@ def classif_auto_score(self, classif_auto_score):
def classif_auto_when(self):
"""Gets the classif_auto_when of this ObjectModel. # noqa: E501
+ Set if the object was ever predicted, remain forever with these value. Reflect the 'last state' only if classif_qual is 'P'. The classification date. # noqa: E501
:return: The classif_auto_when of this ObjectModel. # noqa: E501
:rtype: datetime
@@ -527,6 +557,7 @@ def classif_auto_when(self):
def classif_auto_when(self, classif_auto_when):
"""Sets the classif_auto_when of this ObjectModel.
+ Set if the object was ever predicted, remain forever with these value. Reflect the 'last state' only if classif_qual is 'P'. The classification date. # noqa: E501
:param classif_auto_when: The classif_auto_when of this ObjectModel. # noqa: E501
:type: datetime
@@ -538,6 +569,7 @@ def classif_auto_when(self, classif_auto_when):
def classif_crossvalidation_id(self):
"""Gets the classif_crossvalidation_id of this ObjectModel. # noqa: E501
+ Always NULL in prod. # noqa: E501
:return: The classif_crossvalidation_id of this ObjectModel. # noqa: E501
:rtype: int
@@ -548,6 +580,7 @@ def classif_crossvalidation_id(self):
def classif_crossvalidation_id(self, classif_crossvalidation_id):
"""Sets the classif_crossvalidation_id of this ObjectModel.
+ Always NULL in prod. # noqa: E501
:param classif_crossvalidation_id: The classif_crossvalidation_id of this ObjectModel. # noqa: E501
:type: int
@@ -580,6 +613,7 @@ def complement_info(self, complement_info):
def similarity(self):
"""Gets the similarity of this ObjectModel. # noqa: E501
+ Always NULL in prod. # noqa: E501
:return: The similarity of this ObjectModel. # noqa: E501
:rtype: float
@@ -590,6 +624,7 @@ def similarity(self):
def similarity(self, similarity):
"""Sets the similarity of this ObjectModel.
+ Always NULL in prod. # noqa: E501
:param similarity: The similarity of this ObjectModel. # noqa: E501
:type: float
@@ -622,6 +657,7 @@ def random_value(self, random_value):
def object_link(self):
"""Gets the object_link of this ObjectModel. # noqa: E501
+ Object link. # noqa: E501
:return: The object_link of this ObjectModel. # noqa: E501
:rtype: str
@@ -632,6 +668,7 @@ def object_link(self):
def object_link(self, object_link):
"""Sets the object_link of this ObjectModel.
+ Object link. # noqa: E501
:param object_link: The object_link of this ObjectModel. # noqa: E501
:type: str
@@ -643,6 +680,7 @@ def object_link(self, object_link):
def sample_id(self):
"""Gets the sample_id of this ObjectModel. # noqa: E501
+ Sample (i.e. parent of parent acquisition) ID. # noqa: E501
:return: The sample_id of this ObjectModel. # noqa: E501
:rtype: int
@@ -653,6 +691,7 @@ def sample_id(self):
def sample_id(self, sample_id):
"""Sets the sample_id of this ObjectModel.
+ Sample (i.e. parent of parent acquisition) ID. # noqa: E501
:param sample_id: The sample_id of this ObjectModel. # noqa: E501
:type: int
@@ -666,6 +705,7 @@ def sample_id(self, sample_id):
def project_id(self):
"""Gets the project_id of this ObjectModel. # noqa: E501
+ Project (i.e. parent of sample) ID. # noqa: E501
:return: The project_id of this ObjectModel. # noqa: E501
:rtype: int
@@ -676,6 +716,7 @@ def project_id(self):
def project_id(self, project_id):
"""Sets the project_id of this ObjectModel.
+ Project (i.e. parent of sample) ID. # noqa: E501
:param project_id: The project_id of this ObjectModel. # noqa: E501
:type: int
@@ -689,6 +730,7 @@ def project_id(self, project_id):
def images(self):
"""Gets the images of this ObjectModel. # noqa: E501
+ Images for this object. # noqa: E501
:return: The images of this ObjectModel. # noqa: E501
:rtype: list[ImageModel]
@@ -699,6 +741,7 @@ def images(self):
def images(self, images):
"""Sets the images of this ObjectModel.
+ Images for this object. # noqa: E501
:param images: The images of this ObjectModel. # noqa: E501
:type: list[ImageModel]
@@ -710,6 +753,7 @@ def images(self, images):
def free_columns(self):
"""Gets the free_columns of this ObjectModel. # noqa: E501
+ Free columns from object mapping in project. # noqa: E501
:return: The free_columns of this ObjectModel. # noqa: E501
:rtype: object
@@ -720,6 +764,7 @@ def free_columns(self):
def free_columns(self, free_columns):
"""Sets the free_columns of this ObjectModel.
+ Free columns from object mapping in project. # noqa: E501
:param free_columns: The free_columns of this ObjectModel. # noqa: E501
:type: object
diff --git a/to_back/ecotaxa_cli_py/models/object_set_query_rsp.py b/to_back/ecotaxa_cli_py/models/object_set_query_rsp.py
index 3677065b..b163546e 100644
--- a/to_back/ecotaxa_cli_py/models/object_set_query_rsp.py
+++ b/to_back/ecotaxa_cli_py/models/object_set_query_rsp.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -81,6 +81,7 @@ def __init__(self, object_ids=[], acquisition_ids=[], sample_ids=[], project_ids
def object_ids(self):
"""Gets the object_ids of this ObjectSetQueryRsp. # noqa: E501
+ Matching object IDs. # noqa: E501
:return: The object_ids of this ObjectSetQueryRsp. # noqa: E501
:rtype: list[int]
@@ -91,6 +92,7 @@ def object_ids(self):
def object_ids(self, object_ids):
"""Sets the object_ids of this ObjectSetQueryRsp.
+ Matching object IDs. # noqa: E501
:param object_ids: The object_ids of this ObjectSetQueryRsp. # noqa: E501
:type: list[int]
@@ -102,6 +104,7 @@ def object_ids(self, object_ids):
def acquisition_ids(self):
"""Gets the acquisition_ids of this ObjectSetQueryRsp. # noqa: E501
+ Parent (acquisition) IDs. # noqa: E501
:return: The acquisition_ids of this ObjectSetQueryRsp. # noqa: E501
:rtype: list[int]
@@ -112,6 +115,7 @@ def acquisition_ids(self):
def acquisition_ids(self, acquisition_ids):
"""Sets the acquisition_ids of this ObjectSetQueryRsp.
+ Parent (acquisition) IDs. # noqa: E501
:param acquisition_ids: The acquisition_ids of this ObjectSetQueryRsp. # noqa: E501
:type: list[int]
@@ -123,6 +127,7 @@ def acquisition_ids(self, acquisition_ids):
def sample_ids(self):
"""Gets the sample_ids of this ObjectSetQueryRsp. # noqa: E501
+ Parent (sample) IDs. # noqa: E501
:return: The sample_ids of this ObjectSetQueryRsp. # noqa: E501
:rtype: list[int]
@@ -133,6 +138,7 @@ def sample_ids(self):
def sample_ids(self, sample_ids):
"""Sets the sample_ids of this ObjectSetQueryRsp.
+ Parent (sample) IDs. # noqa: E501
:param sample_ids: The sample_ids of this ObjectSetQueryRsp. # noqa: E501
:type: list[int]
@@ -144,6 +150,7 @@ def sample_ids(self, sample_ids):
def project_ids(self):
"""Gets the project_ids of this ObjectSetQueryRsp. # noqa: E501
+ Project Ids. # noqa: E501
:return: The project_ids of this ObjectSetQueryRsp. # noqa: E501
:rtype: list[int]
@@ -154,6 +161,7 @@ def project_ids(self):
def project_ids(self, project_ids):
"""Sets the project_ids of this ObjectSetQueryRsp.
+ Project Ids. # noqa: E501
:param project_ids: The project_ids of this ObjectSetQueryRsp. # noqa: E501
:type: list[int]
@@ -165,6 +173,7 @@ def project_ids(self, project_ids):
def details(self):
"""Gets the details of this ObjectSetQueryRsp. # noqa: E501
+ Requested fields, in request order. # noqa: E501
:return: The details of this ObjectSetQueryRsp. # noqa: E501
:rtype: list[list[object]]
@@ -175,6 +184,7 @@ def details(self):
def details(self, details):
"""Sets the details of this ObjectSetQueryRsp.
+ Requested fields, in request order. # noqa: E501
:param details: The details of this ObjectSetQueryRsp. # noqa: E501
:type: list[list[object]]
@@ -186,6 +196,7 @@ def details(self, details):
def total_ids(self):
"""Gets the total_ids of this ObjectSetQueryRsp. # noqa: E501
+ Total rows returned by the query, even if it was window-ed. # noqa: E501
:return: The total_ids of this ObjectSetQueryRsp. # noqa: E501
:rtype: int
@@ -196,6 +207,7 @@ def total_ids(self):
def total_ids(self, total_ids):
"""Sets the total_ids of this ObjectSetQueryRsp.
+ Total rows returned by the query, even if it was window-ed. # noqa: E501
:param total_ids: The total_ids of this ObjectSetQueryRsp. # noqa: E501
:type: int
diff --git a/to_back/ecotaxa_cli_py/models/object_set_revert_to_history_rsp.py b/to_back/ecotaxa_cli_py/models/object_set_revert_to_history_rsp.py
index 2e8f225a..2d01f64a 100644
--- a/to_back/ecotaxa_cli_py/models/object_set_revert_to_history_rsp.py
+++ b/to_back/ecotaxa_cli_py/models/object_set_revert_to_history_rsp.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -61,6 +61,7 @@ def __init__(self, last_entries=[], classif_info=None, local_vars_configuration=
def last_entries(self):
"""Gets the last_entries of this ObjectSetRevertToHistoryRsp. # noqa: E501
+ Object + last classification # noqa: E501
:return: The last_entries of this ObjectSetRevertToHistoryRsp. # noqa: E501
:rtype: list[HistoricalLastClassif]
@@ -71,6 +72,7 @@ def last_entries(self):
def last_entries(self, last_entries):
"""Sets the last_entries of this ObjectSetRevertToHistoryRsp.
+ Object + last classification # noqa: E501
:param last_entries: The last_entries of this ObjectSetRevertToHistoryRsp. # noqa: E501
:type: list[HistoricalLastClassif]
@@ -82,6 +84,7 @@ def last_entries(self, last_entries):
def classif_info(self):
"""Gets the classif_info of this ObjectSetRevertToHistoryRsp. # noqa: E501
+ Classification names (self+parent) for involved IDs. # noqa: E501
:return: The classif_info of this ObjectSetRevertToHistoryRsp. # noqa: E501
:rtype: object
@@ -92,6 +95,7 @@ def classif_info(self):
def classif_info(self, classif_info):
"""Sets the classif_info of this ObjectSetRevertToHistoryRsp.
+ Classification names (self+parent) for involved IDs. # noqa: E501
:param classif_info: The classif_info of this ObjectSetRevertToHistoryRsp. # noqa: E501
:type: object
diff --git a/to_back/ecotaxa_cli_py/models/object_set_summary_rsp.py b/to_back/ecotaxa_cli_py/models/object_set_summary_rsp.py
index 19f1838d..6a27b67c 100644
--- a/to_back/ecotaxa_cli_py/models/object_set_summary_rsp.py
+++ b/to_back/ecotaxa_cli_py/models/object_set_summary_rsp.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -71,6 +71,7 @@ def __init__(self, total_objects=None, validated_objects=None, dubious_objects=N
def total_objects(self):
"""Gets the total_objects of this ObjectSetSummaryRsp. # noqa: E501
+ Total number of objects in the set. # noqa: E501
:return: The total_objects of this ObjectSetSummaryRsp. # noqa: E501
:rtype: int
@@ -81,6 +82,7 @@ def total_objects(self):
def total_objects(self, total_objects):
"""Sets the total_objects of this ObjectSetSummaryRsp.
+ Total number of objects in the set. # noqa: E501
:param total_objects: The total_objects of this ObjectSetSummaryRsp. # noqa: E501
:type: int
@@ -92,6 +94,7 @@ def total_objects(self, total_objects):
def validated_objects(self):
"""Gets the validated_objects of this ObjectSetSummaryRsp. # noqa: E501
+ Number of validated objects in the set. # noqa: E501
:return: The validated_objects of this ObjectSetSummaryRsp. # noqa: E501
:rtype: int
@@ -102,6 +105,7 @@ def validated_objects(self):
def validated_objects(self, validated_objects):
"""Sets the validated_objects of this ObjectSetSummaryRsp.
+ Number of validated objects in the set. # noqa: E501
:param validated_objects: The validated_objects of this ObjectSetSummaryRsp. # noqa: E501
:type: int
@@ -113,6 +117,7 @@ def validated_objects(self, validated_objects):
def dubious_objects(self):
"""Gets the dubious_objects of this ObjectSetSummaryRsp. # noqa: E501
+ Number of dubious objects in the set. # noqa: E501
:return: The dubious_objects of this ObjectSetSummaryRsp. # noqa: E501
:rtype: int
@@ -123,6 +128,7 @@ def dubious_objects(self):
def dubious_objects(self, dubious_objects):
"""Sets the dubious_objects of this ObjectSetSummaryRsp.
+ Number of dubious objects in the set. # noqa: E501
:param dubious_objects: The dubious_objects of this ObjectSetSummaryRsp. # noqa: E501
:type: int
@@ -134,6 +140,7 @@ def dubious_objects(self, dubious_objects):
def predicted_objects(self):
"""Gets the predicted_objects of this ObjectSetSummaryRsp. # noqa: E501
+ Number of predicted objects in the set. # noqa: E501
:return: The predicted_objects of this ObjectSetSummaryRsp. # noqa: E501
:rtype: int
@@ -144,6 +151,7 @@ def predicted_objects(self):
def predicted_objects(self, predicted_objects):
"""Sets the predicted_objects of this ObjectSetSummaryRsp.
+ Number of predicted objects in the set. # noqa: E501
:param predicted_objects: The predicted_objects of this ObjectSetSummaryRsp. # noqa: E501
:type: int
diff --git a/to_back/ecotaxa_cli_py/models/prediction_req.py b/to_back/ecotaxa_cli_py/models/prediction_req.py
new file mode 100644
index 00000000..04bbee46
--- /dev/null
+++ b/to_back/ecotaxa_cli_py/models/prediction_req.py
@@ -0,0 +1,295 @@
+# coding: utf-8
+
+"""
+ EcoTaxa
+
+ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
+
+ The version of the OpenAPI document: 0.0.23
+ Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from to_back.ecotaxa_cli_py.configuration import Configuration
+
+
+class PredictionReq(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 = {
+ 'project_id': 'int',
+ 'source_project_ids': 'list[int]',
+ 'learning_limit': 'int',
+ 'features': 'list[str]',
+ 'categories': 'list[int]',
+ 'use_scn': 'bool',
+ 'pre_mapping': 'dict(str, int)'
+ }
+
+ attribute_map = {
+ 'project_id': 'project_id',
+ 'source_project_ids': 'source_project_ids',
+ 'learning_limit': 'learning_limit',
+ 'features': 'features',
+ 'categories': 'categories',
+ 'use_scn': 'use_scn',
+ 'pre_mapping': 'pre_mapping'
+ }
+
+ def __init__(self, project_id=None, source_project_ids=None, learning_limit=None, features=None, categories=None, use_scn=False, pre_mapping=None, local_vars_configuration=None): # noqa: E501
+ """PredictionReq - a model defined in OpenAPI""" # noqa: E501
+ if local_vars_configuration is None:
+ local_vars_configuration = Configuration()
+ self.local_vars_configuration = local_vars_configuration
+
+ self._project_id = None
+ self._source_project_ids = None
+ self._learning_limit = None
+ self._features = None
+ self._categories = None
+ self._use_scn = None
+ self._pre_mapping = None
+ self.discriminator = None
+
+ self.project_id = project_id
+ self.source_project_ids = source_project_ids
+ if learning_limit is not None:
+ self.learning_limit = learning_limit
+ self.features = features
+ self.categories = categories
+ if use_scn is not None:
+ self.use_scn = use_scn
+ self.pre_mapping = pre_mapping
+
+ @property
+ def project_id(self):
+ """Gets the project_id of this PredictionReq. # noqa: E501
+
+ The destination project, of which objects will be predicted. # noqa: E501
+
+ :return: The project_id of this PredictionReq. # noqa: E501
+ :rtype: int
+ """
+ return self._project_id
+
+ @project_id.setter
+ def project_id(self, project_id):
+ """Sets the project_id of this PredictionReq.
+
+ The destination project, of which objects will be predicted. # noqa: E501
+
+ :param project_id: The project_id of this PredictionReq. # noqa: E501
+ :type: int
+ """
+ if self.local_vars_configuration.client_side_validation and project_id is None: # noqa: E501
+ raise ValueError("Invalid value for `project_id`, must not be `None`") # noqa: E501
+
+ self._project_id = project_id
+
+ @property
+ def source_project_ids(self):
+ """Gets the source_project_ids of this PredictionReq. # noqa: E501
+
+ The source projects, objects in them will serve as reference. # noqa: E501
+
+ :return: The source_project_ids of this PredictionReq. # noqa: E501
+ :rtype: list[int]
+ """
+ return self._source_project_ids
+
+ @source_project_ids.setter
+ def source_project_ids(self, source_project_ids):
+ """Sets the source_project_ids of this PredictionReq.
+
+ The source projects, objects in them will serve as reference. # noqa: E501
+
+ :param source_project_ids: The source_project_ids of this PredictionReq. # noqa: E501
+ :type: list[int]
+ """
+ if self.local_vars_configuration.client_side_validation and source_project_ids is None: # noqa: E501
+ raise ValueError("Invalid value for `source_project_ids`, must not be `None`") # noqa: E501
+
+ self._source_project_ids = source_project_ids
+
+ @property
+ def learning_limit(self):
+ """Gets the learning_limit of this PredictionReq. # noqa: E501
+
+ When set (to a positive value), there will be this number of objects, _per category_, in the learning set. # noqa: E501
+
+ :return: The learning_limit of this PredictionReq. # noqa: E501
+ :rtype: int
+ """
+ return self._learning_limit
+
+ @learning_limit.setter
+ def learning_limit(self, learning_limit):
+ """Sets the learning_limit of this PredictionReq.
+
+ When set (to a positive value), there will be this number of objects, _per category_, in the learning set. # noqa: E501
+
+ :param learning_limit: The learning_limit of this PredictionReq. # noqa: E501
+ :type: int
+ """
+
+ self._learning_limit = learning_limit
+
+ @property
+ def features(self):
+ """Gets the features of this PredictionReq. # noqa: E501
+
+ The object features AKA free column, to use in the algorithm. Features must be common to all projects, source ones and destination one. # noqa: E501
+
+ :return: The features of this PredictionReq. # noqa: E501
+ :rtype: list[str]
+ """
+ return self._features
+
+ @features.setter
+ def features(self, features):
+ """Sets the features of this PredictionReq.
+
+ The object features AKA free column, to use in the algorithm. Features must be common to all projects, source ones and destination one. # noqa: E501
+
+ :param features: The features of this PredictionReq. # noqa: E501
+ :type: list[str]
+ """
+ if self.local_vars_configuration.client_side_validation and features is None: # noqa: E501
+ raise ValueError("Invalid value for `features`, must not be `None`") # noqa: E501
+
+ self._features = features
+
+ @property
+ def categories(self):
+ """Gets the categories of this PredictionReq. # noqa: E501
+
+ In source projects, only objects validated with these categories will be considered. # noqa: E501
+
+ :return: The categories of this PredictionReq. # noqa: E501
+ :rtype: list[int]
+ """
+ return self._categories
+
+ @categories.setter
+ def categories(self, categories):
+ """Sets the categories of this PredictionReq.
+
+ In source projects, only objects validated with these categories will be considered. # noqa: E501
+
+ :param categories: The categories of this PredictionReq. # noqa: E501
+ :type: list[int]
+ """
+ if self.local_vars_configuration.client_side_validation and categories is None: # noqa: E501
+ raise ValueError("Invalid value for `categories`, must not be `None`") # noqa: E501
+
+ self._categories = categories
+
+ @property
+ def use_scn(self):
+ """Gets the use_scn of this PredictionReq. # noqa: E501
+
+ Use extra features, generated using the image, for improving the prediction. # noqa: E501
+
+ :return: The use_scn of this PredictionReq. # noqa: E501
+ :rtype: bool
+ """
+ return self._use_scn
+
+ @use_scn.setter
+ def use_scn(self, use_scn):
+ """Sets the use_scn of this PredictionReq.
+
+ Use extra features, generated using the image, for improving the prediction. # noqa: E501
+
+ :param use_scn: The use_scn of this PredictionReq. # noqa: E501
+ :type: bool
+ """
+
+ self._use_scn = use_scn
+
+ @property
+ def pre_mapping(self):
+ """Gets the pre_mapping of this PredictionReq. # noqa: E501
+
+ Categories in keys become value one before launching the ML algorithm. Any unknown value is ignored. # noqa: E501
+
+ :return: The pre_mapping of this PredictionReq. # noqa: E501
+ :rtype: dict(str, int)
+ """
+ return self._pre_mapping
+
+ @pre_mapping.setter
+ def pre_mapping(self, pre_mapping):
+ """Sets the pre_mapping of this PredictionReq.
+
+ Categories in keys become value one before launching the ML algorithm. Any unknown value is ignored. # noqa: E501
+
+ :param pre_mapping: The pre_mapping of this PredictionReq. # noqa: E501
+ :type: dict(str, int)
+ """
+ if self.local_vars_configuration.client_side_validation and pre_mapping is None: # noqa: E501
+ raise ValueError("Invalid value for `pre_mapping`, must not be `None`") # noqa: E501
+
+ self._pre_mapping = pre_mapping
+
+ 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, PredictionReq):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, PredictionReq):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/to_back/ecotaxa_cli_py/models/prediction_rsp.py b/to_back/ecotaxa_cli_py/models/prediction_rsp.py
new file mode 100644
index 00000000..3fd3cfaf
--- /dev/null
+++ b/to_back/ecotaxa_cli_py/models/prediction_rsp.py
@@ -0,0 +1,178 @@
+# coding: utf-8
+
+"""
+ EcoTaxa
+
+ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
+
+ The version of the OpenAPI document: 0.0.23
+ Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from to_back.ecotaxa_cli_py.configuration import Configuration
+
+
+class PredictionRsp(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 = {
+ 'errors': 'list[str]',
+ 'warnings': 'list[str]',
+ 'job_id': 'int'
+ }
+
+ attribute_map = {
+ 'errors': 'errors',
+ 'warnings': 'warnings',
+ 'job_id': 'job_id'
+ }
+
+ def __init__(self, errors=[], warnings=[], job_id=0, local_vars_configuration=None): # noqa: E501
+ """PredictionRsp - a model defined in OpenAPI""" # noqa: E501
+ if local_vars_configuration is None:
+ local_vars_configuration = Configuration()
+ self.local_vars_configuration = local_vars_configuration
+
+ self._errors = None
+ self._warnings = None
+ self._job_id = None
+ self.discriminator = None
+
+ if errors is not None:
+ self.errors = errors
+ if warnings is not None:
+ self.warnings = warnings
+ if job_id is not None:
+ self.job_id = job_id
+
+ @property
+ def errors(self):
+ """Gets the errors of this PredictionRsp. # noqa: E501
+
+ Showstopper problems found while preparing the prediction. # noqa: E501
+
+ :return: The errors of this PredictionRsp. # noqa: E501
+ :rtype: list[str]
+ """
+ return self._errors
+
+ @errors.setter
+ def errors(self, errors):
+ """Sets the errors of this PredictionRsp.
+
+ Showstopper problems found while preparing the prediction. # noqa: E501
+
+ :param errors: The errors of this PredictionRsp. # noqa: E501
+ :type: list[str]
+ """
+
+ self._errors = errors
+
+ @property
+ def warnings(self):
+ """Gets the warnings of this PredictionRsp. # noqa: E501
+
+ Problems found while preparing the prediction. # noqa: E501
+
+ :return: The warnings of this PredictionRsp. # noqa: E501
+ :rtype: list[str]
+ """
+ return self._warnings
+
+ @warnings.setter
+ def warnings(self, warnings):
+ """Sets the warnings of this PredictionRsp.
+
+ Problems found while preparing the prediction. # noqa: E501
+
+ :param warnings: The warnings of this PredictionRsp. # noqa: E501
+ :type: list[str]
+ """
+
+ self._warnings = warnings
+
+ @property
+ def job_id(self):
+ """Gets the job_id of this PredictionRsp. # noqa: E501
+
+ The created job, 0 if there were problems. # noqa: E501
+
+ :return: The job_id of this PredictionRsp. # noqa: E501
+ :rtype: int
+ """
+ return self._job_id
+
+ @job_id.setter
+ def job_id(self, job_id):
+ """Sets the job_id of this PredictionRsp.
+
+ The created job, 0 if there were problems. # noqa: E501
+
+ :param job_id: The job_id of this PredictionRsp. # noqa: E501
+ :type: int
+ """
+
+ self._job_id = job_id
+
+ 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, PredictionRsp):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, PredictionRsp):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/to_back/ecotaxa_cli_py/models/process_model.py b/to_back/ecotaxa_cli_py/models/process_model.py
index c4c04e68..4706eadd 100644
--- a/to_back/ecotaxa_cli_py/models/process_model.py
+++ b/to_back/ecotaxa_cli_py/models/process_model.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -64,6 +64,7 @@ def __init__(self, processid=None, orig_id=None, free_columns=None, local_vars_c
def processid(self):
"""Gets the processid of this ProcessModel. # noqa: E501
+ The process Id. # noqa: E501
:return: The processid of this ProcessModel. # noqa: E501
:rtype: int
@@ -74,6 +75,7 @@ def processid(self):
def processid(self, processid):
"""Sets the processid of this ProcessModel.
+ The process Id. # noqa: E501
:param processid: The processid of this ProcessModel. # noqa: E501
:type: int
@@ -87,6 +89,7 @@ def processid(self, processid):
def orig_id(self):
"""Gets the orig_id of this ProcessModel. # noqa: E501
+ Original process ID from initial TSV load. # noqa: E501
:return: The orig_id of this ProcessModel. # noqa: E501
:rtype: str
@@ -97,6 +100,7 @@ def orig_id(self):
def orig_id(self, orig_id):
"""Sets the orig_id of this ProcessModel.
+ Original process ID from initial TSV load. # noqa: E501
:param orig_id: The orig_id of this ProcessModel. # noqa: E501
:type: str
diff --git a/to_back/ecotaxa_cli_py/models/project_filters.py b/to_back/ecotaxa_cli_py/models/project_filters.py
index 687d1f4d..5443f5c8 100644
--- a/to_back/ecotaxa_cli_py/models/project_filters.py
+++ b/to_back/ecotaxa_cli_py/models/project_filters.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -186,6 +186,7 @@ def __init__(self, taxo=None, taxochild=None, statusfilter=None, map_n=None, map
def taxo(self):
"""Gets the taxo of this ProjectFilters. # noqa: E501
+ Coma-separated list of numeric taxonomy/category ids. Only include objects classified with one of them. # noqa: E501
:return: The taxo of this ProjectFilters. # noqa: E501
:rtype: str
@@ -196,6 +197,7 @@ def taxo(self):
def taxo(self, taxo):
"""Sets the taxo of this ProjectFilters.
+ Coma-separated list of numeric taxonomy/category ids. Only include objects classified with one of them. # noqa: E501
:param taxo: The taxo of this ProjectFilters. # noqa: E501
:type: str
@@ -207,6 +209,7 @@ def taxo(self, taxo):
def taxochild(self):
"""Gets the taxochild of this ProjectFilters. # noqa: E501
+ If 'Y' and taxo is set, also include children of each member of 'taxo' list in taxonomy tree. # noqa: E501
:return: The taxochild of this ProjectFilters. # noqa: E501
:rtype: str
@@ -217,6 +220,7 @@ def taxochild(self):
def taxochild(self, taxochild):
"""Sets the taxochild of this ProjectFilters.
+ If 'Y' and taxo is set, also include children of each member of 'taxo' list in taxonomy tree. # noqa: E501
:param taxochild: The taxochild of this ProjectFilters. # noqa: E501
:type: str
@@ -228,6 +232,7 @@ def taxochild(self, taxochild):
def statusfilter(self):
"""Gets the statusfilter of this ProjectFilters. # noqa: E501
+ Include objects with given status: 'NV': Not validated 'PV': Predicted or Validated 'PVD': Predicted or Validated or Dubious 'NVM': Validated, but not by me 'VM': Validated by me 'U': Not classified other: direct equality comparison with DB value # noqa: E501
:return: The statusfilter of this ProjectFilters. # noqa: E501
:rtype: str
@@ -238,6 +243,7 @@ def statusfilter(self):
def statusfilter(self, statusfilter):
"""Sets the statusfilter of this ProjectFilters.
+ Include objects with given status: 'NV': Not validated 'PV': Predicted or Validated 'PVD': Predicted or Validated or Dubious 'NVM': Validated, but not by me 'VM': Validated by me 'U': Not classified other: direct equality comparison with DB value # noqa: E501
:param statusfilter: The statusfilter of this ProjectFilters. # noqa: E501
:type: str
@@ -249,6 +255,7 @@ def statusfilter(self, statusfilter):
def map_n(self):
"""Gets the map_n of this ProjectFilters. # noqa: E501
+ If all 4 are set (MapN, MapW, MapE, MapS), include objects inside the defined bounding rectangle. # noqa: E501
:return: The map_n of this ProjectFilters. # noqa: E501
:rtype: str
@@ -259,6 +266,7 @@ def map_n(self):
def map_n(self, map_n):
"""Sets the map_n of this ProjectFilters.
+ If all 4 are set (MapN, MapW, MapE, MapS), include objects inside the defined bounding rectangle. # noqa: E501
:param map_n: The map_n of this ProjectFilters. # noqa: E501
:type: str
@@ -270,6 +278,7 @@ def map_n(self, map_n):
def map_w(self):
"""Gets the map_w of this ProjectFilters. # noqa: E501
+ If all 4 are set (MapN, MapW, MapE, MapS), include objects inside the defined bounding rectangle. # noqa: E501
:return: The map_w of this ProjectFilters. # noqa: E501
:rtype: str
@@ -280,6 +289,7 @@ def map_w(self):
def map_w(self, map_w):
"""Sets the map_w of this ProjectFilters.
+ If all 4 are set (MapN, MapW, MapE, MapS), include objects inside the defined bounding rectangle. # noqa: E501
:param map_w: The map_w of this ProjectFilters. # noqa: E501
:type: str
@@ -291,6 +301,7 @@ def map_w(self, map_w):
def map_e(self):
"""Gets the map_e of this ProjectFilters. # noqa: E501
+ If all 4 are set (MapN, MapW, MapE, MapS), include objects inside the defined bounding rectangle. # noqa: E501
:return: The map_e of this ProjectFilters. # noqa: E501
:rtype: str
@@ -301,6 +312,7 @@ def map_e(self):
def map_e(self, map_e):
"""Sets the map_e of this ProjectFilters.
+ If all 4 are set (MapN, MapW, MapE, MapS), include objects inside the defined bounding rectangle. # noqa: E501
:param map_e: The map_e of this ProjectFilters. # noqa: E501
:type: str
@@ -312,6 +324,7 @@ def map_e(self, map_e):
def map_s(self):
"""Gets the map_s of this ProjectFilters. # noqa: E501
+ If all 4 are set (MapN, MapW, MapE, MapS), include objects inside the defined bounding rectangle. # noqa: E501
:return: The map_s of this ProjectFilters. # noqa: E501
:rtype: str
@@ -322,6 +335,7 @@ def map_s(self):
def map_s(self, map_s):
"""Sets the map_s of this ProjectFilters.
+ If all 4 are set (MapN, MapW, MapE, MapS), include objects inside the defined bounding rectangle. # noqa: E501
:param map_s: The map_s of this ProjectFilters. # noqa: E501
:type: str
@@ -333,6 +347,7 @@ def map_s(self, map_s):
def depthmin(self):
"""Gets the depthmin of this ProjectFilters. # noqa: E501
+ Positive values. If both are set (depthmin, depthmax), include objects for which both depths (min and max) are inside the range. # noqa: E501
:return: The depthmin of this ProjectFilters. # noqa: E501
:rtype: str
@@ -343,6 +358,7 @@ def depthmin(self):
def depthmin(self, depthmin):
"""Sets the depthmin of this ProjectFilters.
+ Positive values. If both are set (depthmin, depthmax), include objects for which both depths (min and max) are inside the range. # noqa: E501
:param depthmin: The depthmin of this ProjectFilters. # noqa: E501
:type: str
@@ -354,6 +370,7 @@ def depthmin(self, depthmin):
def depthmax(self):
"""Gets the depthmax of this ProjectFilters. # noqa: E501
+ Positive values. If both are set (depthmin, depthmax), include objects for which both depths (min and max) are inside the range. # noqa: E501
:return: The depthmax of this ProjectFilters. # noqa: E501
:rtype: str
@@ -364,6 +381,7 @@ def depthmax(self):
def depthmax(self, depthmax):
"""Sets the depthmax of this ProjectFilters.
+ Positive values. If both are set (depthmin, depthmax), include objects for which both depths (min and max) are inside the range. # noqa: E501
:param depthmax: The depthmax of this ProjectFilters. # noqa: E501
:type: str
@@ -375,6 +393,7 @@ def depthmax(self, depthmax):
def samples(self):
"""Gets the samples of this ProjectFilters. # noqa: E501
+ Coma-separated list of sample IDs, include only objects for these samples. # noqa: E501
:return: The samples of this ProjectFilters. # noqa: E501
:rtype: str
@@ -385,6 +404,7 @@ def samples(self):
def samples(self, samples):
"""Sets the samples of this ProjectFilters.
+ Coma-separated list of sample IDs, include only objects for these samples. # noqa: E501
:param samples: The samples of this ProjectFilters. # noqa: E501
:type: str
@@ -396,6 +416,7 @@ def samples(self, samples):
def instrum(self):
"""Gets the instrum of this ProjectFilters. # noqa: E501
+ Instrument name, include objects for which sampling was done using this instrument. # noqa: E501
:return: The instrum of this ProjectFilters. # noqa: E501
:rtype: str
@@ -406,6 +427,7 @@ def instrum(self):
def instrum(self, instrum):
"""Sets the instrum of this ProjectFilters.
+ Instrument name, include objects for which sampling was done using this instrument. # noqa: E501
:param instrum: The instrum of this ProjectFilters. # noqa: E501
:type: str
@@ -417,6 +439,7 @@ def instrum(self, instrum):
def daytime(self):
"""Gets the daytime of this ProjectFilters. # noqa: E501
+ Coma-separated list of sun position values: D for Day, U for Dusk, N for Night, A for Dawn (Aube in French). # noqa: E501
:return: The daytime of this ProjectFilters. # noqa: E501
:rtype: str
@@ -427,6 +450,7 @@ def daytime(self):
def daytime(self, daytime):
"""Sets the daytime of this ProjectFilters.
+ Coma-separated list of sun position values: D for Day, U for Dusk, N for Night, A for Dawn (Aube in French). # noqa: E501
:param daytime: The daytime of this ProjectFilters. # noqa: E501
:type: str
@@ -438,6 +462,7 @@ def daytime(self, daytime):
def month(self):
"""Gets the month of this ProjectFilters. # noqa: E501
+ Coma-separated list of month numbers, 1=Jan and so on. # noqa: E501
:return: The month of this ProjectFilters. # noqa: E501
:rtype: str
@@ -448,6 +473,7 @@ def month(self):
def month(self, month):
"""Sets the month of this ProjectFilters.
+ Coma-separated list of month numbers, 1=Jan and so on. # noqa: E501
:param month: The month of this ProjectFilters. # noqa: E501
:type: str
@@ -459,6 +485,7 @@ def month(self, month):
def fromdate(self):
"""Gets the fromdate of this ProjectFilters. # noqa: E501
+ Format is 'YYYY-MM-DD', include objects collected after this date. # noqa: E501
:return: The fromdate of this ProjectFilters. # noqa: E501
:rtype: str
@@ -469,6 +496,7 @@ def fromdate(self):
def fromdate(self, fromdate):
"""Sets the fromdate of this ProjectFilters.
+ Format is 'YYYY-MM-DD', include objects collected after this date. # noqa: E501
:param fromdate: The fromdate of this ProjectFilters. # noqa: E501
:type: str
@@ -480,6 +508,7 @@ def fromdate(self, fromdate):
def todate(self):
"""Gets the todate of this ProjectFilters. # noqa: E501
+ Format is 'YYYY-MM-DD', include objects collected before this date. # noqa: E501
:return: The todate of this ProjectFilters. # noqa: E501
:rtype: str
@@ -490,6 +519,7 @@ def todate(self):
def todate(self, todate):
"""Sets the todate of this ProjectFilters.
+ Format is 'YYYY-MM-DD', include objects collected before this date. # noqa: E501
:param todate: The todate of this ProjectFilters. # noqa: E501
:type: str
@@ -501,6 +531,7 @@ def todate(self, todate):
def fromtime(self):
"""Gets the fromtime of this ProjectFilters. # noqa: E501
+ Format is 'HH24:MM:SS', include objects collected after this time of day. # noqa: E501
:return: The fromtime of this ProjectFilters. # noqa: E501
:rtype: str
@@ -511,6 +542,7 @@ def fromtime(self):
def fromtime(self, fromtime):
"""Sets the fromtime of this ProjectFilters.
+ Format is 'HH24:MM:SS', include objects collected after this time of day. # noqa: E501
:param fromtime: The fromtime of this ProjectFilters. # noqa: E501
:type: str
@@ -522,6 +554,7 @@ def fromtime(self, fromtime):
def totime(self):
"""Gets the totime of this ProjectFilters. # noqa: E501
+ Format is 'HH24:MM:SS', include objects collected before this time of day. # noqa: E501
:return: The totime of this ProjectFilters. # noqa: E501
:rtype: str
@@ -532,6 +565,7 @@ def totime(self):
def totime(self, totime):
"""Sets the totime of this ProjectFilters.
+ Format is 'HH24:MM:SS', include objects collected before this time of day. # noqa: E501
:param totime: The totime of this ProjectFilters. # noqa: E501
:type: str
@@ -543,6 +577,7 @@ def totime(self, totime):
def inverttime(self):
"""Gets the inverttime of this ProjectFilters. # noqa: E501
+ If '1', include objects outside fromtime and totime range. # noqa: E501
:return: The inverttime of this ProjectFilters. # noqa: E501
:rtype: str
@@ -553,6 +588,7 @@ def inverttime(self):
def inverttime(self, inverttime):
"""Sets the inverttime of this ProjectFilters.
+ If '1', include objects outside fromtime and totime range. # noqa: E501
:param inverttime: The inverttime of this ProjectFilters. # noqa: E501
:type: str
@@ -564,6 +600,7 @@ def inverttime(self, inverttime):
def validfromdate(self):
"""Gets the validfromdate of this ProjectFilters. # noqa: E501
+ Format is 'YYYY-MM-DD HH24:MI', include objects validated/set to dubious after this date+time. # noqa: E501
:return: The validfromdate of this ProjectFilters. # noqa: E501
:rtype: str
@@ -574,6 +611,7 @@ def validfromdate(self):
def validfromdate(self, validfromdate):
"""Sets the validfromdate of this ProjectFilters.
+ Format is 'YYYY-MM-DD HH24:MI', include objects validated/set to dubious after this date+time. # noqa: E501
:param validfromdate: The validfromdate of this ProjectFilters. # noqa: E501
:type: str
@@ -585,6 +623,7 @@ def validfromdate(self, validfromdate):
def validtodate(self):
"""Gets the validtodate of this ProjectFilters. # noqa: E501
+ Format is 'YYYY-MM-DD HH24:MI', include objects validated/set to dubious before this date+time. # noqa: E501
:return: The validtodate of this ProjectFilters. # noqa: E501
:rtype: str
@@ -595,6 +634,7 @@ def validtodate(self):
def validtodate(self, validtodate):
"""Sets the validtodate of this ProjectFilters.
+ Format is 'YYYY-MM-DD HH24:MI', include objects validated/set to dubious before this date+time. # noqa: E501
:param validtodate: The validtodate of this ProjectFilters. # noqa: E501
:type: str
@@ -606,6 +646,7 @@ def validtodate(self, validtodate):
def freenum(self):
"""Gets the freenum of this ProjectFilters. # noqa: E501
+ Numerical DB column number in Object as basis for the 2 following criteria (freenumst, freenumend). # noqa: E501
:return: The freenum of this ProjectFilters. # noqa: E501
:rtype: str
@@ -616,6 +657,7 @@ def freenum(self):
def freenum(self, freenum):
"""Sets the freenum of this ProjectFilters.
+ Numerical DB column number in Object as basis for the 2 following criteria (freenumst, freenumend). # noqa: E501
:param freenum: The freenum of this ProjectFilters. # noqa: E501
:type: str
@@ -627,6 +669,7 @@ def freenum(self, freenum):
def freenumst(self):
"""Gets the freenumst of this ProjectFilters. # noqa: E501
+ Start of included range for the column defined by freenum, in which objects are included. # noqa: E501
:return: The freenumst of this ProjectFilters. # noqa: E501
:rtype: str
@@ -637,6 +680,7 @@ def freenumst(self):
def freenumst(self, freenumst):
"""Sets the freenumst of this ProjectFilters.
+ Start of included range for the column defined by freenum, in which objects are included. # noqa: E501
:param freenumst: The freenumst of this ProjectFilters. # noqa: E501
:type: str
@@ -648,6 +692,7 @@ def freenumst(self, freenumst):
def freenumend(self):
"""Gets the freenumend of this ProjectFilters. # noqa: E501
+ End of included range for the column defined by freenum, in which objects are included. # noqa: E501
:return: The freenumend of this ProjectFilters. # noqa: E501
:rtype: str
@@ -658,6 +703,7 @@ def freenumend(self):
def freenumend(self, freenumend):
"""Sets the freenumend of this ProjectFilters.
+ End of included range for the column defined by freenum, in which objects are included. # noqa: E501
:param freenumend: The freenumend of this ProjectFilters. # noqa: E501
:type: str
@@ -669,6 +715,7 @@ def freenumend(self, freenumend):
def freetxt(self):
"""Gets the freetxt of this ProjectFilters. # noqa: E501
+ Textual DB column number as basis for following criteria (freetxtval) If starts with 's' then it's a text column in Sample If starts with 'a' then it's a text column in Acquisition If starts with 'p' then it's a text column in Process If starts with 'o' then it's a text column in Object . # noqa: E501
:return: The freetxt of this ProjectFilters. # noqa: E501
:rtype: str
@@ -679,6 +726,7 @@ def freetxt(self):
def freetxt(self, freetxt):
"""Sets the freetxt of this ProjectFilters.
+ Textual DB column number as basis for following criteria (freetxtval) If starts with 's' then it's a text column in Sample If starts with 'a' then it's a text column in Acquisition If starts with 'p' then it's a text column in Process If starts with 'o' then it's a text column in Object . # noqa: E501
:param freetxt: The freetxt of this ProjectFilters. # noqa: E501
:type: str
@@ -690,6 +738,7 @@ def freetxt(self, freetxt):
def freetxtval(self):
"""Gets the freetxtval of this ProjectFilters. # noqa: E501
+ Text to match in the column defined by freetxt, for an object to be include. # noqa: E501
:return: The freetxtval of this ProjectFilters. # noqa: E501
:rtype: str
@@ -700,6 +749,7 @@ def freetxtval(self):
def freetxtval(self, freetxtval):
"""Sets the freetxtval of this ProjectFilters.
+ Text to match in the column defined by freetxt, for an object to be include. # noqa: E501
:param freetxtval: The freetxtval of this ProjectFilters. # noqa: E501
:type: str
@@ -711,6 +761,7 @@ def freetxtval(self, freetxtval):
def filt_annot(self):
"""Gets the filt_annot of this ProjectFilters. # noqa: E501
+ Coma-separated list of annotator, i.e. person who validated the classification at any point in time. # noqa: E501
:return: The filt_annot of this ProjectFilters. # noqa: E501
:rtype: str
@@ -721,6 +772,7 @@ def filt_annot(self):
def filt_annot(self, filt_annot):
"""Sets the filt_annot of this ProjectFilters.
+ Coma-separated list of annotator, i.e. person who validated the classification at any point in time. # noqa: E501
:param filt_annot: The filt_annot of this ProjectFilters. # noqa: E501
:type: str
@@ -732,6 +784,7 @@ def filt_annot(self, filt_annot):
def filt_last_annot(self):
"""Gets the filt_last_annot of this ProjectFilters. # noqa: E501
+ Coma-separated list of annotator, i.e. person who validated the classification in last. # noqa: E501
:return: The filt_last_annot of this ProjectFilters. # noqa: E501
:rtype: str
@@ -742,6 +795,7 @@ def filt_last_annot(self):
def filt_last_annot(self, filt_last_annot):
"""Sets the filt_last_annot of this ProjectFilters.
+ Coma-separated list of annotator, i.e. person who validated the classification in last. # noqa: E501
:param filt_last_annot: The filt_last_annot of this ProjectFilters. # noqa: E501
:type: str
diff --git a/to_back/ecotaxa_cli_py/models/project_model.py b/to_back/ecotaxa_cli_py/models/project_model.py
index 6fc9832e..d5141d64 100644
--- a/to_back/ecotaxa_cli_py/models/project_model.py
+++ b/to_back/ecotaxa_cli_py/models/project_model.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -56,7 +56,7 @@ class ProjectModel(object):
'classiffieldlist': 'str',
'popoverfieldlist': 'str',
'comments': 'str',
- 'projtype': 'str',
+ 'description': 'str',
'rf_models_used': 'str',
'cnn_network_id': 'str'
}
@@ -85,12 +85,12 @@ class ProjectModel(object):
'classiffieldlist': 'classiffieldlist',
'popoverfieldlist': 'popoverfieldlist',
'comments': 'comments',
- 'projtype': 'projtype',
+ 'description': 'description',
'rf_models_used': 'rf_models_used',
'cnn_network_id': 'cnn_network_id'
}
- def __init__(self, obj_free_cols=None, sample_free_cols=None, acquisition_free_cols=None, process_free_cols=None, init_classif_list=[], managers=[], annotators=[], viewers=[], instrument=None, contact=None, highest_right='', license=None, projid=None, title=None, visible=None, status=None, objcount=None, pctvalidated=None, pctclassified=None, classifsettings=None, classiffieldlist=None, popoverfieldlist=None, comments=None, projtype=None, rf_models_used=None, cnn_network_id=None, local_vars_configuration=None): # noqa: E501
+ def __init__(self, obj_free_cols=None, sample_free_cols=None, acquisition_free_cols=None, process_free_cols=None, init_classif_list=[], managers=[], annotators=[], viewers=[], instrument=None, contact=None, highest_right='', license=None, projid=None, title=None, visible=None, status=None, objcount=None, pctvalidated=None, pctclassified=None, classifsettings=None, classiffieldlist=None, popoverfieldlist=None, comments=None, description=None, rf_models_used=None, cnn_network_id=None, local_vars_configuration=None): # noqa: E501
"""ProjectModel - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
@@ -119,7 +119,7 @@ def __init__(self, obj_free_cols=None, sample_free_cols=None, acquisition_free_c
self._classiffieldlist = None
self._popoverfieldlist = None
self._comments = None
- self._projtype = None
+ self._description = None
self._rf_models_used = None
self._cnn_network_id = None
self.discriminator = None
@@ -146,10 +146,8 @@ def __init__(self, obj_free_cols=None, sample_free_cols=None, acquisition_free_c
self.contact = contact
if highest_right is not None:
self.highest_right = highest_right
- if license is not None:
- self.license = license
- if projid is not None:
- self.projid = projid
+ self.license = license
+ self.projid = projid
self.title = title
if visible is not None:
self.visible = visible
@@ -169,8 +167,8 @@ def __init__(self, obj_free_cols=None, sample_free_cols=None, acquisition_free_c
self.popoverfieldlist = popoverfieldlist
if comments is not None:
self.comments = comments
- if projtype is not None:
- self.projtype = projtype
+ if description is not None:
+ self.description = description
if rf_models_used is not None:
self.rf_models_used = rf_models_used
if cnn_network_id is not None:
@@ -180,6 +178,7 @@ def __init__(self, obj_free_cols=None, sample_free_cols=None, acquisition_free_c
def obj_free_cols(self):
"""Gets the obj_free_cols of this ProjectModel. # noqa: E501
+ Object free columns. # noqa: E501
:return: The obj_free_cols of this ProjectModel. # noqa: E501
:rtype: dict(str, str)
@@ -190,6 +189,7 @@ def obj_free_cols(self):
def obj_free_cols(self, obj_free_cols):
"""Sets the obj_free_cols of this ProjectModel.
+ Object free columns. # noqa: E501
:param obj_free_cols: The obj_free_cols of this ProjectModel. # noqa: E501
:type: dict(str, str)
@@ -201,6 +201,7 @@ def obj_free_cols(self, obj_free_cols):
def sample_free_cols(self):
"""Gets the sample_free_cols of this ProjectModel. # noqa: E501
+ Sample free columns. # noqa: E501
:return: The sample_free_cols of this ProjectModel. # noqa: E501
:rtype: dict(str, str)
@@ -211,6 +212,7 @@ def sample_free_cols(self):
def sample_free_cols(self, sample_free_cols):
"""Sets the sample_free_cols of this ProjectModel.
+ Sample free columns. # noqa: E501
:param sample_free_cols: The sample_free_cols of this ProjectModel. # noqa: E501
:type: dict(str, str)
@@ -222,6 +224,7 @@ def sample_free_cols(self, sample_free_cols):
def acquisition_free_cols(self):
"""Gets the acquisition_free_cols of this ProjectModel. # noqa: E501
+ Acquisition free columns. # noqa: E501
:return: The acquisition_free_cols of this ProjectModel. # noqa: E501
:rtype: dict(str, str)
@@ -232,6 +235,7 @@ def acquisition_free_cols(self):
def acquisition_free_cols(self, acquisition_free_cols):
"""Sets the acquisition_free_cols of this ProjectModel.
+ Acquisition free columns. # noqa: E501
:param acquisition_free_cols: The acquisition_free_cols of this ProjectModel. # noqa: E501
:type: dict(str, str)
@@ -243,6 +247,7 @@ def acquisition_free_cols(self, acquisition_free_cols):
def process_free_cols(self):
"""Gets the process_free_cols of this ProjectModel. # noqa: E501
+ Process free columns. # noqa: E501
:return: The process_free_cols of this ProjectModel. # noqa: E501
:rtype: dict(str, str)
@@ -253,6 +258,7 @@ def process_free_cols(self):
def process_free_cols(self, process_free_cols):
"""Sets the process_free_cols of this ProjectModel.
+ Process free columns. # noqa: E501
:param process_free_cols: The process_free_cols of this ProjectModel. # noqa: E501
:type: dict(str, str)
@@ -264,6 +270,7 @@ def process_free_cols(self, process_free_cols):
def init_classif_list(self):
"""Gets the init_classif_list of this ProjectModel. # noqa: E501
+ Favorite taxa used in classification. # noqa: E501
:return: The init_classif_list of this ProjectModel. # noqa: E501
:rtype: list[int]
@@ -274,6 +281,7 @@ def init_classif_list(self):
def init_classif_list(self, init_classif_list):
"""Sets the init_classif_list of this ProjectModel.
+ Favorite taxa used in classification. # noqa: E501
:param init_classif_list: The init_classif_list of this ProjectModel. # noqa: E501
:type: list[int]
@@ -285,6 +293,7 @@ def init_classif_list(self, init_classif_list):
def managers(self):
"""Gets the managers of this ProjectModel. # noqa: E501
+ Managers of this project. # noqa: E501
:return: The managers of this ProjectModel. # noqa: E501
:rtype: list[UserModel]
@@ -295,6 +304,7 @@ def managers(self):
def managers(self, managers):
"""Sets the managers of this ProjectModel.
+ Managers of this project. # noqa: E501
:param managers: The managers of this ProjectModel. # noqa: E501
:type: list[UserModel]
@@ -306,6 +316,7 @@ def managers(self, managers):
def annotators(self):
"""Gets the annotators of this ProjectModel. # noqa: E501
+ Annotators of this project, if not manager. # noqa: E501
:return: The annotators of this ProjectModel. # noqa: E501
:rtype: list[UserModel]
@@ -316,6 +327,7 @@ def annotators(self):
def annotators(self, annotators):
"""Sets the annotators of this ProjectModel.
+ Annotators of this project, if not manager. # noqa: E501
:param annotators: The annotators of this ProjectModel. # noqa: E501
:type: list[UserModel]
@@ -327,6 +339,7 @@ def annotators(self, annotators):
def viewers(self):
"""Gets the viewers of this ProjectModel. # noqa: E501
+ Viewers of this project, if not manager nor annotator. # noqa: E501
:return: The viewers of this ProjectModel. # noqa: E501
:rtype: list[UserModel]
@@ -337,6 +350,7 @@ def viewers(self):
def viewers(self, viewers):
"""Sets the viewers of this ProjectModel.
+ Viewers of this project, if not manager nor annotator. # noqa: E501
:param viewers: The viewers of this ProjectModel. # noqa: E501
:type: list[UserModel]
@@ -348,6 +362,7 @@ def viewers(self, viewers):
def instrument(self):
"""Gets the instrument of this ProjectModel. # noqa: E501
+ This project's instrument. Transitory: if several of them, then coma-separated. # noqa: E501
:return: The instrument of this ProjectModel. # noqa: E501
:rtype: str
@@ -358,6 +373,7 @@ def instrument(self):
def instrument(self, instrument):
"""Sets the instrument of this ProjectModel.
+ This project's instrument. Transitory: if several of them, then coma-separated. # noqa: E501
:param instrument: The instrument of this ProjectModel. # noqa: E501
:type: str
@@ -369,6 +385,7 @@ def instrument(self, instrument):
def contact(self):
"""Gets the contact of this ProjectModel. # noqa: E501
+ The contact person is a manager who serves as the contact person for other users and EcoTaxa's managers. # noqa: E501
:return: The contact of this ProjectModel. # noqa: E501
:rtype: UserModel
@@ -379,6 +396,7 @@ def contact(self):
def contact(self, contact):
"""Sets the contact of this ProjectModel.
+ The contact person is a manager who serves as the contact person for other users and EcoTaxa's managers. # noqa: E501
:param contact: The contact of this ProjectModel. # noqa: E501
:type: UserModel
@@ -390,6 +408,7 @@ def contact(self, contact):
def highest_right(self):
"""Gets the highest_right of this ProjectModel. # noqa: E501
+ The highest right for requester on this project. One of 'Manage', 'Annotate', 'View'. # noqa: E501
:return: The highest_right of this ProjectModel. # noqa: E501
:rtype: str
@@ -400,6 +419,7 @@ def highest_right(self):
def highest_right(self, highest_right):
"""Sets the highest_right of this ProjectModel.
+ The highest right for requester on this project. One of 'Manage', 'Annotate', 'View'. # noqa: E501
:param highest_right: The highest_right of this ProjectModel. # noqa: E501
:type: str
@@ -425,6 +445,8 @@ def license(self, license):
:param license: The license of this ProjectModel. # noqa: E501
:type: str
"""
+ if self.local_vars_configuration.client_side_validation and license is None: # noqa: E501
+ raise ValueError("Invalid value for `license`, must not be `None`") # noqa: E501
self._license = license
@@ -432,6 +454,7 @@ def license(self, license):
def projid(self):
"""Gets the projid of this ProjectModel. # noqa: E501
+ The project Id. # noqa: E501
:return: The projid of this ProjectModel. # noqa: E501
:rtype: int
@@ -442,10 +465,13 @@ def projid(self):
def projid(self, projid):
"""Sets the projid of this ProjectModel.
+ The project Id. # noqa: E501
:param projid: The projid of this ProjectModel. # noqa: E501
:type: int
"""
+ if self.local_vars_configuration.client_side_validation and projid is None: # noqa: E501
+ raise ValueError("Invalid value for `projid`, must not be `None`") # noqa: E501
self._projid = projid
@@ -453,6 +479,7 @@ def projid(self, projid):
def title(self):
"""Gets the title of this ProjectModel. # noqa: E501
+ The project title. # noqa: E501
:return: The title of this ProjectModel. # noqa: E501
:rtype: str
@@ -463,6 +490,7 @@ def title(self):
def title(self, title):
"""Sets the title of this ProjectModel.
+ The project title. # noqa: E501
:param title: The title of this ProjectModel. # noqa: E501
:type: str
@@ -476,6 +504,7 @@ def title(self, title):
def visible(self):
"""Gets the visible of this ProjectModel. # noqa: E501
+ The project visibility. # noqa: E501
:return: The visible of this ProjectModel. # noqa: E501
:rtype: bool
@@ -486,6 +515,7 @@ def visible(self):
def visible(self, visible):
"""Sets the visible of this ProjectModel.
+ The project visibility. # noqa: E501
:param visible: The visible of this ProjectModel. # noqa: E501
:type: bool
@@ -497,6 +527,7 @@ def visible(self, visible):
def status(self):
"""Gets the status of this ProjectModel. # noqa: E501
+ The project status. # noqa: E501
:return: The status of this ProjectModel. # noqa: E501
:rtype: str
@@ -507,6 +538,7 @@ def status(self):
def status(self, status):
"""Sets the status of this ProjectModel.
+ The project status. # noqa: E501
:param status: The status of this ProjectModel. # noqa: E501
:type: str
@@ -518,6 +550,7 @@ def status(self, status):
def objcount(self):
"""Gets the objcount of this ProjectModel. # noqa: E501
+ The number of objects. # noqa: E501
:return: The objcount of this ProjectModel. # noqa: E501
:rtype: float
@@ -528,6 +561,7 @@ def objcount(self):
def objcount(self, objcount):
"""Sets the objcount of this ProjectModel.
+ The number of objects. # noqa: E501
:param objcount: The objcount of this ProjectModel. # noqa: E501
:type: float
@@ -539,6 +573,7 @@ def objcount(self, objcount):
def pctvalidated(self):
"""Gets the pctvalidated of this ProjectModel. # noqa: E501
+ Percentage of validated images. # noqa: E501
:return: The pctvalidated of this ProjectModel. # noqa: E501
:rtype: float
@@ -549,6 +584,7 @@ def pctvalidated(self):
def pctvalidated(self, pctvalidated):
"""Sets the pctvalidated of this ProjectModel.
+ Percentage of validated images. # noqa: E501
:param pctvalidated: The pctvalidated of this ProjectModel. # noqa: E501
:type: float
@@ -560,6 +596,7 @@ def pctvalidated(self, pctvalidated):
def pctclassified(self):
"""Gets the pctclassified of this ProjectModel. # noqa: E501
+ Percentage of classified images. # noqa: E501
:return: The pctclassified of this ProjectModel. # noqa: E501
:rtype: float
@@ -570,6 +607,7 @@ def pctclassified(self):
def pctclassified(self, pctclassified):
"""Sets the pctclassified of this ProjectModel.
+ Percentage of classified images. # noqa: E501
:param pctclassified: The pctclassified of this ProjectModel. # noqa: E501
:type: float
@@ -644,6 +682,7 @@ def popoverfieldlist(self, popoverfieldlist):
def comments(self):
"""Gets the comments of this ProjectModel. # noqa: E501
+ The project comments. # noqa: E501
:return: The comments of this ProjectModel. # noqa: E501
:rtype: str
@@ -654,6 +693,7 @@ def comments(self):
def comments(self, comments):
"""Sets the comments of this ProjectModel.
+ The project comments. # noqa: E501
:param comments: The comments of this ProjectModel. # noqa: E501
:type: str
@@ -662,25 +702,27 @@ def comments(self, comments):
self._comments = comments
@property
- def projtype(self):
- """Gets the projtype of this ProjectModel. # noqa: E501
+ def description(self):
+ """Gets the description of this ProjectModel. # noqa: E501
+ The project description, i.e. main traits. # noqa: E501
- :return: The projtype of this ProjectModel. # noqa: E501
+ :return: The description of this ProjectModel. # noqa: E501
:rtype: str
"""
- return self._projtype
+ return self._description
- @projtype.setter
- def projtype(self, projtype):
- """Sets the projtype of this ProjectModel.
+ @description.setter
+ def description(self, description):
+ """Sets the description of this ProjectModel.
+ The project description, i.e. main traits. # noqa: E501
- :param projtype: The projtype of this ProjectModel. # noqa: E501
+ :param description: The description of this ProjectModel. # noqa: E501
:type: str
"""
- self._projtype = projtype
+ self._description = description
@property
def rf_models_used(self):
diff --git a/to_back/ecotaxa_cli_py/models/project_set_column_stats_model.py b/to_back/ecotaxa_cli_py/models/project_set_column_stats_model.py
new file mode 100644
index 00000000..972bd765
--- /dev/null
+++ b/to_back/ecotaxa_cli_py/models/project_set_column_stats_model.py
@@ -0,0 +1,234 @@
+# coding: utf-8
+
+"""
+ EcoTaxa
+
+ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
+
+ The version of the OpenAPI document: 0.0.23
+ Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from to_back.ecotaxa_cli_py.configuration import Configuration
+
+
+class ProjectSetColumnStatsModel(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 = {
+ 'proj_ids': 'list[int]',
+ 'total': 'int',
+ 'columns': 'list[str]',
+ 'counts': 'list[int]',
+ 'variances': 'list[float]'
+ }
+
+ attribute_map = {
+ 'proj_ids': 'proj_ids',
+ 'total': 'total',
+ 'columns': 'columns',
+ 'counts': 'counts',
+ 'variances': 'variances'
+ }
+
+ def __init__(self, proj_ids=None, total=None, columns=None, counts=None, variances=None, local_vars_configuration=None): # noqa: E501
+ """ProjectSetColumnStatsModel - a model defined in OpenAPI""" # noqa: E501
+ if local_vars_configuration is None:
+ local_vars_configuration = Configuration()
+ self.local_vars_configuration = local_vars_configuration
+
+ self._proj_ids = None
+ self._total = None
+ self._columns = None
+ self._counts = None
+ self._variances = None
+ self.discriminator = None
+
+ if proj_ids is not None:
+ self.proj_ids = proj_ids
+ if total is not None:
+ self.total = total
+ if columns is not None:
+ self.columns = columns
+ if counts is not None:
+ self.counts = counts
+ if variances is not None:
+ self.variances = variances
+
+ @property
+ def proj_ids(self):
+ """Gets the proj_ids of this ProjectSetColumnStatsModel. # noqa: E501
+
+ Projects IDs from the call. # noqa: E501
+
+ :return: The proj_ids of this ProjectSetColumnStatsModel. # noqa: E501
+ :rtype: list[int]
+ """
+ return self._proj_ids
+
+ @proj_ids.setter
+ def proj_ids(self, proj_ids):
+ """Sets the proj_ids of this ProjectSetColumnStatsModel.
+
+ Projects IDs from the call. # noqa: E501
+
+ :param proj_ids: The proj_ids of this ProjectSetColumnStatsModel. # noqa: E501
+ :type: list[int]
+ """
+
+ self._proj_ids = proj_ids
+
+ @property
+ def total(self):
+ """Gets the total of this ProjectSetColumnStatsModel. # noqa: E501
+
+ All rows regardless of emptiness. # noqa: E501
+
+ :return: The total of this ProjectSetColumnStatsModel. # noqa: E501
+ :rtype: int
+ """
+ return self._total
+
+ @total.setter
+ def total(self, total):
+ """Sets the total of this ProjectSetColumnStatsModel.
+
+ All rows regardless of emptiness. # noqa: E501
+
+ :param total: The total of this ProjectSetColumnStatsModel. # noqa: E501
+ :type: int
+ """
+
+ self._total = total
+
+ @property
+ def columns(self):
+ """Gets the columns of this ProjectSetColumnStatsModel. # noqa: E501
+
+ Column names from the call. # noqa: E501
+
+ :return: The columns of this ProjectSetColumnStatsModel. # noqa: E501
+ :rtype: list[str]
+ """
+ return self._columns
+
+ @columns.setter
+ def columns(self, columns):
+ """Sets the columns of this ProjectSetColumnStatsModel.
+
+ Column names from the call. # noqa: E501
+
+ :param columns: The columns of this ProjectSetColumnStatsModel. # noqa: E501
+ :type: list[str]
+ """
+
+ self._columns = columns
+
+ @property
+ def counts(self):
+ """Gets the counts of this ProjectSetColumnStatsModel. # noqa: E501
+
+ Counts of non-empty values, one per column. # noqa: E501
+
+ :return: The counts of this ProjectSetColumnStatsModel. # noqa: E501
+ :rtype: list[int]
+ """
+ return self._counts
+
+ @counts.setter
+ def counts(self, counts):
+ """Sets the counts of this ProjectSetColumnStatsModel.
+
+ Counts of non-empty values, one per column. # noqa: E501
+
+ :param counts: The counts of this ProjectSetColumnStatsModel. # noqa: E501
+ :type: list[int]
+ """
+
+ self._counts = counts
+
+ @property
+ def variances(self):
+ """Gets the variances of this ProjectSetColumnStatsModel. # noqa: E501
+
+ Variances of values, one per column. # noqa: E501
+
+ :return: The variances of this ProjectSetColumnStatsModel. # noqa: E501
+ :rtype: list[float]
+ """
+ return self._variances
+
+ @variances.setter
+ def variances(self, variances):
+ """Sets the variances of this ProjectSetColumnStatsModel.
+
+ Variances of values, one per column. # noqa: E501
+
+ :param variances: The variances of this ProjectSetColumnStatsModel. # noqa: E501
+ :type: list[float]
+ """
+
+ self._variances = variances
+
+ 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, ProjectSetColumnStatsModel):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, ProjectSetColumnStatsModel):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/to_back/ecotaxa_cli_py/models/project_summary_model.py b/to_back/ecotaxa_cli_py/models/project_summary_model.py
index 3685692e..235b311e 100644
--- a/to_back/ecotaxa_cli_py/models/project_summary_model.py
+++ b/to_back/ecotaxa_cli_py/models/project_summary_model.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -52,13 +52,16 @@ def __init__(self, projid=None, title=None, local_vars_configuration=None): # n
self._title = None
self.discriminator = None
- self.projid = projid
- self.title = title
+ if projid is not None:
+ self.projid = projid
+ if title is not None:
+ self.title = title
@property
def projid(self):
"""Gets the projid of this ProjectSummaryModel. # noqa: E501
+ Project unique identifier. # noqa: E501
:return: The projid of this ProjectSummaryModel. # noqa: E501
:rtype: int
@@ -69,12 +72,11 @@ def projid(self):
def projid(self, projid):
"""Sets the projid of this ProjectSummaryModel.
+ Project unique identifier. # noqa: E501
:param projid: The projid of this ProjectSummaryModel. # noqa: E501
:type: int
"""
- if self.local_vars_configuration.client_side_validation and projid is None: # noqa: E501
- raise ValueError("Invalid value for `projid`, must not be `None`") # noqa: E501
self._projid = projid
@@ -82,6 +84,7 @@ def projid(self, projid):
def title(self):
"""Gets the title of this ProjectSummaryModel. # noqa: E501
+ Project's title. # noqa: E501
:return: The title of this ProjectSummaryModel. # noqa: E501
:rtype: str
@@ -92,12 +95,11 @@ def title(self):
def title(self, title):
"""Sets the title of this ProjectSummaryModel.
+ Project's title. # noqa: E501
:param title: The title of this ProjectSummaryModel. # noqa: E501
:type: str
"""
- if self.local_vars_configuration.client_side_validation and title is None: # noqa: E501
- raise ValueError("Invalid value for `title`, must not be `None`") # noqa: E501
self._title = title
diff --git a/to_back/ecotaxa_cli_py/models/project_taxo_stats_model.py b/to_back/ecotaxa_cli_py/models/project_taxo_stats_model.py
index c3d82560..646f0fbe 100644
--- a/to_back/ecotaxa_cli_py/models/project_taxo_stats_model.py
+++ b/to_back/ecotaxa_cli_py/models/project_taxo_stats_model.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -76,6 +76,7 @@ def __init__(self, projid=None, used_taxa=[], nb_unclassified=None, nb_validated
def projid(self):
"""Gets the projid of this ProjectTaxoStatsModel. # noqa: E501
+ The project id. # noqa: E501
:return: The projid of this ProjectTaxoStatsModel. # noqa: E501
:rtype: int
@@ -86,6 +87,7 @@ def projid(self):
def projid(self, projid):
"""Sets the projid of this ProjectTaxoStatsModel.
+ The project id. # noqa: E501
:param projid: The projid of this ProjectTaxoStatsModel. # noqa: E501
:type: int
@@ -99,6 +101,7 @@ def projid(self, projid):
def used_taxa(self):
"""Gets the used_taxa of this ProjectTaxoStatsModel. # noqa: E501
+ The taxa/category ids used inside the project. An id of -1 means some unclassified objects. # noqa: E501
:return: The used_taxa of this ProjectTaxoStatsModel. # noqa: E501
:rtype: list[int]
@@ -109,6 +112,7 @@ def used_taxa(self):
def used_taxa(self, used_taxa):
"""Sets the used_taxa of this ProjectTaxoStatsModel.
+ The taxa/category ids used inside the project. An id of -1 means some unclassified objects. # noqa: E501
:param used_taxa: The used_taxa of this ProjectTaxoStatsModel. # noqa: E501
:type: list[int]
@@ -120,6 +124,7 @@ def used_taxa(self, used_taxa):
def nb_unclassified(self):
"""Gets the nb_unclassified of this ProjectTaxoStatsModel. # noqa: E501
+ The number of unclassified objects inside the project. # noqa: E501
:return: The nb_unclassified of this ProjectTaxoStatsModel. # noqa: E501
:rtype: int
@@ -130,6 +135,7 @@ def nb_unclassified(self):
def nb_unclassified(self, nb_unclassified):
"""Sets the nb_unclassified of this ProjectTaxoStatsModel.
+ The number of unclassified objects inside the project. # noqa: E501
:param nb_unclassified: The nb_unclassified of this ProjectTaxoStatsModel. # noqa: E501
:type: int
@@ -143,6 +149,7 @@ def nb_unclassified(self, nb_unclassified):
def nb_validated(self):
"""Gets the nb_validated of this ProjectTaxoStatsModel. # noqa: E501
+ The number of validated objects inside the project. # noqa: E501
:return: The nb_validated of this ProjectTaxoStatsModel. # noqa: E501
:rtype: int
@@ -153,6 +160,7 @@ def nb_validated(self):
def nb_validated(self, nb_validated):
"""Sets the nb_validated of this ProjectTaxoStatsModel.
+ The number of validated objects inside the project. # noqa: E501
:param nb_validated: The nb_validated of this ProjectTaxoStatsModel. # noqa: E501
:type: int
@@ -166,6 +174,7 @@ def nb_validated(self, nb_validated):
def nb_dubious(self):
"""Gets the nb_dubious of this ProjectTaxoStatsModel. # noqa: E501
+ The number of dubious objects inside the project. # noqa: E501
:return: The nb_dubious of this ProjectTaxoStatsModel. # noqa: E501
:rtype: int
@@ -176,6 +185,7 @@ def nb_dubious(self):
def nb_dubious(self, nb_dubious):
"""Sets the nb_dubious of this ProjectTaxoStatsModel.
+ The number of dubious objects inside the project. # noqa: E501
:param nb_dubious: The nb_dubious of this ProjectTaxoStatsModel. # noqa: E501
:type: int
@@ -189,6 +199,7 @@ def nb_dubious(self, nb_dubious):
def nb_predicted(self):
"""Gets the nb_predicted of this ProjectTaxoStatsModel. # noqa: E501
+ The number of predicted objects inside the project. # noqa: E501
:return: The nb_predicted of this ProjectTaxoStatsModel. # noqa: E501
:rtype: int
@@ -199,6 +210,7 @@ def nb_predicted(self):
def nb_predicted(self, nb_predicted):
"""Sets the nb_predicted of this ProjectTaxoStatsModel.
+ The number of predicted objects inside the project. # noqa: E501
:param nb_predicted: The nb_predicted of this ProjectTaxoStatsModel. # noqa: E501
:type: int
diff --git a/to_back/ecotaxa_cli_py/models/project_user_stats_model.py b/to_back/ecotaxa_cli_py/models/project_user_stats_model.py
index a099a2b8..3062628d 100644
--- a/to_back/ecotaxa_cli_py/models/project_user_stats_model.py
+++ b/to_back/ecotaxa_cli_py/models/project_user_stats_model.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -66,6 +66,7 @@ def __init__(self, projid=None, annotators=None, activities=None, local_vars_con
def projid(self):
"""Gets the projid of this ProjectUserStatsModel. # noqa: E501
+ The project id. # noqa: E501
:return: The projid of this ProjectUserStatsModel. # noqa: E501
:rtype: int
@@ -76,6 +77,7 @@ def projid(self):
def projid(self, projid):
"""Sets the projid of this ProjectUserStatsModel.
+ The project id. # noqa: E501
:param projid: The projid of this ProjectUserStatsModel. # noqa: E501
:type: int
@@ -87,6 +89,7 @@ def projid(self, projid):
def annotators(self):
"""Gets the annotators of this ProjectUserStatsModel. # noqa: E501
+ The users who ever decided on classification or state of objects. # noqa: E501
:return: The annotators of this ProjectUserStatsModel. # noqa: E501
:rtype: list[MinimalUserBO]
@@ -97,6 +100,7 @@ def annotators(self):
def annotators(self, annotators):
"""Sets the annotators of this ProjectUserStatsModel.
+ The users who ever decided on classification or state of objects. # noqa: E501
:param annotators: The annotators of this ProjectUserStatsModel. # noqa: E501
:type: list[MinimalUserBO]
@@ -108,6 +112,7 @@ def annotators(self, annotators):
def activities(self):
"""Gets the activities of this ProjectUserStatsModel. # noqa: E501
+ More details on annotators' activities. # noqa: E501
:return: The activities of this ProjectUserStatsModel. # noqa: E501
:rtype: list[UserActivity]
@@ -118,6 +123,7 @@ def activities(self):
def activities(self, activities):
"""Sets the activities of this ProjectUserStatsModel.
+ More details on annotators' activities. # noqa: E501
:param activities: The activities of this ProjectUserStatsModel. # noqa: E501
:type: list[UserActivity]
diff --git a/to_back/ecotaxa_cli_py/models/sample_model.py b/to_back/ecotaxa_cli_py/models/sample_model.py
index e25e3469..29f7a139 100644
--- a/to_back/ecotaxa_cli_py/models/sample_model.py
+++ b/to_back/ecotaxa_cli_py/models/sample_model.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -67,8 +67,7 @@ def __init__(self, sampleid=None, projid=None, orig_id=None, latitude=None, long
self._free_columns = None
self.discriminator = None
- if sampleid is not None:
- self.sampleid = sampleid
+ self.sampleid = sampleid
if projid is not None:
self.projid = projid
self.orig_id = orig_id
@@ -85,6 +84,7 @@ def __init__(self, sampleid=None, projid=None, orig_id=None, latitude=None, long
def sampleid(self):
"""Gets the sampleid of this SampleModel. # noqa: E501
+ The sample Id. # noqa: E501
:return: The sampleid of this SampleModel. # noqa: E501
:rtype: int
@@ -95,10 +95,13 @@ def sampleid(self):
def sampleid(self, sampleid):
"""Sets the sampleid of this SampleModel.
+ The sample Id. # noqa: E501
:param sampleid: The sampleid of this SampleModel. # noqa: E501
:type: int
"""
+ if self.local_vars_configuration.client_side_validation and sampleid is None: # noqa: E501
+ raise ValueError("Invalid value for `sampleid`, must not be `None`") # noqa: E501
self._sampleid = sampleid
@@ -106,6 +109,7 @@ def sampleid(self, sampleid):
def projid(self):
"""Gets the projid of this SampleModel. # noqa: E501
+ The project Id. # noqa: E501
:return: The projid of this SampleModel. # noqa: E501
:rtype: int
@@ -116,6 +120,7 @@ def projid(self):
def projid(self, projid):
"""Sets the projid of this SampleModel.
+ The project Id. # noqa: E501
:param projid: The projid of this SampleModel. # noqa: E501
:type: int
@@ -127,6 +132,7 @@ def projid(self, projid):
def orig_id(self):
"""Gets the orig_id of this SampleModel. # noqa: E501
+ Original sample ID from initial TSV load. # noqa: E501
:return: The orig_id of this SampleModel. # noqa: E501
:rtype: str
@@ -137,6 +143,7 @@ def orig_id(self):
def orig_id(self, orig_id):
"""Sets the orig_id of this SampleModel.
+ Original sample ID from initial TSV load. # noqa: E501
:param orig_id: The orig_id of this SampleModel. # noqa: E501
:type: str
@@ -150,6 +157,7 @@ def orig_id(self, orig_id):
def latitude(self):
"""Gets the latitude of this SampleModel. # noqa: E501
+ The latitude. # noqa: E501
:return: The latitude of this SampleModel. # noqa: E501
:rtype: float
@@ -160,6 +168,7 @@ def latitude(self):
def latitude(self, latitude):
"""Sets the latitude of this SampleModel.
+ The latitude. # noqa: E501
:param latitude: The latitude of this SampleModel. # noqa: E501
:type: float
@@ -171,6 +180,7 @@ def latitude(self, latitude):
def longitude(self):
"""Gets the longitude of this SampleModel. # noqa: E501
+ The longitude. # noqa: E501
:return: The longitude of this SampleModel. # noqa: E501
:rtype: float
@@ -181,6 +191,7 @@ def longitude(self):
def longitude(self, longitude):
"""Sets the longitude of this SampleModel.
+ The longitude. # noqa: E501
:param longitude: The longitude of this SampleModel. # noqa: E501
:type: float
@@ -213,6 +224,7 @@ def dataportal_descriptor(self, dataportal_descriptor):
def free_columns(self):
"""Gets the free_columns of this SampleModel. # noqa: E501
+ Free columns from sample mapping in project. # noqa: E501
:return: The free_columns of this SampleModel. # noqa: E501
:rtype: object
@@ -223,6 +235,7 @@ def free_columns(self):
def free_columns(self, free_columns):
"""Sets the free_columns of this SampleModel.
+ Free columns from sample mapping in project. # noqa: E501
:param free_columns: The free_columns of this SampleModel. # noqa: E501
:type: object
diff --git a/to_back/ecotaxa_cli_py/models/sample_taxo_stats_model.py b/to_back/ecotaxa_cli_py/models/sample_taxo_stats_model.py
index d3b1aa90..2881d4e4 100644
--- a/to_back/ecotaxa_cli_py/models/sample_taxo_stats_model.py
+++ b/to_back/ecotaxa_cli_py/models/sample_taxo_stats_model.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -81,6 +81,7 @@ def __init__(self, sample_id=None, used_taxa=None, nb_unclassified=None, nb_vali
def sample_id(self):
"""Gets the sample_id of this SampleTaxoStatsModel. # noqa: E501
+ The sample id. # noqa: E501
:return: The sample_id of this SampleTaxoStatsModel. # noqa: E501
:rtype: int
@@ -91,6 +92,7 @@ def sample_id(self):
def sample_id(self, sample_id):
"""Sets the sample_id of this SampleTaxoStatsModel.
+ The sample id. # noqa: E501
:param sample_id: The sample_id of this SampleTaxoStatsModel. # noqa: E501
:type: int
@@ -102,6 +104,7 @@ def sample_id(self, sample_id):
def used_taxa(self):
"""Gets the used_taxa of this SampleTaxoStatsModel. # noqa: E501
+ The taxa/category ids used inside the sample. -1 for unclassified objects. # noqa: E501
:return: The used_taxa of this SampleTaxoStatsModel. # noqa: E501
:rtype: list[int]
@@ -112,6 +115,7 @@ def used_taxa(self):
def used_taxa(self, used_taxa):
"""Sets the used_taxa of this SampleTaxoStatsModel.
+ The taxa/category ids used inside the sample. -1 for unclassified objects. # noqa: E501
:param used_taxa: The used_taxa of this SampleTaxoStatsModel. # noqa: E501
:type: list[int]
@@ -123,6 +127,7 @@ def used_taxa(self, used_taxa):
def nb_unclassified(self):
"""Gets the nb_unclassified of this SampleTaxoStatsModel. # noqa: E501
+ The number of unclassified objects inside the sample. # noqa: E501
:return: The nb_unclassified of this SampleTaxoStatsModel. # noqa: E501
:rtype: int
@@ -133,6 +138,7 @@ def nb_unclassified(self):
def nb_unclassified(self, nb_unclassified):
"""Sets the nb_unclassified of this SampleTaxoStatsModel.
+ The number of unclassified objects inside the sample. # noqa: E501
:param nb_unclassified: The nb_unclassified of this SampleTaxoStatsModel. # noqa: E501
:type: int
@@ -144,6 +150,7 @@ def nb_unclassified(self, nb_unclassified):
def nb_validated(self):
"""Gets the nb_validated of this SampleTaxoStatsModel. # noqa: E501
+ The number of validated objects inside the sample. # noqa: E501
:return: The nb_validated of this SampleTaxoStatsModel. # noqa: E501
:rtype: int
@@ -154,6 +161,7 @@ def nb_validated(self):
def nb_validated(self, nb_validated):
"""Sets the nb_validated of this SampleTaxoStatsModel.
+ The number of validated objects inside the sample. # noqa: E501
:param nb_validated: The nb_validated of this SampleTaxoStatsModel. # noqa: E501
:type: int
@@ -165,6 +173,7 @@ def nb_validated(self, nb_validated):
def nb_dubious(self):
"""Gets the nb_dubious of this SampleTaxoStatsModel. # noqa: E501
+ The number of dubious objects inside the sample. # noqa: E501
:return: The nb_dubious of this SampleTaxoStatsModel. # noqa: E501
:rtype: int
@@ -175,6 +184,7 @@ def nb_dubious(self):
def nb_dubious(self, nb_dubious):
"""Sets the nb_dubious of this SampleTaxoStatsModel.
+ The number of dubious objects inside the sample. # noqa: E501
:param nb_dubious: The nb_dubious of this SampleTaxoStatsModel. # noqa: E501
:type: int
@@ -186,6 +196,7 @@ def nb_dubious(self, nb_dubious):
def nb_predicted(self):
"""Gets the nb_predicted of this SampleTaxoStatsModel. # noqa: E501
+ The number of predicted objects inside the sample. # noqa: E501
:return: The nb_predicted of this SampleTaxoStatsModel. # noqa: E501
:rtype: int
@@ -196,6 +207,7 @@ def nb_predicted(self):
def nb_predicted(self, nb_predicted):
"""Sets the nb_predicted of this SampleTaxoStatsModel.
+ The number of predicted objects inside the sample. # noqa: E501
:param nb_predicted: The nb_predicted of this SampleTaxoStatsModel. # noqa: E501
:type: int
diff --git a/to_back/ecotaxa_cli_py/models/simple_import_req.py b/to_back/ecotaxa_cli_py/models/simple_import_req.py
index 72296f28..f8bf0249 100644
--- a/to_back/ecotaxa_cli_py/models/simple_import_req.py
+++ b/to_back/ecotaxa_cli_py/models/simple_import_req.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -64,6 +64,7 @@ def __init__(self, source_path=None, values=None, possible_values=["imgdate","im
def source_path(self):
"""Gets the source_path of this SimpleImportReq. # noqa: E501
+ Source path on server, to zip or plain directory. # noqa: E501
:return: The source_path of this SimpleImportReq. # noqa: E501
:rtype: str
@@ -74,6 +75,7 @@ def source_path(self):
def source_path(self, source_path):
"""Sets the source_path of this SimpleImportReq.
+ Source path on server, to zip or plain directory. # noqa: E501
:param source_path: The source_path of this SimpleImportReq. # noqa: E501
:type: str
diff --git a/to_back/ecotaxa_cli_py/models/simple_import_rsp.py b/to_back/ecotaxa_cli_py/models/simple_import_rsp.py
index 6498abc0..601b903a 100644
--- a/to_back/ecotaxa_cli_py/models/simple_import_rsp.py
+++ b/to_back/ecotaxa_cli_py/models/simple_import_rsp.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -59,6 +59,7 @@ def __init__(self, job_id=None, errors=None, local_vars_configuration=None): #
def job_id(self):
"""Gets the job_id of this SimpleImportRsp. # noqa: E501
+ The job which was created for the run. 0 if called with dry_run option. # noqa: E501
:return: The job_id of this SimpleImportRsp. # noqa: E501
:rtype: int
@@ -69,6 +70,7 @@ def job_id(self):
def job_id(self, job_id):
"""Sets the job_id of this SimpleImportRsp.
+ The job which was created for the run. 0 if called with dry_run option. # noqa: E501
:param job_id: The job_id of this SimpleImportRsp. # noqa: E501
:type: int
@@ -82,6 +84,7 @@ def job_id(self, job_id):
def errors(self):
"""Gets the errors of this SimpleImportRsp. # noqa: E501
+ Validation errors, dry_run or not. # noqa: E501
:return: The errors of this SimpleImportRsp. # noqa: E501
:rtype: list[str]
@@ -92,6 +95,7 @@ def errors(self):
def errors(self, errors):
"""Sets the errors of this SimpleImportRsp.
+ Validation errors, dry_run or not. # noqa: E501
:param errors: The errors of this SimpleImportRsp. # noqa: E501
:type: list[str]
diff --git a/to_back/ecotaxa_cli_py/models/subset_req.py b/to_back/ecotaxa_cli_py/models/subset_req.py
index 0cee3db5..ee5335d1 100644
--- a/to_back/ecotaxa_cli_py/models/subset_req.py
+++ b/to_back/ecotaxa_cli_py/models/subset_req.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -37,8 +37,7 @@ class SubsetReq(object):
'dest_prj_id': 'int',
'group_type': 'GroupDefinitions',
'limit_type': 'LimitMethods',
- 'limit_value': 'float',
- 'do_images': 'bool'
+ 'limit_value': 'float'
}
attribute_map = {
@@ -46,11 +45,10 @@ class SubsetReq(object):
'dest_prj_id': 'dest_prj_id',
'group_type': 'group_type',
'limit_type': 'limit_type',
- 'limit_value': 'limit_value',
- 'do_images': 'do_images'
+ 'limit_value': 'limit_value'
}
- def __init__(self, filters=None, dest_prj_id=None, group_type=None, limit_type=None, limit_value=None, do_images=None, local_vars_configuration=None): # noqa: E501
+ def __init__(self, filters=None, dest_prj_id=None, group_type=None, limit_type=None, limit_value=None, local_vars_configuration=None): # noqa: E501
"""SubsetReq - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
@@ -61,7 +59,6 @@ def __init__(self, filters=None, dest_prj_id=None, group_type=None, limit_type=N
self._group_type = None
self._limit_type = None
self._limit_value = None
- self._do_images = None
self.discriminator = None
if filters is not None:
@@ -70,12 +67,12 @@ def __init__(self, filters=None, dest_prj_id=None, group_type=None, limit_type=N
self.group_type = group_type
self.limit_type = limit_type
self.limit_value = limit_value
- self.do_images = do_images
@property
def filters(self):
"""Gets the filters of this SubsetReq. # noqa: E501
+ The filters to apply to project. # noqa: E501
:return: The filters of this SubsetReq. # noqa: E501
:rtype: dict(str, str)
@@ -86,6 +83,7 @@ def filters(self):
def filters(self, filters):
"""Sets the filters of this SubsetReq.
+ The filters to apply to project. # noqa: E501
:param filters: The filters of this SubsetReq. # noqa: E501
:type: dict(str, str)
@@ -97,6 +95,7 @@ def filters(self, filters):
def dest_prj_id(self):
"""Gets the dest_prj_id of this SubsetReq. # noqa: E501
+ The destination project ID. # noqa: E501
:return: The dest_prj_id of this SubsetReq. # noqa: E501
:rtype: int
@@ -107,6 +106,7 @@ def dest_prj_id(self):
def dest_prj_id(self, dest_prj_id):
"""Sets the dest_prj_id of this SubsetReq.
+ The destination project ID. # noqa: E501
:param dest_prj_id: The dest_prj_id of this SubsetReq. # noqa: E501
:type: int
@@ -120,6 +120,7 @@ def dest_prj_id(self, dest_prj_id):
def group_type(self):
"""Gets the group_type of this SubsetReq. # noqa: E501
+ Define the groups in which to apply limits. C for categories, S for samples, A for acquisitions. # noqa: E501
:return: The group_type of this SubsetReq. # noqa: E501
:rtype: GroupDefinitions
@@ -130,6 +131,7 @@ def group_type(self):
def group_type(self, group_type):
"""Sets the group_type of this SubsetReq.
+ Define the groups in which to apply limits. C for categories, S for samples, A for acquisitions. # noqa: E501
:param group_type: The group_type of this SubsetReq. # noqa: E501
:type: GroupDefinitions
@@ -143,6 +145,7 @@ def group_type(self, group_type):
def limit_type(self):
"""Gets the limit_type of this SubsetReq. # noqa: E501
+ The type of limit_value: P for %, V for constant, both per group. # noqa: E501
:return: The limit_type of this SubsetReq. # noqa: E501
:rtype: LimitMethods
@@ -153,6 +156,7 @@ def limit_type(self):
def limit_type(self, limit_type):
"""Sets the limit_type of this SubsetReq.
+ The type of limit_value: P for %, V for constant, both per group. # noqa: E501
:param limit_type: The limit_type of this SubsetReq. # noqa: E501
:type: LimitMethods
@@ -166,6 +170,7 @@ def limit_type(self, limit_type):
def limit_value(self):
"""Gets the limit_value of this SubsetReq. # noqa: E501
+ Limit value, e.g. 20% or 5 per copepoda or 5% per sample. # noqa: E501
:return: The limit_value of this SubsetReq. # noqa: E501
:rtype: float
@@ -176,6 +181,7 @@ def limit_value(self):
def limit_value(self, limit_value):
"""Sets the limit_value of this SubsetReq.
+ Limit value, e.g. 20% or 5 per copepoda or 5% per sample. # noqa: E501
:param limit_value: The limit_value of this SubsetReq. # noqa: E501
:type: float
@@ -185,29 +191,6 @@ def limit_value(self, limit_value):
self._limit_value = limit_value
- @property
- def do_images(self):
- """Gets the do_images of this SubsetReq. # noqa: E501
-
-
- :return: The do_images of this SubsetReq. # noqa: E501
- :rtype: bool
- """
- return self._do_images
-
- @do_images.setter
- def do_images(self, do_images):
- """Sets the do_images of this SubsetReq.
-
-
- :param do_images: The do_images of this SubsetReq. # noqa: E501
- :type: bool
- """
- if self.local_vars_configuration.client_side_validation and do_images is None: # noqa: E501
- raise ValueError("Invalid value for `do_images`, must not be `None`") # noqa: E501
-
- self._do_images = do_images
-
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
diff --git a/to_back/ecotaxa_cli_py/models/subset_rsp.py b/to_back/ecotaxa_cli_py/models/subset_rsp.py
index 389bc248..b4f30d5d 100644
--- a/to_back/ecotaxa_cli_py/models/subset_rsp.py
+++ b/to_back/ecotaxa_cli_py/models/subset_rsp.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -55,6 +55,7 @@ def __init__(self, job_id=None, local_vars_configuration=None): # noqa: E501
def job_id(self):
"""Gets the job_id of this SubsetRsp. # noqa: E501
+ The job created for this operation. # noqa: E501
:return: The job_id of this SubsetRsp. # noqa: E501
:rtype: int
@@ -65,6 +66,7 @@ def job_id(self):
def job_id(self, job_id):
"""Sets the job_id of this SubsetRsp.
+ The job created for this operation. # noqa: E501
:param job_id: The job_id of this SubsetRsp. # noqa: E501
:type: int
diff --git a/to_back/ecotaxa_cli_py/models/taxa_search_rsp.py b/to_back/ecotaxa_cli_py/models/taxa_search_rsp.py
index 6f583add..7941e0fd 100644
--- a/to_back/ecotaxa_cli_py/models/taxa_search_rsp.py
+++ b/to_back/ecotaxa_cli_py/models/taxa_search_rsp.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -68,6 +68,7 @@ def __init__(self, id=None, renm_id=None, text=None, pr=None, local_vars_configu
def id(self):
"""Gets the id of this TaxaSearchRsp. # noqa: E501
+ The taxon/category IDs. # noqa: E501
:return: The id of this TaxaSearchRsp. # noqa: E501
:rtype: int
@@ -78,6 +79,7 @@ def id(self):
def id(self, id):
"""Sets the id of this TaxaSearchRsp.
+ The taxon/category IDs. # noqa: E501
:param id: The id of this TaxaSearchRsp. # noqa: E501
:type: int
@@ -91,6 +93,7 @@ def id(self, id):
def renm_id(self):
"""Gets the renm_id of this TaxaSearchRsp. # noqa: E501
+ The advised replacement ID if the taxon/category is deprecated. # noqa: E501
:return: The renm_id of this TaxaSearchRsp. # noqa: E501
:rtype: int
@@ -101,6 +104,7 @@ def renm_id(self):
def renm_id(self, renm_id):
"""Sets the renm_id of this TaxaSearchRsp.
+ The advised replacement ID if the taxon/category is deprecated. # noqa: E501
:param renm_id: The renm_id of this TaxaSearchRsp. # noqa: E501
:type: int
@@ -112,6 +116,7 @@ def renm_id(self, renm_id):
def text(self):
"""Gets the text of this TaxaSearchRsp. # noqa: E501
+ The taxon name, display one. # noqa: E501
:return: The text of this TaxaSearchRsp. # noqa: E501
:rtype: str
@@ -122,6 +127,7 @@ def text(self):
def text(self, text):
"""Sets the text of this TaxaSearchRsp.
+ The taxon name, display one. # noqa: E501
:param text: The text of this TaxaSearchRsp. # noqa: E501
:type: str
@@ -135,6 +141,7 @@ def text(self, text):
def pr(self):
"""Gets the pr of this TaxaSearchRsp. # noqa: E501
+ 1 if the taxon is in project list, 0 otherwise. # noqa: E501
:return: The pr of this TaxaSearchRsp. # noqa: E501
:rtype: int
@@ -145,6 +152,7 @@ def pr(self):
def pr(self, pr):
"""Sets the pr of this TaxaSearchRsp.
+ 1 if the taxon is in project list, 0 otherwise. # noqa: E501
:param pr: The pr of this TaxaSearchRsp. # noqa: E501
:type: int
diff --git a/to_back/ecotaxa_cli_py/models/taxon_central.py b/to_back/ecotaxa_cli_py/models/taxon_central.py
new file mode 100644
index 00000000..d8a601da
--- /dev/null
+++ b/to_back/ecotaxa_cli_py/models/taxon_central.py
@@ -0,0 +1,542 @@
+# coding: utf-8
+
+"""
+ EcoTaxa
+
+ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
+
+ The version of the OpenAPI document: 0.0.23
+ Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from to_back.ecotaxa_cli_py.configuration import Configuration
+
+
+class TaxonCentral(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 = {
+ 'id': 'int',
+ 'parent_id': 'int',
+ 'name': 'str',
+ 'id_source': 'str',
+ 'taxotype': 'str',
+ 'display_name': 'str',
+ 'lastupdate_datetime': 'datetime',
+ 'id_instance': 'int',
+ 'taxostatus': 'str',
+ 'rename_to': 'int',
+ 'source_url': 'str',
+ 'source_desc': 'str',
+ 'creator_email': 'str',
+ 'creation_datetime': 'datetime',
+ 'nbrobj': 'int',
+ 'nbrobjcum': 'int'
+ }
+
+ attribute_map = {
+ 'id': 'id',
+ 'parent_id': 'parent_id',
+ 'name': 'name',
+ 'id_source': 'id_source',
+ 'taxotype': 'taxotype',
+ 'display_name': 'display_name',
+ 'lastupdate_datetime': 'lastupdate_datetime',
+ 'id_instance': 'id_instance',
+ 'taxostatus': 'taxostatus',
+ 'rename_to': 'rename_to',
+ 'source_url': 'source_url',
+ 'source_desc': 'source_desc',
+ 'creator_email': 'creator_email',
+ 'creation_datetime': 'creation_datetime',
+ 'nbrobj': 'nbrobj',
+ 'nbrobjcum': 'nbrobjcum'
+ }
+
+ def __init__(self, id=None, parent_id=None, name=None, id_source=None, taxotype=None, display_name=None, lastupdate_datetime=None, id_instance=None, taxostatus=None, rename_to=None, source_url=None, source_desc=None, creator_email=None, creation_datetime=None, nbrobj=None, nbrobjcum=None, local_vars_configuration=None): # noqa: E501
+ """TaxonCentral - a model defined in OpenAPI""" # noqa: E501
+ if local_vars_configuration is None:
+ local_vars_configuration = Configuration()
+ self.local_vars_configuration = local_vars_configuration
+
+ self._id = None
+ self._parent_id = None
+ self._name = None
+ self._id_source = None
+ self._taxotype = None
+ self._display_name = None
+ self._lastupdate_datetime = None
+ self._id_instance = None
+ self._taxostatus = None
+ self._rename_to = None
+ self._source_url = None
+ self._source_desc = None
+ self._creator_email = None
+ self._creation_datetime = None
+ self._nbrobj = None
+ self._nbrobjcum = None
+ self.discriminator = None
+
+ self.id = id
+ if parent_id is not None:
+ self.parent_id = parent_id
+ self.name = name
+ if id_source is not None:
+ self.id_source = id_source
+ self.taxotype = taxotype
+ if display_name is not None:
+ self.display_name = display_name
+ if lastupdate_datetime is not None:
+ self.lastupdate_datetime = lastupdate_datetime
+ if id_instance is not None:
+ self.id_instance = id_instance
+ self.taxostatus = taxostatus
+ if rename_to is not None:
+ self.rename_to = rename_to
+ if source_url is not None:
+ self.source_url = source_url
+ if source_desc is not None:
+ self.source_desc = source_desc
+ if creator_email is not None:
+ self.creator_email = creator_email
+ if creation_datetime is not None:
+ self.creation_datetime = creation_datetime
+ if nbrobj is not None:
+ self.nbrobj = nbrobj
+ if nbrobjcum is not None:
+ self.nbrobjcum = nbrobjcum
+
+ @property
+ def id(self):
+ """Gets the id of this TaxonCentral. # noqa: E501
+
+ The unique numeric id of the taxon. # noqa: E501
+
+ :return: The id of this TaxonCentral. # noqa: E501
+ :rtype: int
+ """
+ return self._id
+
+ @id.setter
+ def id(self, id):
+ """Sets the id of this TaxonCentral.
+
+ The unique numeric id of the taxon. # noqa: E501
+
+ :param id: The id of this TaxonCentral. # noqa: E501
+ :type: int
+ """
+ if self.local_vars_configuration.client_side_validation and id is None: # noqa: E501
+ raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501
+
+ self._id = id
+
+ @property
+ def parent_id(self):
+ """Gets the parent_id of this TaxonCentral. # noqa: E501
+
+ The unique numeric id of the taxon parent. # noqa: E501
+
+ :return: The parent_id of this TaxonCentral. # noqa: E501
+ :rtype: int
+ """
+ return self._parent_id
+
+ @parent_id.setter
+ def parent_id(self, parent_id):
+ """Sets the parent_id of this TaxonCentral.
+
+ The unique numeric id of the taxon parent. # noqa: E501
+
+ :param parent_id: The parent_id of this TaxonCentral. # noqa: E501
+ :type: int
+ """
+
+ self._parent_id = parent_id
+
+ @property
+ def name(self):
+ """Gets the name of this TaxonCentral. # noqa: E501
+
+ The name of the taxon. # noqa: E501
+
+ :return: The name of this TaxonCentral. # noqa: E501
+ :rtype: str
+ """
+ return self._name
+
+ @name.setter
+ def name(self, name):
+ """Sets the name of this TaxonCentral.
+
+ The name of the taxon. # noqa: E501
+
+ :param name: The name of this TaxonCentral. # noqa: E501
+ :type: str
+ """
+ if self.local_vars_configuration.client_side_validation and name is None: # noqa: E501
+ raise ValueError("Invalid value for `name`, must not be `None`") # noqa: E501
+
+ self._name = name
+
+ @property
+ def id_source(self):
+ """Gets the id_source of this TaxonCentral. # noqa: E501
+
+ The source ID. # noqa: E501
+
+ :return: The id_source of this TaxonCentral. # noqa: E501
+ :rtype: str
+ """
+ return self._id_source
+
+ @id_source.setter
+ def id_source(self, id_source):
+ """Sets the id_source of this TaxonCentral.
+
+ The source ID. # noqa: E501
+
+ :param id_source: The id_source of this TaxonCentral. # noqa: E501
+ :type: str
+ """
+
+ self._id_source = id_source
+
+ @property
+ def taxotype(self):
+ """Gets the taxotype of this TaxonCentral. # noqa: E501
+
+ The taxon type, 'M' for Morpho or 'P' for Phylo. # noqa: E501
+
+ :return: The taxotype of this TaxonCentral. # noqa: E501
+ :rtype: str
+ """
+ return self._taxotype
+
+ @taxotype.setter
+ def taxotype(self, taxotype):
+ """Sets the taxotype of this TaxonCentral.
+
+ The taxon type, 'M' for Morpho or 'P' for Phylo. # noqa: E501
+
+ :param taxotype: The taxotype of this TaxonCentral. # noqa: E501
+ :type: str
+ """
+ if self.local_vars_configuration.client_side_validation and taxotype is None: # noqa: E501
+ raise ValueError("Invalid value for `taxotype`, must not be `None`") # noqa: E501
+
+ self._taxotype = taxotype
+
+ @property
+ def display_name(self):
+ """Gets the display_name of this TaxonCentral. # noqa: E501
+
+ The display name of the taxon. It is suffixed in EcoTaxoServer with (Deprecated) when taxostatus is 'D' # noqa: E501
+
+ :return: The display_name of this TaxonCentral. # noqa: E501
+ :rtype: str
+ """
+ return self._display_name
+
+ @display_name.setter
+ def display_name(self, display_name):
+ """Sets the display_name of this TaxonCentral.
+
+ The display name of the taxon. It is suffixed in EcoTaxoServer with (Deprecated) when taxostatus is 'D' # noqa: E501
+
+ :param display_name: The display_name of this TaxonCentral. # noqa: E501
+ :type: str
+ """
+
+ self._display_name = display_name
+
+ @property
+ def lastupdate_datetime(self):
+ """Gets the lastupdate_datetime of this TaxonCentral. # noqa: E501
+
+ Taxon last update. Date, with format YYYY-MM-DD hh:mm:ss. # noqa: E501
+
+ :return: The lastupdate_datetime of this TaxonCentral. # noqa: E501
+ :rtype: datetime
+ """
+ return self._lastupdate_datetime
+
+ @lastupdate_datetime.setter
+ def lastupdate_datetime(self, lastupdate_datetime):
+ """Sets the lastupdate_datetime of this TaxonCentral.
+
+ Taxon last update. Date, with format YYYY-MM-DD hh:mm:ss. # noqa: E501
+
+ :param lastupdate_datetime: The lastupdate_datetime of this TaxonCentral. # noqa: E501
+ :type: datetime
+ """
+
+ self._lastupdate_datetime = lastupdate_datetime
+
+ @property
+ def id_instance(self):
+ """Gets the id_instance of this TaxonCentral. # noqa: E501
+
+ The instance Id. # noqa: E501
+
+ :return: The id_instance of this TaxonCentral. # noqa: E501
+ :rtype: int
+ """
+ return self._id_instance
+
+ @id_instance.setter
+ def id_instance(self, id_instance):
+ """Sets the id_instance of this TaxonCentral.
+
+ The instance Id. # noqa: E501
+
+ :param id_instance: The id_instance of this TaxonCentral. # noqa: E501
+ :type: int
+ """
+
+ self._id_instance = id_instance
+
+ @property
+ def taxostatus(self):
+ """Gets the taxostatus of this TaxonCentral. # noqa: E501
+
+ The taxon status, N for Not approved, A for Approved or D for Deprecated. # noqa: E501
+
+ :return: The taxostatus of this TaxonCentral. # noqa: E501
+ :rtype: str
+ """
+ return self._taxostatus
+
+ @taxostatus.setter
+ def taxostatus(self, taxostatus):
+ """Sets the taxostatus of this TaxonCentral.
+
+ The taxon status, N for Not approved, A for Approved or D for Deprecated. # noqa: E501
+
+ :param taxostatus: The taxostatus of this TaxonCentral. # noqa: E501
+ :type: str
+ """
+ if self.local_vars_configuration.client_side_validation and taxostatus is None: # noqa: E501
+ raise ValueError("Invalid value for `taxostatus`, must not be `None`") # noqa: E501
+
+ self._taxostatus = taxostatus
+
+ @property
+ def rename_to(self):
+ """Gets the rename_to of this TaxonCentral. # noqa: E501
+
+ The advised replacement Name if the taxon is deprecated. # noqa: E501
+
+ :return: The rename_to of this TaxonCentral. # noqa: E501
+ :rtype: int
+ """
+ return self._rename_to
+
+ @rename_to.setter
+ def rename_to(self, rename_to):
+ """Sets the rename_to of this TaxonCentral.
+
+ The advised replacement Name if the taxon is deprecated. # noqa: E501
+
+ :param rename_to: The rename_to of this TaxonCentral. # noqa: E501
+ :type: int
+ """
+
+ self._rename_to = rename_to
+
+ @property
+ def source_url(self):
+ """Gets the source_url of this TaxonCentral. # noqa: E501
+
+ The source url. # noqa: E501
+
+ :return: The source_url of this TaxonCentral. # noqa: E501
+ :rtype: str
+ """
+ return self._source_url
+
+ @source_url.setter
+ def source_url(self, source_url):
+ """Sets the source_url of this TaxonCentral.
+
+ The source url. # noqa: E501
+
+ :param source_url: The source_url of this TaxonCentral. # noqa: E501
+ :type: str
+ """
+
+ self._source_url = source_url
+
+ @property
+ def source_desc(self):
+ """Gets the source_desc of this TaxonCentral. # noqa: E501
+
+ The source description. # noqa: E501
+
+ :return: The source_desc of this TaxonCentral. # noqa: E501
+ :rtype: str
+ """
+ return self._source_desc
+
+ @source_desc.setter
+ def source_desc(self, source_desc):
+ """Sets the source_desc of this TaxonCentral.
+
+ The source description. # noqa: E501
+
+ :param source_desc: The source_desc of this TaxonCentral. # noqa: E501
+ :type: str
+ """
+
+ self._source_desc = source_desc
+
+ @property
+ def creator_email(self):
+ """Gets the creator_email of this TaxonCentral. # noqa: E501
+
+ Email of the creator of the taxon. # noqa: E501
+
+ :return: The creator_email of this TaxonCentral. # noqa: E501
+ :rtype: str
+ """
+ return self._creator_email
+
+ @creator_email.setter
+ def creator_email(self, creator_email):
+ """Sets the creator_email of this TaxonCentral.
+
+ Email of the creator of the taxon. # noqa: E501
+
+ :param creator_email: The creator_email of this TaxonCentral. # noqa: E501
+ :type: str
+ """
+
+ self._creator_email = creator_email
+
+ @property
+ def creation_datetime(self):
+ """Gets the creation_datetime of this TaxonCentral. # noqa: E501
+
+ Taxon creation date. Date, with format YYYY-MM-DD hh:mm:ss. # noqa: E501
+
+ :return: The creation_datetime of this TaxonCentral. # noqa: E501
+ :rtype: datetime
+ """
+ return self._creation_datetime
+
+ @creation_datetime.setter
+ def creation_datetime(self, creation_datetime):
+ """Sets the creation_datetime of this TaxonCentral.
+
+ Taxon creation date. Date, with format YYYY-MM-DD hh:mm:ss. # noqa: E501
+
+ :param creation_datetime: The creation_datetime of this TaxonCentral. # noqa: E501
+ :type: datetime
+ """
+
+ self._creation_datetime = creation_datetime
+
+ @property
+ def nbrobj(self):
+ """Gets the nbrobj of this TaxonCentral. # noqa: E501
+
+
+ :return: The nbrobj of this TaxonCentral. # noqa: E501
+ :rtype: int
+ """
+ return self._nbrobj
+
+ @nbrobj.setter
+ def nbrobj(self, nbrobj):
+ """Sets the nbrobj of this TaxonCentral.
+
+
+ :param nbrobj: The nbrobj of this TaxonCentral. # noqa: E501
+ :type: int
+ """
+
+ self._nbrobj = nbrobj
+
+ @property
+ def nbrobjcum(self):
+ """Gets the nbrobjcum of this TaxonCentral. # noqa: E501
+
+
+ :return: The nbrobjcum of this TaxonCentral. # noqa: E501
+ :rtype: int
+ """
+ return self._nbrobjcum
+
+ @nbrobjcum.setter
+ def nbrobjcum(self, nbrobjcum):
+ """Sets the nbrobjcum of this TaxonCentral.
+
+
+ :param nbrobjcum: The nbrobjcum of this TaxonCentral. # noqa: E501
+ :type: int
+ """
+
+ self._nbrobjcum = nbrobjcum
+
+ 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, TaxonCentral):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, TaxonCentral):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/to_back/ecotaxa_cli_py/models/taxon_model.py b/to_back/ecotaxa_cli_py/models/taxon_model.py
index 385a078d..abd8f5aa 100644
--- a/to_back/ecotaxa_cli_py/models/taxon_model.py
+++ b/to_back/ecotaxa_cli_py/models/taxon_model.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -92,6 +92,7 @@ def __init__(self, id=None, renm_id=None, name=None, type=None, nb_objects=None,
def id(self):
"""Gets the id of this TaxonModel. # noqa: E501
+ The taxon/category IDs. # noqa: E501
:return: The id of this TaxonModel. # noqa: E501
:rtype: int
@@ -102,6 +103,7 @@ def id(self):
def id(self, id):
"""Sets the id of this TaxonModel.
+ The taxon/category IDs. # noqa: E501
:param id: The id of this TaxonModel. # noqa: E501
:type: int
@@ -115,6 +117,7 @@ def id(self, id):
def renm_id(self):
"""Gets the renm_id of this TaxonModel. # noqa: E501
+ The advised replacement ID if the taxon/category is deprecated. # noqa: E501
:return: The renm_id of this TaxonModel. # noqa: E501
:rtype: int
@@ -125,6 +128,7 @@ def renm_id(self):
def renm_id(self, renm_id):
"""Sets the renm_id of this TaxonModel.
+ The advised replacement ID if the taxon/category is deprecated. # noqa: E501
:param renm_id: The renm_id of this TaxonModel. # noqa: E501
:type: int
@@ -136,6 +140,7 @@ def renm_id(self, renm_id):
def name(self):
"""Gets the name of this TaxonModel. # noqa: E501
+ The taxon/category verbatim name. # noqa: E501
:return: The name of this TaxonModel. # noqa: E501
:rtype: str
@@ -146,6 +151,7 @@ def name(self):
def name(self, name):
"""Sets the name of this TaxonModel.
+ The taxon/category verbatim name. # noqa: E501
:param name: The name of this TaxonModel. # noqa: E501
:type: str
@@ -159,6 +165,7 @@ def name(self, name):
def type(self):
"""Gets the type of this TaxonModel. # noqa: E501
+ The taxon/category type, 'M' for Morpho or 'P' for Phylo. # noqa: E501
:return: The type of this TaxonModel. # noqa: E501
:rtype: str
@@ -169,6 +176,7 @@ def type(self):
def type(self, type):
"""Sets the type of this TaxonModel.
+ The taxon/category type, 'M' for Morpho or 'P' for Phylo. # noqa: E501
:param type: The type of this TaxonModel. # noqa: E501
:type: str
@@ -182,6 +190,7 @@ def type(self, type):
def nb_objects(self):
"""Gets the nb_objects of this TaxonModel. # noqa: E501
+ How many objects are classified in this category. # noqa: E501
:return: The nb_objects of this TaxonModel. # noqa: E501
:rtype: int
@@ -192,6 +201,7 @@ def nb_objects(self):
def nb_objects(self, nb_objects):
"""Sets the nb_objects of this TaxonModel.
+ How many objects are classified in this category. # noqa: E501
:param nb_objects: The nb_objects of this TaxonModel. # noqa: E501
:type: int
@@ -205,6 +215,7 @@ def nb_objects(self, nb_objects):
def nb_children_objects(self):
"""Gets the nb_children_objects of this TaxonModel. # noqa: E501
+ How many objects are classified in this category children (not itself). # noqa: E501
:return: The nb_children_objects of this TaxonModel. # noqa: E501
:rtype: int
@@ -215,6 +226,7 @@ def nb_children_objects(self):
def nb_children_objects(self, nb_children_objects):
"""Sets the nb_children_objects of this TaxonModel.
+ How many objects are classified in this category children (not itself). # noqa: E501
:param nb_children_objects: The nb_children_objects of this TaxonModel. # noqa: E501
:type: int
@@ -228,6 +240,7 @@ def nb_children_objects(self, nb_children_objects):
def display_name(self):
"""Gets the display_name of this TaxonModel. # noqa: E501
+ The taxon/category display name. # noqa: E501
:return: The display_name of this TaxonModel. # noqa: E501
:rtype: str
@@ -238,6 +251,7 @@ def display_name(self):
def display_name(self, display_name):
"""Sets the display_name of this TaxonModel.
+ The taxon/category display name. # noqa: E501
:param display_name: The display_name of this TaxonModel. # noqa: E501
:type: str
@@ -251,6 +265,7 @@ def display_name(self, display_name):
def lineage(self):
"""Gets the lineage of this TaxonModel. # noqa: E501
+ The taxon/category name of ancestors, including self, in first. # noqa: E501
:return: The lineage of this TaxonModel. # noqa: E501
:rtype: list[str]
@@ -261,6 +276,7 @@ def lineage(self):
def lineage(self, lineage):
"""Sets the lineage of this TaxonModel.
+ The taxon/category name of ancestors, including self, in first. # noqa: E501
:param lineage: The lineage of this TaxonModel. # noqa: E501
:type: list[str]
@@ -274,6 +290,7 @@ def lineage(self, lineage):
def id_lineage(self):
"""Gets the id_lineage of this TaxonModel. # noqa: E501
+ The taxon/category IDs of ancestors, including self, in first. # noqa: E501
:return: The id_lineage of this TaxonModel. # noqa: E501
:rtype: list[int]
@@ -284,6 +301,7 @@ def id_lineage(self):
def id_lineage(self, id_lineage):
"""Sets the id_lineage of this TaxonModel.
+ The taxon/category IDs of ancestors, including self, in first. # noqa: E501
:param id_lineage: The id_lineage of this TaxonModel. # noqa: E501
:type: list[int]
@@ -297,6 +315,7 @@ def id_lineage(self, id_lineage):
def children(self):
"""Gets the children of this TaxonModel. # noqa: E501
+ The taxon/category IDs of children. # noqa: E501
:return: The children of this TaxonModel. # noqa: E501
:rtype: list[int]
@@ -307,6 +326,7 @@ def children(self):
def children(self, children):
"""Sets the children of this TaxonModel.
+ The taxon/category IDs of children. # noqa: E501
:param children: The children of this TaxonModel. # noqa: E501
:type: list[int]
diff --git a/to_back/ecotaxa_cli_py/models/taxon_usage_model.py b/to_back/ecotaxa_cli_py/models/taxon_usage_model.py
index bfdeadbb..ebde9429 100644
--- a/to_back/ecotaxa_cli_py/models/taxon_usage_model.py
+++ b/to_back/ecotaxa_cli_py/models/taxon_usage_model.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -55,14 +55,17 @@ def __init__(self, projid=None, title=None, nb_validated=None, local_vars_config
self._nb_validated = None
self.discriminator = None
- self.projid = projid
- self.title = title
+ if projid is not None:
+ self.projid = projid
+ if title is not None:
+ self.title = title
self.nb_validated = nb_validated
@property
def projid(self):
"""Gets the projid of this TaxonUsageModel. # noqa: E501
+ Project unique identifier. # noqa: E501
:return: The projid of this TaxonUsageModel. # noqa: E501
:rtype: int
@@ -73,12 +76,11 @@ def projid(self):
def projid(self, projid):
"""Sets the projid of this TaxonUsageModel.
+ Project unique identifier. # noqa: E501
:param projid: The projid of this TaxonUsageModel. # noqa: E501
:type: int
"""
- if self.local_vars_configuration.client_side_validation and projid is None: # noqa: E501
- raise ValueError("Invalid value for `projid`, must not be `None`") # noqa: E501
self._projid = projid
@@ -86,6 +88,7 @@ def projid(self, projid):
def title(self):
"""Gets the title of this TaxonUsageModel. # noqa: E501
+ Project's title. # noqa: E501
:return: The title of this TaxonUsageModel. # noqa: E501
:rtype: str
@@ -96,12 +99,11 @@ def title(self):
def title(self, title):
"""Sets the title of this TaxonUsageModel.
+ Project's title. # noqa: E501
:param title: The title of this TaxonUsageModel. # noqa: E501
:type: str
"""
- if self.local_vars_configuration.client_side_validation and title is None: # noqa: E501
- raise ValueError("Invalid value for `title`, must not be `None`") # noqa: E501
self._title = title
@@ -109,6 +111,7 @@ def title(self, title):
def nb_validated(self):
"""Gets the nb_validated of this TaxonUsageModel. # noqa: E501
+ How many validated objects in this category in this project. # noqa: E501
:return: The nb_validated of this TaxonUsageModel. # noqa: E501
:rtype: int
@@ -119,6 +122,7 @@ def nb_validated(self):
def nb_validated(self, nb_validated):
"""Sets the nb_validated of this TaxonUsageModel.
+ How many validated objects in this category in this project. # noqa: E501
:param nb_validated: The nb_validated of this TaxonUsageModel. # noqa: E501
:type: int
diff --git a/to_back/ecotaxa_cli_py/models/taxonomy_tree_status.py b/to_back/ecotaxa_cli_py/models/taxonomy_tree_status.py
index 0cc7c53c..346aaae8 100644
--- a/to_back/ecotaxa_cli_py/models/taxonomy_tree_status.py
+++ b/to_back/ecotaxa_cli_py/models/taxonomy_tree_status.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -56,6 +56,7 @@ def __init__(self, last_refresh=None, local_vars_configuration=None): # noqa: E
def last_refresh(self):
"""Gets the last_refresh of this TaxonomyTreeStatus. # noqa: E501
+ Taxonomy tree last refresh/sync from taxonomy server. Date, with format YYYY-MM-DDThh:mm:ss. # noqa: E501
:return: The last_refresh of this TaxonomyTreeStatus. # noqa: E501
:rtype: str
@@ -66,6 +67,7 @@ def last_refresh(self):
def last_refresh(self, last_refresh):
"""Sets the last_refresh of this TaxonomyTreeStatus.
+ Taxonomy tree last refresh/sync from taxonomy server. Date, with format YYYY-MM-DDThh:mm:ss. # noqa: E501
:param last_refresh: The last_refresh of this TaxonomyTreeStatus. # noqa: E501
:type: str
diff --git a/to_back/ecotaxa_cli_py/models/user_activity.py b/to_back/ecotaxa_cli_py/models/user_activity.py
index 7cac856f..50a9753f 100644
--- a/to_back/ecotaxa_cli_py/models/user_activity.py
+++ b/to_back/ecotaxa_cli_py/models/user_activity.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
diff --git a/to_back/ecotaxa_cli_py/models/user_model.py b/to_back/ecotaxa_cli_py/models/user_model.py
index f83c5d7c..6cf84bc4 100644
--- a/to_back/ecotaxa_cli_py/models/user_model.py
+++ b/to_back/ecotaxa_cli_py/models/user_model.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -70,8 +70,7 @@ def __init__(self, id=None, email=None, name=None, organisation=None, active=Non
self._usercreationreason = None
self.discriminator = None
- if id is not None:
- self.id = id
+ self.id = id
self.email = email
self.name = name
if organisation is not None:
@@ -89,6 +88,7 @@ def __init__(self, id=None, email=None, name=None, organisation=None, active=Non
def id(self):
"""Gets the id of this UserModel. # noqa: E501
+ The unique numeric id of this user. # noqa: E501
:return: The id of this UserModel. # noqa: E501
:rtype: int
@@ -99,10 +99,13 @@ def id(self):
def id(self, id):
"""Sets the id of this UserModel.
+ The unique numeric id of this user. # noqa: E501
:param id: The id of this UserModel. # noqa: E501
:type: int
"""
+ if self.local_vars_configuration.client_side_validation and id is None: # noqa: E501
+ raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501
self._id = id
@@ -110,6 +113,7 @@ def id(self, id):
def email(self):
"""Gets the email of this UserModel. # noqa: E501
+ User's email address, as text, used during registration. # noqa: E501
:return: The email of this UserModel. # noqa: E501
:rtype: str
@@ -120,6 +124,7 @@ def email(self):
def email(self, email):
"""Sets the email of this UserModel.
+ User's email address, as text, used during registration. # noqa: E501
:param email: The email of this UserModel. # noqa: E501
:type: str
@@ -133,6 +138,7 @@ def email(self, email):
def name(self):
"""Gets the name of this UserModel. # noqa: E501
+ User's full name, as text. # noqa: E501
:return: The name of this UserModel. # noqa: E501
:rtype: str
@@ -143,6 +149,7 @@ def name(self):
def name(self, name):
"""Sets the name of this UserModel.
+ User's full name, as text. # noqa: E501
:param name: The name of this UserModel. # noqa: E501
:type: str
@@ -156,6 +163,7 @@ def name(self, name):
def organisation(self):
"""Gets the organisation of this UserModel. # noqa: E501
+ User's organisation name, as text. # noqa: E501
:return: The organisation of this UserModel. # noqa: E501
:rtype: str
@@ -166,6 +174,7 @@ def organisation(self):
def organisation(self, organisation):
"""Sets the organisation of this UserModel.
+ User's organisation name, as text. # noqa: E501
:param organisation: The organisation of this UserModel. # noqa: E501
:type: str
@@ -177,6 +186,7 @@ def organisation(self, organisation):
def active(self):
"""Gets the active of this UserModel. # noqa: E501
+ Whether the user is still active. # noqa: E501
:return: The active of this UserModel. # noqa: E501
:rtype: bool
@@ -187,6 +197,7 @@ def active(self):
def active(self, active):
"""Sets the active of this UserModel.
+ Whether the user is still active. # noqa: E501
:param active: The active of this UserModel. # noqa: E501
:type: bool
@@ -198,6 +209,7 @@ def active(self, active):
def country(self):
"""Gets the country of this UserModel. # noqa: E501
+ The country name, as text (but chosen in a consistent list). # noqa: E501
:return: The country of this UserModel. # noqa: E501
:rtype: str
@@ -208,6 +220,7 @@ def country(self):
def country(self, country):
"""Sets the country of this UserModel.
+ The country name, as text (but chosen in a consistent list). # noqa: E501
:param country: The country of this UserModel. # noqa: E501
:type: str
@@ -219,6 +232,7 @@ def country(self, country):
def usercreationdate(self):
"""Gets the usercreationdate of this UserModel. # noqa: E501
+ The date of creation of the user, as text formatted according to the ISO 8601 standard. # noqa: E501
:return: The usercreationdate of this UserModel. # noqa: E501
:rtype: datetime
@@ -229,6 +243,7 @@ def usercreationdate(self):
def usercreationdate(self, usercreationdate):
"""Sets the usercreationdate of this UserModel.
+ The date of creation of the user, as text formatted according to the ISO 8601 standard. # noqa: E501
:param usercreationdate: The usercreationdate of this UserModel. # noqa: E501
:type: datetime
@@ -240,6 +255,7 @@ def usercreationdate(self, usercreationdate):
def usercreationreason(self):
"""Gets the usercreationreason of this UserModel. # noqa: E501
+ Paragraph describing the usage of EcoTaxa made by the user. # noqa: E501
:return: The usercreationreason of this UserModel. # noqa: E501
:rtype: str
@@ -250,6 +266,7 @@ def usercreationreason(self):
def usercreationreason(self, usercreationreason):
"""Sets the usercreationreason of this UserModel.
+ Paragraph describing the usage of EcoTaxa made by the user. # noqa: E501
:param usercreationreason: The usercreationreason of this UserModel. # noqa: E501
:type: str
diff --git a/to_back/ecotaxa_cli_py/models/user_model_with_rights.py b/to_back/ecotaxa_cli_py/models/user_model_with_rights.py
index 15f272ef..f7e5303c 100644
--- a/to_back/ecotaxa_cli_py/models/user_model_with_rights.py
+++ b/to_back/ecotaxa_cli_py/models/user_model_with_rights.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
@@ -76,8 +76,7 @@ def __init__(self, id=None, email=None, name=None, organisation=None, active=Non
self._last_used_projects = None
self.discriminator = None
- if id is not None:
- self.id = id
+ self.id = id
self.email = email
self.name = name
if organisation is not None:
@@ -99,6 +98,7 @@ def __init__(self, id=None, email=None, name=None, organisation=None, active=Non
def id(self):
"""Gets the id of this UserModelWithRights. # noqa: E501
+ The unique numeric id of this user. # noqa: E501
:return: The id of this UserModelWithRights. # noqa: E501
:rtype: int
@@ -109,10 +109,13 @@ def id(self):
def id(self, id):
"""Sets the id of this UserModelWithRights.
+ The unique numeric id of this user. # noqa: E501
:param id: The id of this UserModelWithRights. # noqa: E501
:type: int
"""
+ if self.local_vars_configuration.client_side_validation and id is None: # noqa: E501
+ raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501
self._id = id
@@ -120,6 +123,7 @@ def id(self, id):
def email(self):
"""Gets the email of this UserModelWithRights. # noqa: E501
+ User's email address, as text, used during registration. # noqa: E501
:return: The email of this UserModelWithRights. # noqa: E501
:rtype: str
@@ -130,6 +134,7 @@ def email(self):
def email(self, email):
"""Sets the email of this UserModelWithRights.
+ User's email address, as text, used during registration. # noqa: E501
:param email: The email of this UserModelWithRights. # noqa: E501
:type: str
@@ -143,6 +148,7 @@ def email(self, email):
def name(self):
"""Gets the name of this UserModelWithRights. # noqa: E501
+ User's full name, as text. # noqa: E501
:return: The name of this UserModelWithRights. # noqa: E501
:rtype: str
@@ -153,6 +159,7 @@ def name(self):
def name(self, name):
"""Sets the name of this UserModelWithRights.
+ User's full name, as text. # noqa: E501
:param name: The name of this UserModelWithRights. # noqa: E501
:type: str
@@ -166,6 +173,7 @@ def name(self, name):
def organisation(self):
"""Gets the organisation of this UserModelWithRights. # noqa: E501
+ User's organisation name, as text. # noqa: E501
:return: The organisation of this UserModelWithRights. # noqa: E501
:rtype: str
@@ -176,6 +184,7 @@ def organisation(self):
def organisation(self, organisation):
"""Sets the organisation of this UserModelWithRights.
+ User's organisation name, as text. # noqa: E501
:param organisation: The organisation of this UserModelWithRights. # noqa: E501
:type: str
@@ -187,6 +196,7 @@ def organisation(self, organisation):
def active(self):
"""Gets the active of this UserModelWithRights. # noqa: E501
+ Whether the user is still active. # noqa: E501
:return: The active of this UserModelWithRights. # noqa: E501
:rtype: bool
@@ -197,6 +207,7 @@ def active(self):
def active(self, active):
"""Sets the active of this UserModelWithRights.
+ Whether the user is still active. # noqa: E501
:param active: The active of this UserModelWithRights. # noqa: E501
:type: bool
@@ -208,6 +219,7 @@ def active(self, active):
def country(self):
"""Gets the country of this UserModelWithRights. # noqa: E501
+ The country name, as text (but chosen in a consistent list). # noqa: E501
:return: The country of this UserModelWithRights. # noqa: E501
:rtype: str
@@ -218,6 +230,7 @@ def country(self):
def country(self, country):
"""Sets the country of this UserModelWithRights.
+ The country name, as text (but chosen in a consistent list). # noqa: E501
:param country: The country of this UserModelWithRights. # noqa: E501
:type: str
@@ -229,6 +242,7 @@ def country(self, country):
def usercreationdate(self):
"""Gets the usercreationdate of this UserModelWithRights. # noqa: E501
+ The date of creation of the user, as text formatted according to the ISO 8601 standard. # noqa: E501
:return: The usercreationdate of this UserModelWithRights. # noqa: E501
:rtype: datetime
@@ -239,6 +253,7 @@ def usercreationdate(self):
def usercreationdate(self, usercreationdate):
"""Sets the usercreationdate of this UserModelWithRights.
+ The date of creation of the user, as text formatted according to the ISO 8601 standard. # noqa: E501
:param usercreationdate: The usercreationdate of this UserModelWithRights. # noqa: E501
:type: datetime
@@ -250,6 +265,7 @@ def usercreationdate(self, usercreationdate):
def usercreationreason(self):
"""Gets the usercreationreason of this UserModelWithRights. # noqa: E501
+ Paragraph describing the usage of EcoTaxa made by the user. # noqa: E501
:return: The usercreationreason of this UserModelWithRights. # noqa: E501
:rtype: str
@@ -260,6 +276,7 @@ def usercreationreason(self):
def usercreationreason(self, usercreationreason):
"""Sets the usercreationreason of this UserModelWithRights.
+ Paragraph describing the usage of EcoTaxa made by the user. # noqa: E501
:param usercreationreason: The usercreationreason of this UserModelWithRights. # noqa: E501
:type: str
@@ -271,6 +288,7 @@ def usercreationreason(self, usercreationreason):
def can_do(self):
"""Gets the can_do of this UserModelWithRights. # noqa: E501
+ List of User's allowed actions : 1 create a project, 2 administrate the app, 3 administrate users, 4 create taxon. # noqa: E501
:return: The can_do of this UserModelWithRights. # noqa: E501
:rtype: list[int]
@@ -281,6 +299,7 @@ def can_do(self):
def can_do(self, can_do):
"""Sets the can_do of this UserModelWithRights.
+ List of User's allowed actions : 1 create a project, 2 administrate the app, 3 administrate users, 4 create taxon. # noqa: E501
:param can_do: The can_do of this UserModelWithRights. # noqa: E501
:type: list[int]
@@ -292,6 +311,7 @@ def can_do(self, can_do):
def last_used_projects(self):
"""Gets the last_used_projects of this UserModelWithRights. # noqa: E501
+ List of User's last used projects. # noqa: E501
:return: The last_used_projects of this UserModelWithRights. # noqa: E501
:rtype: list[ProjectSummaryModel]
@@ -302,6 +322,7 @@ def last_used_projects(self):
def last_used_projects(self, last_used_projects):
"""Sets the last_used_projects of this UserModelWithRights.
+ List of User's last used projects. # noqa: E501
:param last_used_projects: The last_used_projects of this UserModelWithRights. # noqa: E501
:type: list[ProjectSummaryModel]
diff --git a/to_back/ecotaxa_cli_py/models/validation_error.py b/to_back/ecotaxa_cli_py/models/validation_error.py
index fcfe2add..346ab18a 100644
--- a/to_back/ecotaxa_cli_py/models/validation_error.py
+++ b/to_back/ecotaxa_cli_py/models/validation_error.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""
diff --git a/to_back/ecotaxa_cli_py/rest.py b/to_back/ecotaxa_cli_py/rest.py
index 74b18d32..27a2daa1 100644
--- a/to_back/ecotaxa_cli_py/rest.py
+++ b/to_back/ecotaxa_cli_py/rest.py
@@ -5,7 +5,7 @@
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
- The version of the OpenAPI document: 0.0.17
+ The version of the OpenAPI document: 0.0.23
Generated by: https://openapi-generator.tech
"""