summaryrefslogtreecommitdiffstats
path: root/python_openapi_client/fatcat_openapi_client/api
diff options
context:
space:
mode:
Diffstat (limited to 'python_openapi_client/fatcat_openapi_client/api')
-rw-r--r--python_openapi_client/fatcat_openapi_client/api/default_api.py272
1 files changed, 178 insertions, 94 deletions
diff --git a/python_openapi_client/fatcat_openapi_client/api/default_api.py b/python_openapi_client/fatcat_openapi_client/api/default_api.py
index a15d9f06..188c725d 100644
--- a/python_openapi_client/fatcat_openapi_client/api/default_api.py
+++ b/python_openapi_client/fatcat_openapi_client/api/default_api.py
@@ -3,10 +3,10 @@
"""
fatcat
- A scalable, versioned, API-oriented catalog of bibliographic entities and file metadata # noqa: E501
+ Fatcat is a scalable, versioned, API-oriented catalog of bibliographic entities and file metadata. # noqa: E501
OpenAPI spec version: 0.3.0
-
+ Contact: webservices@archive.org
Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
@@ -36,6 +36,7 @@ class DefaultApi(object):
def accept_editgroup(self, editgroup_id, **kwargs): # noqa: E501
"""accept_editgroup # noqa: E501
+ Accept (\"merge\") the given editgroup into the catalog. The editgroup must be open (not already accepted), and the editor making this request must have the `admin` role. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.accept_editgroup(editgroup_id, async=True)
@@ -57,6 +58,7 @@ class DefaultApi(object):
def accept_editgroup_with_http_info(self, editgroup_id, **kwargs): # noqa: E501
"""accept_editgroup # noqa: E501
+ Accept (\"merge\") the given editgroup into the catalog. The editgroup must be open (not already accepted), and the editor making this request must have the `admin` role. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.accept_editgroup_with_http_info(editgroup_id, async=True)
@@ -141,6 +143,7 @@ class DefaultApi(object):
def auth_check(self, **kwargs): # noqa: E501
"""auth_check # noqa: E501
+ Verify that authentication (API token) is working as expected. The optional `role` parameter can be used to verify that the current account (editor) has permissions for the given role. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.auth_check(async=True)
@@ -162,6 +165,7 @@ class DefaultApi(object):
def auth_check_with_http_info(self, **kwargs): # noqa: E501
"""auth_check # noqa: E501
+ Verify that authentication (API token) is working as expected. The optional `role` parameter can be used to verify that the current account (editor) has permissions for the given role. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.auth_check_with_http_info(async=True)
@@ -234,6 +238,7 @@ class DefaultApi(object):
def auth_oidc(self, oidc_params, **kwargs): # noqa: E501
"""auth_oidc # noqa: E501
+ Login or create editor account using OIDC metadata (internal method). This method is used by privileged front-end tools (like the web interface service) to process editor logins using OpenID Connect (OIDC) and/or OAuth. Most accounts (including tool and bot accounts) do not have sufficient privileges to call this method, which requires the `admin` role. The method returns an API token; the HTTP status code indicates whether an existing account was logged in, or a new account was created. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.auth_oidc(oidc_params, async=True)
@@ -255,6 +260,7 @@ class DefaultApi(object):
def auth_oidc_with_http_info(self, oidc_params, **kwargs): # noqa: E501
"""auth_oidc # noqa: E501
+ Login or create editor account using OIDC metadata (internal method). This method is used by privileged front-end tools (like the web interface service) to process editor logins using OpenID Connect (OIDC) and/or OAuth. Most accounts (including tool and bot accounts) do not have sufficient privileges to call this method, which requires the `admin` role. The method returns an API token; the HTTP status code indicates whether an existing account was logged in, or a new account was created. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.auth_oidc_with_http_info(oidc_params, async=True)
@@ -331,6 +337,7 @@ class DefaultApi(object):
def create_container(self, editgroup_id, entity, **kwargs): # noqa: E501
"""create_container # noqa: E501
+ Create a single Container entity as part of an existing editgroup. Editgroup must be mutable (aka, not accepted) and editor must have permission (aka, have created the editgrou p or have `admin` role). # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.create_container(editgroup_id, entity, async=True)
@@ -353,6 +360,7 @@ class DefaultApi(object):
def create_container_with_http_info(self, editgroup_id, entity, **kwargs): # noqa: E501
"""create_container # noqa: E501
+ Create a single Container entity as part of an existing editgroup. Editgroup must be mutable (aka, not accepted) and editor must have permission (aka, have created the editgrou p or have `admin` role). # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.create_container_with_http_info(editgroup_id, entity, async=True)
@@ -436,6 +444,7 @@ class DefaultApi(object):
def create_container_auto_batch(self, auto_batch, **kwargs): # noqa: E501
"""create_container_auto_batch # noqa: E501
+ Create a set of Container entities as part of a new editgroup, and accept that editgroup in the same atomic request. This method is mostly useful for bulk import of new entities by carefully written bots. This method is more efficient than creating an editgroup, several entities, then accepting the editgroup, both in terms of API requests required and database load. Requires `admin` role. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.create_container_auto_batch(auto_batch, async=True)
@@ -457,6 +466,7 @@ class DefaultApi(object):
def create_container_auto_batch_with_http_info(self, auto_batch, **kwargs): # noqa: E501
"""create_container_auto_batch # noqa: E501
+ Create a set of Container entities as part of a new editgroup, and accept that editgroup in the same atomic request. This method is mostly useful for bulk import of new entities by carefully written bots. This method is more efficient than creating an editgroup, several entities, then accepting the editgroup, both in terms of API requests required and database load. Requires `admin` role. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.create_container_auto_batch_with_http_info(auto_batch, async=True)
@@ -735,6 +745,7 @@ class DefaultApi(object):
def create_editgroup(self, editgroup, **kwargs): # noqa: E501
"""create_editgroup # noqa: E501
+ Creates a new editgroup. By default the editor making this request will be the author of the editgroup. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.create_editgroup(editgroup, async=True)
@@ -756,6 +767,7 @@ class DefaultApi(object):
def create_editgroup_with_http_info(self, editgroup, **kwargs): # noqa: E501
"""create_editgroup # noqa: E501
+ Creates a new editgroup. By default the editor making this request will be the author of the editgroup. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.create_editgroup_with_http_info(editgroup, async=True)
@@ -832,6 +844,7 @@ class DefaultApi(object):
def create_editgroup_annotation(self, editgroup_id, annotation, **kwargs): # noqa: E501
"""create_editgroup_annotation # noqa: E501
+ Submits a new annotation to the specified editgroup. The editgroup must be open (not already accepted). The annotation will automatically have authorship of the editor making this request. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.create_editgroup_annotation(editgroup_id, annotation, async=True)
@@ -854,6 +867,7 @@ class DefaultApi(object):
def create_editgroup_annotation_with_http_info(self, editgroup_id, annotation, **kwargs): # noqa: E501
"""create_editgroup_annotation # noqa: E501
+ Submits a new annotation to the specified editgroup. The editgroup must be open (not already accepted). The annotation will automatically have authorship of the editor making this request. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.create_editgroup_annotation_with_http_info(editgroup_id, annotation, async=True)
@@ -1349,6 +1363,7 @@ class DefaultApi(object):
def create_release(self, editgroup_id, entity, **kwargs): # noqa: E501
"""create_release # noqa: E501
+ Create a single Release entity as part of an existing editgroup. If the `work_id` field is not set, a work entity will be created automatically and this field set pointing to the new work. Editgroup must be mutable (aka, not accepted) and editor must have permission (aka, have created the editgrou p or have `admin` role). # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.create_release(editgroup_id, entity, async=True)
@@ -1371,6 +1386,7 @@ class DefaultApi(object):
def create_release_with_http_info(self, editgroup_id, entity, **kwargs): # noqa: E501
"""create_release # noqa: E501
+ Create a single Release entity as part of an existing editgroup. If the `work_id` field is not set, a work entity will be created automatically and this field set pointing to the new work. Editgroup must be mutable (aka, not accepted) and editor must have permission (aka, have created the editgrou p or have `admin` role). # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.create_release_with_http_info(editgroup_id, entity, async=True)
@@ -1454,6 +1470,7 @@ class DefaultApi(object):
def create_release_auto_batch(self, auto_batch, **kwargs): # noqa: E501
"""create_release_auto_batch # noqa: E501
+ Create a set of Release entities as part of a new editgroup, and accept that editgroup in the same atomic request. This method is mostly useful for bulk import of new entities by carefully written bots. This method is more efficient than creating an editgroup, several entities, then accepting the editgroup, both in terms of API requests required and database load. Requires `admin` role. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.create_release_auto_batch(auto_batch, async=True)
@@ -1475,6 +1492,7 @@ class DefaultApi(object):
def create_release_auto_batch_with_http_info(self, auto_batch, **kwargs): # noqa: E501
"""create_release_auto_batch # noqa: E501
+ Create a set of Release entities as part of a new editgroup, and accept that editgroup in the same atomic request. This method is mostly useful for bulk import of new entities by carefully written bots. This method is more efficient than creating an editgroup, several entities, then accepting the editgroup, both in terms of API requests required and database load. Requires `admin` role. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.create_release_auto_batch_with_http_info(auto_batch, async=True)
@@ -1955,6 +1973,7 @@ class DefaultApi(object):
def delete_container(self, editgroup_id, ident, **kwargs): # noqa: E501
"""delete_container # noqa: E501
+ Creates a new \"deletion\" edit for a specific entity as part of an existing editgroup. This is not the method to use to remove an edit from an editgroup; for that use `delete_container_edit`. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.delete_container(editgroup_id, ident, async=True)
@@ -1977,6 +1996,7 @@ class DefaultApi(object):
def delete_container_with_http_info(self, editgroup_id, ident, **kwargs): # noqa: E501
"""delete_container # noqa: E501
+ Creates a new \"deletion\" edit for a specific entity as part of an existing editgroup. This is not the method to use to remove an edit from an editgroup; for that use `delete_container_edit`. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.delete_container_with_http_info(editgroup_id, ident, async=True)
@@ -2060,6 +2080,7 @@ class DefaultApi(object):
def delete_container_edit(self, editgroup_id, edit_id, **kwargs): # noqa: E501
"""delete_container_edit # noqa: E501
+ Removes a single edit from the specified editgroup. The editgroup must be mutable (aka, not accepted/merged), and the editor making this request must have permission (aka, have created the editgroup or hold the `admin` role). Not to be confused with the `delete_container` method, which *creates* a new edit in the given editgroup. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.delete_container_edit(editgroup_id, edit_id, async=True)
@@ -2082,6 +2103,7 @@ class DefaultApi(object):
def delete_container_edit_with_http_info(self, editgroup_id, edit_id, **kwargs): # noqa: E501
"""delete_container_edit # noqa: E501
+ Removes a single edit from the specified editgroup. The editgroup must be mutable (aka, not accepted/merged), and the editor making this request must have permission (aka, have created the editgroup or hold the `admin` role). Not to be confused with the `delete_container` method, which *creates* a new edit in the given editgroup. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.delete_container_edit_with_http_info(editgroup_id, edit_id, async=True)
@@ -2827,6 +2849,7 @@ class DefaultApi(object):
def delete_release(self, editgroup_id, ident, **kwargs): # noqa: E501
"""delete_release # noqa: E501
+ Creates a new \"deletion\" edit for a specific entity as part of an existing editgroup. This is not the method to use to remove an edit from an editgroup; for that use `delete_release_edit`. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.delete_release(editgroup_id, ident, async=True)
@@ -2849,6 +2872,7 @@ class DefaultApi(object):
def delete_release_with_http_info(self, editgroup_id, ident, **kwargs): # noqa: E501
"""delete_release # noqa: E501
+ Creates a new \"deletion\" edit for a specific entity as part of an existing editgroup. This is not the method to use to remove an edit from an editgroup; for that use `delete_release_edit`. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.delete_release_with_http_info(editgroup_id, ident, async=True)
@@ -2932,6 +2956,7 @@ class DefaultApi(object):
def delete_release_edit(self, editgroup_id, edit_id, **kwargs): # noqa: E501
"""delete_release_edit # noqa: E501
+ Removes a single edit from the specified editgroup. The editgroup must be mutable (aka, not accepted/merged), and the editor making this request must have permission (aka, have created the editgroup or hold the `admin` role). Not to be confused with the `delete_container` method, which *creates* a new edit in the given editgroup. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.delete_release_edit(editgroup_id, edit_id, async=True)
@@ -2954,6 +2979,7 @@ class DefaultApi(object):
def delete_release_edit_with_http_info(self, editgroup_id, edit_id, **kwargs): # noqa: E501
"""delete_release_edit # noqa: E501
+ Removes a single edit from the specified editgroup. The editgroup must be mutable (aka, not accepted/merged), and the editor making this request must have permission (aka, have created the editgroup or hold the `admin` role). Not to be confused with the `delete_container` method, which *creates* a new edit in the given editgroup. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.delete_release_edit_with_http_info(editgroup_id, edit_id, async=True)
@@ -3481,13 +3507,14 @@ class DefaultApi(object):
def get_changelog(self, **kwargs): # noqa: E501
"""get_changelog # noqa: E501
+ Returns a list of the most recent changelog entries accepted (merged) into the catalog. List is sorted by changelog index in descending order. Note that the accepted timestamp roughly corresponds to order, but not strictly; there exist out-of-order timestamps on the order of several seconds. As a known database issue, it is technically possible for there to be a gap in changelog index numbers (aka, a missing changelog entry). There are no currently known gaps and this is considered a bug that will be addressed. There are millions of entries; to paginate through all of them, use this method to discover the highest existing entry number, then request the entries using `get_changelog_entry` one at a time. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_changelog(async=True)
>>> result = thread.get()
:param async bool
- :param int limit:
+ :param int limit: Maximum count of changelog entries to return in response
:return: list[ChangelogEntry]
If the method is called asynchronously,
returns the request thread.
@@ -3502,13 +3529,14 @@ class DefaultApi(object):
def get_changelog_with_http_info(self, **kwargs): # noqa: E501
"""get_changelog # noqa: E501
+ Returns a list of the most recent changelog entries accepted (merged) into the catalog. List is sorted by changelog index in descending order. Note that the accepted timestamp roughly corresponds to order, but not strictly; there exist out-of-order timestamps on the order of several seconds. As a known database issue, it is technically possible for there to be a gap in changelog index numbers (aka, a missing changelog entry). There are no currently known gaps and this is considered a bug that will be addressed. There are millions of entries; to paginate through all of them, use this method to discover the highest existing entry number, then request the entries using `get_changelog_entry` one at a time. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_changelog_with_http_info(async=True)
>>> result = thread.get()
:param async bool
- :param int limit:
+ :param int limit: Maximum count of changelog entries to return in response
:return: list[ChangelogEntry]
If the method is called asynchronously,
returns the request thread.
@@ -3574,13 +3602,14 @@ class DefaultApi(object):
def get_changelog_entry(self, index, **kwargs): # noqa: E501
"""get_changelog_entry # noqa: E501
+ Returns a single changelog entry. As a known database issue, it is technically possible for there to be a gap in changelog index numbers (aka, a missing changelog entry). There are no currently known gaps and this is considered a bug that will be addressed. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_changelog_entry(index, async=True)
>>> result = thread.get()
:param async bool
- :param int index: (required)
+ :param int index: Changelog index of entry to return (required)
:return: ChangelogEntry
If the method is called asynchronously,
returns the request thread.
@@ -3595,13 +3624,14 @@ class DefaultApi(object):
def get_changelog_entry_with_http_info(self, index, **kwargs): # noqa: E501
"""get_changelog_entry # noqa: E501
+ Returns a single changelog entry. As a known database issue, it is technically possible for there to be a gap in changelog index numbers (aka, a missing changelog entry). There are no currently known gaps and this is considered a bug that will be addressed. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_changelog_entry_with_http_info(index, async=True)
>>> result = thread.get()
:param async bool
- :param int index: (required)
+ :param int index: Changelog index of entry to return (required)
:return: ChangelogEntry
If the method is called asynchronously,
returns the request thread.
@@ -3671,6 +3701,7 @@ class DefaultApi(object):
def get_container(self, ident, **kwargs): # noqa: E501
"""get_container # noqa: E501
+ Fetches a single container entity from the catalog. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_container(ident, async=True)
@@ -3694,6 +3725,7 @@ class DefaultApi(object):
def get_container_with_http_info(self, ident, **kwargs): # noqa: E501
"""get_container # noqa: E501
+ Fetches a single container entity from the catalog. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_container_with_http_info(ident, async=True)
@@ -3776,6 +3808,7 @@ class DefaultApi(object):
def get_container_edit(self, edit_id, **kwargs): # noqa: E501
"""get_container_edit # noqa: E501
+ Returns the entity edit object with the given identifier. This method is expected to be used rarely. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_container_edit(edit_id, async=True)
@@ -3797,6 +3830,7 @@ class DefaultApi(object):
def get_container_edit_with_http_info(self, edit_id, **kwargs): # noqa: E501
"""get_container_edit # noqa: E501
+ Returns the entity edit object with the given identifier. This method is expected to be used rarely. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_container_edit_with_http_info(edit_id, async=True)
@@ -3881,6 +3915,7 @@ class DefaultApi(object):
def get_container_history(self, ident, **kwargs): # noqa: E501
"""get_container_history # noqa: E501
+ Fetches the history of accepted edits (changelog entries) for a specific entity fatcat identifier. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_container_history(ident, async=True)
@@ -3888,7 +3923,7 @@ class DefaultApi(object):
:param async bool
:param str ident: (required)
- :param int limit:
+ :param int limit: Maximum number of changelog entries to return
:return: list[EntityHistoryEntry]
If the method is called asynchronously,
returns the request thread.
@@ -3903,6 +3938,7 @@ class DefaultApi(object):
def get_container_history_with_http_info(self, ident, **kwargs): # noqa: E501
"""get_container_history # noqa: E501
+ Fetches the history of accepted edits (changelog entries) for a specific entity fatcat identifier. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_container_history_with_http_info(ident, async=True)
@@ -3910,7 +3946,7 @@ class DefaultApi(object):
:param async bool
:param str ident: (required)
- :param int limit:
+ :param int limit: Maximum number of changelog entries to return
:return: list[EntityHistoryEntry]
If the method is called asynchronously,
returns the request thread.
@@ -3982,6 +4018,7 @@ class DefaultApi(object):
def get_container_redirects(self, ident, **kwargs): # noqa: E501
"""get_container_redirects # noqa: E501
+ Returns the set of entity identifiers which currently redirect to this identifier. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_container_redirects(ident, async=True)
@@ -4003,6 +4040,7 @@ class DefaultApi(object):
def get_container_redirects_with_http_info(self, ident, **kwargs): # noqa: E501
"""get_container_redirects # noqa: E501
+ Returns the set of entity identifiers which currently redirect to this identifier. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_container_redirects_with_http_info(ident, async=True)
@@ -4079,6 +4117,7 @@ class DefaultApi(object):
def get_container_revision(self, rev_id, **kwargs): # noqa: E501
"""get_container_revision # noqa: E501
+ Fetches a specific entity revision. Note that the returned revision will not be associated with any particular fatcat identifier (even if one or more identifiers do currently point to this revision). The revision may even be part of an un-merged editgroup. Revisions are immutable and can not be deleted or updated. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_container_revision(rev_id, async=True)
@@ -4086,8 +4125,8 @@ class DefaultApi(object):
:param async bool
:param str rev_id: UUID (lower-case, dash-separated, hex-encoded 128-bit) (required)
- :param str expand: List of sub-entities to expand in response. For containers, none accepted (yet).
- :param str hide: List of entity fields to elide in response. For containers, none accepted (yet).
+ :param str expand: List of sub-entities to expand in response. See `get_container`.
+ :param str hide: List of entity fields to elide in response. See `get_container`.
:return: ContainerEntity
If the method is called asynchronously,
returns the request thread.
@@ -4102,6 +4141,7 @@ class DefaultApi(object):
def get_container_revision_with_http_info(self, rev_id, **kwargs): # noqa: E501
"""get_container_revision # noqa: E501
+ Fetches a specific entity revision. Note that the returned revision will not be associated with any particular fatcat identifier (even if one or more identifiers do currently point to this revision). The revision may even be part of an un-merged editgroup. Revisions are immutable and can not be deleted or updated. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_container_revision_with_http_info(rev_id, async=True)
@@ -4109,8 +4149,8 @@ class DefaultApi(object):
:param async bool
:param str rev_id: UUID (lower-case, dash-separated, hex-encoded 128-bit) (required)
- :param str expand: List of sub-entities to expand in response. For containers, none accepted (yet).
- :param str hide: List of entity fields to elide in response. For containers, none accepted (yet).
+ :param str expand: List of sub-entities to expand in response. See `get_container`.
+ :param str hide: List of entity fields to elide in response. See `get_container`.
:return: ContainerEntity
If the method is called asynchronously,
returns the request thread.
@@ -4200,7 +4240,7 @@ class DefaultApi(object):
:param async bool
:param str ident: (required)
:param str expand: List of sub-entities to expand in response. For creators, none accepted (yet).
- :param str hide: List of entity fields to elide in response. For containers, none accepted (yet).
+ :param str hide: List of entity fields to elide in response. For creators, none accepted (yet).
:return: CreatorEntity
If the method is called asynchronously,
returns the request thread.
@@ -4223,7 +4263,7 @@ class DefaultApi(object):
:param async bool
:param str ident: (required)
:param str expand: List of sub-entities to expand in response. For creators, none accepted (yet).
- :param str hide: List of entity fields to elide in response. For containers, none accepted (yet).
+ :param str hide: List of entity fields to elide in response. For creators, none accepted (yet).
:return: CreatorEntity
If the method is called asynchronously,
returns the request thread.
@@ -4600,6 +4640,7 @@ class DefaultApi(object):
def get_creator_releases(self, ident, **kwargs): # noqa: E501
"""get_creator_releases # noqa: E501
+ Returns the set of Release entities having a `contrib` entry pointing to the creator entity. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_creator_releases(ident, async=True)
@@ -4607,7 +4648,7 @@ class DefaultApi(object):
:param async bool
:param str ident: (required)
- :param str hide: List of entity fields to elide in response. For creators, none implemented yet.
+ :param str hide: List of entity fields to elide in response. See `get_release`.
:return: list[ReleaseEntity]
If the method is called asynchronously,
returns the request thread.
@@ -4622,6 +4663,7 @@ class DefaultApi(object):
def get_creator_releases_with_http_info(self, ident, **kwargs): # noqa: E501
"""get_creator_releases # noqa: E501
+ Returns the set of Release entities having a `contrib` entry pointing to the creator entity. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_creator_releases_with_http_info(ident, async=True)
@@ -4629,7 +4671,7 @@ class DefaultApi(object):
:param async bool
:param str ident: (required)
- :param str hide: List of entity fields to elide in response. For creators, none implemented yet.
+ :param str hide: List of entity fields to elide in response. See `get_release`.
:return: list[ReleaseEntity]
If the method is called asynchronously,
returns the request thread.
@@ -4708,8 +4750,8 @@ class DefaultApi(object):
:param async bool
:param str rev_id: UUID (lower-case, dash-separated, hex-encoded 128-bit) (required)
- :param str expand: List of sub-entities to expand in response. For creators, none accepted (yet).
- :param str hide: List of entity fields to elide in response. For creators, none accepted (yet).
+ :param str expand: List of sub-entities to expand in response. See `get_creator`, though note that identifier-based expansions (like `releases`) will always be empty for revisions.
+ :param str hide: List of entity fields to elide in response. See `get_creator`.
:return: CreatorEntity
If the method is called asynchronously,
returns the request thread.
@@ -4731,8 +4773,8 @@ class DefaultApi(object):
:param async bool
:param str rev_id: UUID (lower-case, dash-separated, hex-encoded 128-bit) (required)
- :param str expand: List of sub-entities to expand in response. For creators, none accepted (yet).
- :param str hide: List of entity fields to elide in response. For creators, none accepted (yet).
+ :param str expand: List of sub-entities to expand in response. See `get_creator`, though note that identifier-based expansions (like `releases`) will always be empty for revisions.
+ :param str hide: List of entity fields to elide in response. See `get_creator`.
:return: CreatorEntity
If the method is called asynchronously,
returns the request thread.
@@ -4814,6 +4856,7 @@ class DefaultApi(object):
def get_editgroup(self, editgroup_id, **kwargs): # noqa: E501
"""get_editgroup # noqa: E501
+ Returns a single editgroup object. Unlike some similar methods, this method will return a full/expanded editgroup object, which includes edit lists of each entity type (though will not include the complete entity objects). # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_editgroup(editgroup_id, async=True)
@@ -4835,6 +4878,7 @@ class DefaultApi(object):
def get_editgroup_with_http_info(self, editgroup_id, **kwargs): # noqa: E501
"""get_editgroup # noqa: E501
+ Returns a single editgroup object. Unlike some similar methods, this method will return a full/expanded editgroup object, which includes edit lists of each entity type (though will not include the complete entity objects). # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_editgroup_with_http_info(editgroup_id, async=True)
@@ -4919,6 +4963,7 @@ class DefaultApi(object):
def get_editgroup_annotations(self, editgroup_id, **kwargs): # noqa: E501
"""get_editgroup_annotations # noqa: E501
+ Returns a list of annotations made to a specific editgroup. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_editgroup_annotations(editgroup_id, async=True)
@@ -4926,7 +4971,7 @@ class DefaultApi(object):
:param async bool
:param str editgroup_id: base32-encoded unique identifier (required)
- :param str expand: List of sub-entities to expand in response. For editgroups: 'editors'
+ :param str expand: List of sub-entities to expand in response. For editgroup annotations: 'editors'
:return: list[EditgroupAnnotation]
If the method is called asynchronously,
returns the request thread.
@@ -4941,6 +4986,7 @@ class DefaultApi(object):
def get_editgroup_annotations_with_http_info(self, editgroup_id, **kwargs): # noqa: E501
"""get_editgroup_annotations # noqa: E501
+ Returns a list of annotations made to a specific editgroup. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_editgroup_annotations_with_http_info(editgroup_id, async=True)
@@ -4948,7 +4994,7 @@ class DefaultApi(object):
:param async bool
:param str editgroup_id: base32-encoded unique identifier (required)
- :param str expand: List of sub-entities to expand in response. For editgroups: 'editors'
+ :param str expand: List of sub-entities to expand in response. For editgroup annotations: 'editors'
:return: list[EditgroupAnnotation]
If the method is called asynchronously,
returns the request thread.
@@ -5028,6 +5074,7 @@ class DefaultApi(object):
def get_editgroups_reviewable(self, **kwargs): # noqa: E501
"""get_editgroups_reviewable # noqa: E501
+ Returns a set of editgroups which have been submitted but not yet accepted. Query parameters can be used to sort and paginate the list returned. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_editgroups_reviewable(async=True)
@@ -5035,9 +5082,9 @@ class DefaultApi(object):
:param async bool
:param str expand: List of sub-entities to expand in response. For editgroups: 'editors'
- :param int limit:
- :param datetime before:
- :param datetime since:
+ :param int limit: Maximum number of reviewable editgroups to return in response
+ :param datetime before: Return only reviewable editgroups submitted *before* the given timestamp (not inclusive). Editgroups will be sorted by submission time in descending order (most recent first). For use in pagination.
+ :param datetime since: Return only reviewable editgroups submitted *after* the given timestamp (not inclusive). Editgroups will be sorted by submission time in ascending order (most recent last). For use in pagination.
:return: list[Editgroup]
If the method is called asynchronously,
returns the request thread.
@@ -5052,6 +5099,7 @@ class DefaultApi(object):
def get_editgroups_reviewable_with_http_info(self, **kwargs): # noqa: E501
"""get_editgroups_reviewable # noqa: E501
+ Returns a set of editgroups which have been submitted but not yet accepted. Query parameters can be used to sort and paginate the list returned. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_editgroups_reviewable_with_http_info(async=True)
@@ -5059,9 +5107,9 @@ class DefaultApi(object):
:param async bool
:param str expand: List of sub-entities to expand in response. For editgroups: 'editors'
- :param int limit:
- :param datetime before:
- :param datetime since:
+ :param int limit: Maximum number of reviewable editgroups to return in response
+ :param datetime before: Return only reviewable editgroups submitted *before* the given timestamp (not inclusive). Editgroups will be sorted by submission time in descending order (most recent first). For use in pagination.
+ :param datetime since: Return only reviewable editgroups submitted *after* the given timestamp (not inclusive). Editgroups will be sorted by submission time in ascending order (most recent last). For use in pagination.
:return: list[Editgroup]
If the method is called asynchronously,
returns the request thread.
@@ -5133,6 +5181,7 @@ class DefaultApi(object):
def get_editor(self, editor_id, **kwargs): # noqa: E501
"""get_editor # noqa: E501
+ Returns an editor object, including metadata such as the username, type, and role of editor. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_editor(editor_id, async=True)
@@ -5154,6 +5203,7 @@ class DefaultApi(object):
def get_editor_with_http_info(self, editor_id, **kwargs): # noqa: E501
"""get_editor # noqa: E501
+ Returns an editor object, including metadata such as the username, type, and role of editor. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_editor_with_http_info(editor_id, async=True)
@@ -5230,6 +5280,7 @@ class DefaultApi(object):
def get_editor_annotations(self, editor_id, **kwargs): # noqa: E501
"""get_editor_annotations # noqa: E501
+ Fetches a list of annotations made by a particular editor. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_editor_annotations(editor_id, async=True)
@@ -5237,9 +5288,9 @@ class DefaultApi(object):
:param async bool
:param str editor_id: base32-encoded unique identifier (required)
- :param int limit:
- :param datetime before:
- :param datetime since:
+ :param int limit: Maximum number (count) of annotations to return in response
+ :param datetime before: Return only annotations made *before* the given timestamp (not inclusive). Annotations will be sorted by creation time in descending order (most recent first). For use in pagination.
+ :param datetime since: Return only annotations made *after* the given timestamp (not inclusive). Annotations will be sorted by creation time in ascending order (most recent last). For use in pagination.
:return: list[EditgroupAnnotation]
If the method is called asynchronously,
returns the request thread.
@@ -5254,6 +5305,7 @@ class DefaultApi(object):
def get_editor_annotations_with_http_info(self, editor_id, **kwargs): # noqa: E501
"""get_editor_annotations # noqa: E501
+ Fetches a list of annotations made by a particular editor. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_editor_annotations_with_http_info(editor_id, async=True)
@@ -5261,9 +5313,9 @@ class DefaultApi(object):
:param async bool
:param str editor_id: base32-encoded unique identifier (required)
- :param int limit:
- :param datetime before:
- :param datetime since:
+ :param int limit: Maximum number (count) of annotations to return in response
+ :param datetime before: Return only annotations made *before* the given timestamp (not inclusive). Annotations will be sorted by creation time in descending order (most recent first). For use in pagination.
+ :param datetime since: Return only annotations made *after* the given timestamp (not inclusive). Annotations will be sorted by creation time in ascending order (most recent last). For use in pagination.
:return: list[EditgroupAnnotation]
If the method is called asynchronously,
returns the request thread.
@@ -5347,6 +5399,7 @@ class DefaultApi(object):
def get_editor_editgroups(self, editor_id, **kwargs): # noqa: E501
"""get_editor_editgroups # noqa: E501
+ Returns a set of editgroups created by the given editor, regardless of the status (accepted/submitted) of the editgroups. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_editor_editgroups(editor_id, async=True)
@@ -5355,8 +5408,8 @@ class DefaultApi(object):
:param async bool
:param str editor_id: (required)
:param int limit:
- :param datetime before:
- :param datetime since:
+ :param datetime before: Return only editgroups created *before* the given timestamp (not inclusive). Editgroups will be sorted by creation time in descending order (most recent first). For use in pagination.
+ :param datetime since: Return only editgroups created *after* the given timestamp (not inclusive). Editgroups will be sorted by creation time in ascending order (most recent last). For use in pagination.
:return: list[Editgroup]
If the method is called asynchronously,
returns the request thread.
@@ -5371,6 +5424,7 @@ class DefaultApi(object):
def get_editor_editgroups_with_http_info(self, editor_id, **kwargs): # noqa: E501
"""get_editor_editgroups # noqa: E501
+ Returns a set of editgroups created by the given editor, regardless of the status (accepted/submitted) of the editgroups. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_editor_editgroups_with_http_info(editor_id, async=True)
@@ -5379,8 +5433,8 @@ class DefaultApi(object):
:param async bool
:param str editor_id: (required)
:param int limit:
- :param datetime before:
- :param datetime since:
+ :param datetime before: Return only editgroups created *before* the given timestamp (not inclusive). Editgroups will be sorted by creation time in descending order (most recent first). For use in pagination.
+ :param datetime since: Return only editgroups created *after* the given timestamp (not inclusive). Editgroups will be sorted by creation time in ascending order (most recent last). For use in pagination.
:return: list[Editgroup]
If the method is called asynchronously,
returns the request thread.
@@ -5871,8 +5925,8 @@ class DefaultApi(object):
:param async bool
:param str rev_id: UUID (lower-case, dash-separated, hex-encoded 128-bit) (required)
- :param str expand: List of sub-entities to expand in response. For files, none accepted (yet).
- :param str hide: List of entity fields to elide in response. For files, none accepted (yet).
+ :param str expand: List of sub-entities to expand in response. See `get_file`.
+ :param str hide: List of entity fields to elide in response. See `get_file`.
:return: FileEntity
If the method is called asynchronously,
returns the request thread.
@@ -5894,8 +5948,8 @@ class DefaultApi(object):
:param async bool
:param str rev_id: UUID (lower-case, dash-separated, hex-encoded 128-bit) (required)
- :param str expand: List of sub-entities to expand in response. For files, none accepted (yet).
- :param str hide: List of entity fields to elide in response. For files, none accepted (yet).
+ :param str expand: List of sub-entities to expand in response. See `get_file`.
+ :param str hide: List of entity fields to elide in response. See `get_file`.
:return: FileEntity
If the method is called asynchronously,
returns the request thread.
@@ -6392,8 +6446,8 @@ class DefaultApi(object):
:param async bool
:param str rev_id: UUID (lower-case, dash-separated, hex-encoded 128-bit) (required)
- :param str expand: List of sub-entities to expand in response. For filesets, none accepted (yet).
- :param str hide: List of entity fields to elide in response. For filesets, 'manifest' is accepted.
+ :param str expand: List of sub-entities to expand in response. See `get_fileset`.
+ :param str hide: List of entity fields to elide in response. See `get_fileset`.
:return: FilesetEntity
If the method is called asynchronously,
returns the request thread.
@@ -6415,8 +6469,8 @@ class DefaultApi(object):
:param async bool
:param str rev_id: UUID (lower-case, dash-separated, hex-encoded 128-bit) (required)
- :param str expand: List of sub-entities to expand in response. For filesets, none accepted (yet).
- :param str hide: List of entity fields to elide in response. For filesets, 'manifest' is accepted.
+ :param str expand: List of sub-entities to expand in response. See `get_fileset`.
+ :param str hide: List of entity fields to elide in response. See `get_fileset`.
:return: FilesetEntity
If the method is called asynchronously,
returns the request thread.
@@ -6498,6 +6552,7 @@ class DefaultApi(object):
def get_release(self, ident, **kwargs): # noqa: E501
"""get_release # noqa: E501
+ Fetches a single Release entity from the catalog. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_release(ident, async=True)
@@ -6505,8 +6560,8 @@ class DefaultApi(object):
:param async bool
:param str ident: (required)
- :param str expand: List of sub-entities to expand in response. For releases, 'files', 'filesets, 'webcaptures', 'container', and 'creators' are valid.
- :param str hide: List of entity fields to elide in response. For releases, 'abstracts', 'refs', and 'contribs' are valid.
+ :param str expand: List of sub-entities to expand in response. For releases, 'files', 'filesets, 'webcaptures', 'container', and 'creators' are valid.
+ :param str hide: List of entity fields to elide in response (for efficiency). For releases, 'abstracts', 'refs', and 'contribs' are valid.
:return: ReleaseEntity
If the method is called asynchronously,
returns the request thread.
@@ -6521,6 +6576,7 @@ class DefaultApi(object):
def get_release_with_http_info(self, ident, **kwargs): # noqa: E501
"""get_release # noqa: E501
+ Fetches a single Release entity from the catalog. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_release_with_http_info(ident, async=True)
@@ -6528,8 +6584,8 @@ class DefaultApi(object):
:param async bool
:param str ident: (required)
- :param str expand: List of sub-entities to expand in response. For releases, 'files', 'filesets, 'webcaptures', 'container', and 'creators' are valid.
- :param str hide: List of entity fields to elide in response. For releases, 'abstracts', 'refs', and 'contribs' are valid.
+ :param str expand: List of sub-entities to expand in response. For releases, 'files', 'filesets, 'webcaptures', 'container', and 'creators' are valid.
+ :param str hide: List of entity fields to elide in response (for efficiency). For releases, 'abstracts', 'refs', and 'contribs' are valid.
:return: ReleaseEntity
If the method is called asynchronously,
returns the request thread.
@@ -6603,6 +6659,7 @@ class DefaultApi(object):
def get_release_edit(self, edit_id, **kwargs): # noqa: E501
"""get_release_edit # noqa: E501
+ Returns the entity edit object with the given identifier. This method is expected to be used rarely. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_release_edit(edit_id, async=True)
@@ -6624,6 +6681,7 @@ class DefaultApi(object):
def get_release_edit_with_http_info(self, edit_id, **kwargs): # noqa: E501
"""get_release_edit # noqa: E501
+ Returns the entity edit object with the given identifier. This method is expected to be used rarely. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_release_edit_with_http_info(edit_id, async=True)
@@ -6708,6 +6766,7 @@ class DefaultApi(object):
def get_release_files(self, ident, **kwargs): # noqa: E501
"""get_release_files # noqa: E501
+ Returns the set of File entities that have a `release_id` pointing to this release entity. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_release_files(ident, async=True)
@@ -6715,7 +6774,7 @@ class DefaultApi(object):
:param async bool
:param str ident: (required)
- :param str hide: List of entity fields to elide in response. For files, none accepted (yet).
+ :param str hide: List of entity fields to elide in response. See `get_file`.
:return: list[FileEntity]
If the method is called asynchronously,
returns the request thread.
@@ -6730,6 +6789,7 @@ class DefaultApi(object):
def get_release_files_with_http_info(self, ident, **kwargs): # noqa: E501
"""get_release_files # noqa: E501
+ Returns the set of File entities that have a `release_id` pointing to this release entity. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_release_files_with_http_info(ident, async=True)
@@ -6737,7 +6797,7 @@ class DefaultApi(object):
:param async bool
:param str ident: (required)
- :param str hide: List of entity fields to elide in response. For files, none accepted (yet).
+ :param str hide: List of entity fields to elide in response. See `get_file`.
:return: list[FileEntity]
If the method is called asynchronously,
returns the request thread.
@@ -6809,6 +6869,7 @@ class DefaultApi(object):
def get_release_filesets(self, ident, **kwargs): # noqa: E501
"""get_release_filesets # noqa: E501
+ Returns the set of Fileset entities that have a `release_id` pointing to this release entity. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_release_filesets(ident, async=True)
@@ -6816,7 +6877,7 @@ class DefaultApi(object):
:param async bool
:param str ident: (required)
- :param str hide: List of entity fields to elide in response. For filesets, 'manifest' is valid.
+ :param str hide: List of entity fields to elide in response. See `get_fileset`.
:return: list[FilesetEntity]
If the method is called asynchronously,
returns the request thread.
@@ -6831,6 +6892,7 @@ class DefaultApi(object):
def get_release_filesets_with_http_info(self, ident, **kwargs): # noqa: E501
"""get_release_filesets # noqa: E501
+ Returns the set of Fileset entities that have a `release_id` pointing to this release entity. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_release_filesets_with_http_info(ident, async=True)
@@ -6838,7 +6900,7 @@ class DefaultApi(object):
:param async bool
:param str ident: (required)
- :param str hide: List of entity fields to elide in response. For filesets, 'manifest' is valid.
+ :param str hide: List of entity fields to elide in response. See `get_fileset`.
:return: list[FilesetEntity]
If the method is called asynchronously,
returns the request thread.
@@ -6910,6 +6972,7 @@ class DefaultApi(object):
def get_release_history(self, ident, **kwargs): # noqa: E501
"""get_release_history # noqa: E501
+ Fetches the history of accepted edits (changelog entries) for a specific entity fatcat identifier. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_release_history(ident, async=True)
@@ -6932,6 +6995,7 @@ class DefaultApi(object):
def get_release_history_with_http_info(self, ident, **kwargs): # noqa: E501
"""get_release_history # noqa: E501
+ Fetches the history of accepted edits (changelog entries) for a specific entity fatcat identifier. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_release_history_with_http_info(ident, async=True)
@@ -7011,6 +7075,7 @@ class DefaultApi(object):
def get_release_redirects(self, ident, **kwargs): # noqa: E501
"""get_release_redirects # noqa: E501
+ Returns the set of entity identifiers which currently redirect to this identifier. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_release_redirects(ident, async=True)
@@ -7032,6 +7097,7 @@ class DefaultApi(object):
def get_release_redirects_with_http_info(self, ident, **kwargs): # noqa: E501
"""get_release_redirects # noqa: E501
+ Returns the set of entity identifiers which currently redirect to this identifier. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_release_redirects_with_http_info(ident, async=True)
@@ -7108,6 +7174,7 @@ class DefaultApi(object):
def get_release_revision(self, rev_id, **kwargs): # noqa: E501
"""get_release_revision # noqa: E501
+ Fetches a specific entity revision. Note that the returned revision will not be associated with any particular fatcat identifier (even if one or more identifiers do currently point to this revision). The revision may even be part of an un-merged editgroup. Revisions are immutable and can not be deleted or updated. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_release_revision(rev_id, async=True)
@@ -7115,8 +7182,8 @@ class DefaultApi(object):
:param async bool
:param str rev_id: UUID (lower-case, dash-separated, hex-encoded 128-bit) (required)
- :param str expand: List of sub-entities to expand in response. For releases, none accepted (yet).
- :param str hide: List of entity fields to elide in response. For releases, none accepted (yet).
+ :param str expand: List of sub-entities to expand in response. See `get_release`, though note that identifier-based exapansions like `file` will always be empty for revisions.
+ :param str hide: List of entity fields to elide in response. See `get_release`.
:return: ReleaseEntity
If the method is called asynchronously,
returns the request thread.
@@ -7131,6 +7198,7 @@ class DefaultApi(object):
def get_release_revision_with_http_info(self, rev_id, **kwargs): # noqa: E501
"""get_release_revision # noqa: E501
+ Fetches a specific entity revision. Note that the returned revision will not be associated with any particular fatcat identifier (even if one or more identifiers do currently point to this revision). The revision may even be part of an un-merged editgroup. Revisions are immutable and can not be deleted or updated. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_release_revision_with_http_info(rev_id, async=True)
@@ -7138,8 +7206,8 @@ class DefaultApi(object):
:param async bool
:param str rev_id: UUID (lower-case, dash-separated, hex-encoded 128-bit) (required)
- :param str expand: List of sub-entities to expand in response. For releases, none accepted (yet).
- :param str hide: List of entity fields to elide in response. For releases, none accepted (yet).
+ :param str expand: List of sub-entities to expand in response. See `get_release`, though note that identifier-based exapansions like `file` will always be empty for revisions.
+ :param str hide: List of entity fields to elide in response. See `get_release`.
:return: ReleaseEntity
If the method is called asynchronously,
returns the request thread.
@@ -7221,6 +7289,7 @@ class DefaultApi(object):
def get_release_webcaptures(self, ident, **kwargs): # noqa: E501
"""get_release_webcaptures # noqa: E501
+ Returns the set of Web Capture entities that have a `release_id` pointing to this release entity. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_release_webcaptures(ident, async=True)
@@ -7228,7 +7297,7 @@ class DefaultApi(object):
:param async bool
:param str ident: (required)
- :param str hide: List of entity fields to elide in response. For webcaptures, 'cdx' is valid.
+ :param str hide: List of entity fields to elide in response. See `get_webcapture`.
:return: list[WebcaptureEntity]
If the method is called asynchronously,
returns the request thread.
@@ -7243,6 +7312,7 @@ class DefaultApi(object):
def get_release_webcaptures_with_http_info(self, ident, **kwargs): # noqa: E501
"""get_release_webcaptures # noqa: E501
+ Returns the set of Web Capture entities that have a `release_id` pointing to this release entity. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_release_webcaptures_with_http_info(ident, async=True)
@@ -7250,7 +7320,7 @@ class DefaultApi(object):
:param async bool
:param str ident: (required)
- :param str hide: List of entity fields to elide in response. For webcaptures, 'cdx' is valid.
+ :param str hide: List of entity fields to elide in response. See `get_webcapture`.
:return: list[WebcaptureEntity]
If the method is called asynchronously,
returns the request thread.
@@ -7737,8 +7807,8 @@ class DefaultApi(object):
:param async bool
:param str rev_id: UUID (lower-case, dash-separated, hex-encoded 128-bit) (required)
- :param str expand: List of sub-entities to expand in response. For webcaptures, none accepted (yet).
- :param str hide: List of entity fields to elide in response. For webcaptures, 'cdx' is accepted.
+ :param str expand: List of sub-entities to expand in response. See `get_webcapture`.
+ :param str hide: List of entity fields to elide in response. See `get_webcapture`.
:return: WebcaptureEntity
If the method is called asynchronously,
returns the request thread.
@@ -7760,8 +7830,8 @@ class DefaultApi(object):
:param async bool
:param str rev_id: UUID (lower-case, dash-separated, hex-encoded 128-bit) (required)
- :param str expand: List of sub-entities to expand in response. For webcaptures, none accepted (yet).
- :param str hide: List of entity fields to elide in response. For webcaptures, 'cdx' is accepted.
+ :param str expand: List of sub-entities to expand in response. See `get_webcapture`.
+ :param str hide: List of entity fields to elide in response. See `get_webcapture`.
:return: WebcaptureEntity
If the method is called asynchronously,
returns the request thread.
@@ -8251,6 +8321,7 @@ class DefaultApi(object):
def get_work_releases(self, ident, **kwargs): # noqa: E501
"""get_work_releases # noqa: E501
+ Returns the set of release entities that are part of this work (aka, have `work_id` pointing to this work entity). # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_work_releases(ident, async=True)
@@ -8258,7 +8329,7 @@ class DefaultApi(object):
:param async bool
:param str ident: (required)
- :param str hide: List of entity fields to elide in response. For works, none implemented yet.
+ :param str hide: List of entity fields to elide in response. See `get_release`.
:return: list[ReleaseEntity]
If the method is called asynchronously,
returns the request thread.
@@ -8273,6 +8344,7 @@ class DefaultApi(object):
def get_work_releases_with_http_info(self, ident, **kwargs): # noqa: E501
"""get_work_releases # noqa: E501
+ Returns the set of release entities that are part of this work (aka, have `work_id` pointing to this work entity). # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_work_releases_with_http_info(ident, async=True)
@@ -8280,7 +8352,7 @@ class DefaultApi(object):
:param async bool
:param str ident: (required)
- :param str hide: List of entity fields to elide in response. For works, none implemented yet.
+ :param str hide: List of entity fields to elide in response. See `get_release`.
:return: list[ReleaseEntity]
If the method is called asynchronously,
returns the request thread.
@@ -8359,8 +8431,8 @@ class DefaultApi(object):
:param async bool
:param str rev_id: UUID (lower-case, dash-separated, hex-encoded 128-bit) (required)
- :param str expand: List of sub-entities to expand in response. For works, none accepted (yet).
- :param str hide: List of entity fields to elide in response. For works, none accepted (yet).
+ :param str expand: List of sub-entities to expand in response. See `get_work`, though note that identifier-based expansions like `releases` will always be empty for revisions.
+ :param str hide: List of entity fields to elide in response. See `get_work`.
:return: WorkEntity
If the method is called asynchronously,
returns the request thread.
@@ -8382,8 +8454,8 @@ class DefaultApi(object):
:param async bool
:param str rev_id: UUID (lower-case, dash-separated, hex-encoded 128-bit) (required)
- :param str expand: List of sub-entities to expand in response. For works, none accepted (yet).
- :param str hide: List of entity fields to elide in response. For works, none accepted (yet).
+ :param str expand: List of sub-entities to expand in response. See `get_work`, though note that identifier-based expansions like `releases` will always be empty for revisions.
+ :param str hide: List of entity fields to elide in response. See `get_work`.
:return: WorkEntity
If the method is called asynchronously,
returns the request thread.
@@ -8465,6 +8537,7 @@ class DefaultApi(object):
def lookup_container(self, **kwargs): # noqa: E501
"""lookup_container # noqa: E501
+ Looks for an active entity with the given external identifier. If any such entity is found, returns a single complete entity. If multiple entities have the same external identifier, this is considered a soft catalog error, and the behavior of which entity is returned is undefined. One (and only one) external identifier should be specified per request. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.lookup_container(async=True)
@@ -8473,8 +8546,8 @@ class DefaultApi(object):
:param async bool
:param str issnl:
:param str wikidata_qid:
- :param str expand: List of sub-entities to expand in response.
- :param str hide: List of entity fields to elide in response. For container, none accepted (yet).
+ :param str expand: List of sub-entities to expand in response. See `get_container`.
+ :param str hide: List of entity fields to elide in response. See `get_container`.
:return: ContainerEntity
If the method is called asynchronously,
returns the request thread.
@@ -8489,6 +8562,7 @@ class DefaultApi(object):
def lookup_container_with_http_info(self, **kwargs): # noqa: E501
"""lookup_container # noqa: E501
+ Looks for an active entity with the given external identifier. If any such entity is found, returns a single complete entity. If multiple entities have the same external identifier, this is considered a soft catalog error, and the behavior of which entity is returned is undefined. One (and only one) external identifier should be specified per request. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.lookup_container_with_http_info(async=True)
@@ -8497,8 +8571,8 @@ class DefaultApi(object):
:param async bool
:param str issnl:
:param str wikidata_qid:
- :param str expand: List of sub-entities to expand in response.
- :param str hide: List of entity fields to elide in response. For container, none accepted (yet).
+ :param str expand: List of sub-entities to expand in response. See `get_container`.
+ :param str hide: List of entity fields to elide in response. See `get_container`.
:return: ContainerEntity
If the method is called asynchronously,
returns the request thread.
@@ -8584,10 +8658,10 @@ class DefaultApi(object):
>>> result = thread.get()
:param async bool
- :param str orcid:
+ :param str orcid: ORCiD (https://orcid.org) identifier
:param str wikidata_qid:
- :param str expand: List of sub-entities to expand in response.
- :param str hide: List of entity fields to elide in response. For creator, none accepted (yet).
+ :param str expand: List of sub-entities to expand in response. See `get_creator`.
+ :param str hide: List of entity fields to elide in response. See `get_creator`.
:return: CreatorEntity
If the method is called asynchronously,
returns the request thread.
@@ -8608,10 +8682,10 @@ class DefaultApi(object):
>>> result = thread.get()
:param async bool
- :param str orcid:
+ :param str orcid: ORCiD (https://orcid.org) identifier
:param str wikidata_qid:
- :param str expand: List of sub-entities to expand in response.
- :param str hide: List of entity fields to elide in response. For creator, none accepted (yet).
+ :param str expand: List of sub-entities to expand in response. See `get_creator`.
+ :param str hide: List of entity fields to elide in response. See `get_creator`.
:return: CreatorEntity
If the method is called asynchronously,
returns the request thread.
@@ -8697,11 +8771,11 @@ class DefaultApi(object):
>>> result = thread.get()
:param async bool
- :param str md5:
- :param str sha1:
- :param str sha256:
- :param str expand: List of sub-entities to expand in response.
- :param str hide: List of entity fields to elide in response. For files, none accepted (yet).
+ :param str md5: MD5 hash of data, in hex encoding
+ :param str sha1: SHA-1 hash of data, in hex encoding
+ :param str sha256: SHA-256 hash of data, in hex encoding
+ :param str expand: List of sub-entities to expand in response. See `get_file`.
+ :param str hide: List of entity fields to elide in response. See `get_file`.
:return: FileEntity
If the method is called asynchronously,
returns the request thread.
@@ -8722,11 +8796,11 @@ class DefaultApi(object):
>>> result = thread.get()
:param async bool
- :param str md5:
- :param str sha1:
- :param str sha256:
- :param str expand: List of sub-entities to expand in response.
- :param str hide: List of entity fields to elide in response. For files, none accepted (yet).
+ :param str md5: MD5 hash of data, in hex encoding
+ :param str sha1: SHA-1 hash of data, in hex encoding
+ :param str sha256: SHA-256 hash of data, in hex encoding
+ :param str expand: List of sub-entities to expand in response. See `get_file`.
+ :param str hide: List of entity fields to elide in response. See `get_file`.
:return: FileEntity
If the method is called asynchronously,
returns the request thread.
@@ -8824,6 +8898,7 @@ class DefaultApi(object):
def lookup_release(self, **kwargs): # noqa: E501
"""lookup_release # noqa: E501
+ Looks for an active entity with the given external identifier. If any such entity is found, returns a single complete entity. If multiple entities have the same external identifier, this is considered a soft catalog error, and the behavior of which entity is returned is undefined. One (and only one) external identifier should be specified per request. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.lookup_release(async=True)
@@ -8840,8 +8915,8 @@ class DefaultApi(object):
:param str jstor:
:param str ark:
:param str mag:
- :param str expand: List of sub-entities to expand in response.
- :param str hide: List of sub-entities to expand in response. For releases, 'files', 'filesets, 'webcaptures', 'container', and 'creators' are valid.
+ :param str expand: List of sub-entities to expand in response. See `get_release`.
+ :param str hide: List of sub-entities to elide in response. See `get_release`.
:return: ReleaseEntity
If the method is called asynchronously,
returns the request thread.
@@ -8856,6 +8931,7 @@ class DefaultApi(object):
def lookup_release_with_http_info(self, **kwargs): # noqa: E501
"""lookup_release # noqa: E501
+ Looks for an active entity with the given external identifier. If any such entity is found, returns a single complete entity. If multiple entities have the same external identifier, this is considered a soft catalog error, and the behavior of which entity is returned is undefined. One (and only one) external identifier should be specified per request. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.lookup_release_with_http_info(async=True)
@@ -8872,8 +8948,8 @@ class DefaultApi(object):
:param str jstor:
:param str ark:
:param str mag:
- :param str expand: List of sub-entities to expand in response.
- :param str hide: List of sub-entities to expand in response. For releases, 'files', 'filesets, 'webcaptures', 'container', and 'creators' are valid.
+ :param str expand: List of sub-entities to expand in response. See `get_release`.
+ :param str hide: List of sub-entities to elide in response. See `get_release`.
:return: ReleaseEntity
If the method is called asynchronously,
returns the request thread.
@@ -8961,6 +9037,7 @@ class DefaultApi(object):
def update_container(self, editgroup_id, ident, entity, **kwargs): # noqa: E501
"""update_container # noqa: E501
+ Updates an existing entity as part of a specific (existing) editgroup. The editgroup must be open for updates (aka, not accepted/merged), and the editor making the requiest must have permissions (aka, must have created the editgroup or have `admin` role). This method can also be used to update an existing entity edit as part of an editgroup. For example, if an entity was created in this editgroup, an editor could make changes to the new entity's metadata before merging. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.update_container(editgroup_id, ident, entity, async=True)
@@ -8984,6 +9061,7 @@ class DefaultApi(object):
def update_container_with_http_info(self, editgroup_id, ident, entity, **kwargs): # noqa: E501
"""update_container # noqa: E501
+ Updates an existing entity as part of a specific (existing) editgroup. The editgroup must be open for updates (aka, not accepted/merged), and the editor making the requiest must have permissions (aka, must have created the editgroup or have `admin` role). This method can also be used to update an existing entity edit as part of an editgroup. For example, if an entity was created in this editgroup, an editor could make changes to the new entity's metadata before merging. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.update_container_with_http_info(editgroup_id, ident, entity, async=True)
@@ -9187,6 +9265,7 @@ class DefaultApi(object):
def update_editgroup(self, editgroup_id, editgroup, **kwargs): # noqa: E501
"""update_editgroup # noqa: E501
+ Updates metadata for a single editgroup object. Note that only metadata fields such as the `description` or `extra` metadata can be changed with this method; it does not allow adding or removing edits to the editgroup (for that use the individual entity create/update/delete methods). # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.update_editgroup(editgroup_id, editgroup, async=True)
@@ -9210,6 +9289,7 @@ class DefaultApi(object):
def update_editgroup_with_http_info(self, editgroup_id, editgroup, **kwargs): # noqa: E501
"""update_editgroup # noqa: E501
+ Updates metadata for a single editgroup object. Note that only metadata fields such as the `description` or `extra` metadata can be changed with this method; it does not allow adding or removing edits to the editgroup (for that use the individual entity create/update/delete methods). # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.update_editgroup_with_http_info(editgroup_id, editgroup, async=True)
@@ -9304,6 +9384,7 @@ class DefaultApi(object):
def update_editor(self, editor_id, editor, **kwargs): # noqa: E501
"""update_editor # noqa: E501
+ Allows metadata changes to some editor fields, such as the username. Changes require authentication and permissions. An editor can change their own username; changes to role flags require the `admin` role by the editor making the request. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.update_editor(editor_id, editor, async=True)
@@ -9326,6 +9407,7 @@ class DefaultApi(object):
def update_editor_with_http_info(self, editor_id, editor, **kwargs): # noqa: E501
"""update_editor # noqa: E501
+ Allows metadata changes to some editor fields, such as the username. Changes require authentication and permissions. An editor can change their own username; changes to role flags require the `admin` role by the editor making the request. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.update_editor_with_http_info(editor_id, editor, async=True)
@@ -9635,6 +9717,7 @@ class DefaultApi(object):
def update_release(self, editgroup_id, ident, entity, **kwargs): # noqa: E501
"""update_release # noqa: E501
+ Updates an existing entity as part of a specific (existing) editgroup. The editgroup must be open for updates (aka, not accepted/merged), and the editor making the requiest must have permissions (aka, must have created the editgroup or have `admin` role). This method can also be used to update an existing entity edit as part of an editgroup. For example, if an entity was created in this editgroup, an editor could make changes to the new entity's metadata before merging. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.update_release(editgroup_id, ident, entity, async=True)
@@ -9658,6 +9741,7 @@ class DefaultApi(object):
def update_release_with_http_info(self, editgroup_id, ident, entity, **kwargs): # noqa: E501
"""update_release # noqa: E501
+ Updates an existing entity as part of a specific (existing) editgroup. The editgroup must be open for updates (aka, not accepted/merged), and the editor making the requiest must have permissions (aka, must have created the editgroup or have `admin` role). This method can also be used to update an existing entity edit as part of an editgroup. For example, if an entity was created in this editgroup, an editor could make changes to the new entity's metadata before merging. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.update_release_with_http_info(editgroup_id, ident, entity, async=True)