aboutsummaryrefslogtreecommitdiffstats
path: root/python_openapi_client/fatcat_openapi_client/models/webcapture_entity.py
diff options
context:
space:
mode:
Diffstat (limited to 'python_openapi_client/fatcat_openapi_client/models/webcapture_entity.py')
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/webcapture_entity.py20
1 files changed, 14 insertions, 6 deletions
diff --git a/python_openapi_client/fatcat_openapi_client/models/webcapture_entity.py b/python_openapi_client/fatcat_openapi_client/models/webcapture_entity.py
index af4748c5..fde2be43 100644
--- a/python_openapi_client/fatcat_openapi_client/models/webcapture_entity.py
+++ b/python_openapi_client/fatcat_openapi_client/models/webcapture_entity.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
"""
@@ -109,7 +109,7 @@ class WebcaptureEntity(object):
def releases(self):
"""Gets the releases of this WebcaptureEntity. # noqa: E501
- Optional; GET-only # noqa: E501
+ Full release entities, included in GET responses when `releases` included in `expand` parameter. Ignored if included in PUT or POST requests. # noqa: E501
:return: The releases of this WebcaptureEntity. # noqa: E501
:rtype: list[ReleaseEntity]
@@ -120,7 +120,7 @@ class WebcaptureEntity(object):
def releases(self, releases):
"""Sets the releases of this WebcaptureEntity.
- Optional; GET-only # noqa: E501
+ Full release entities, included in GET responses when `releases` included in `expand` parameter. Ignored if included in PUT or POST requests. # noqa: E501
:param releases: The releases of this WebcaptureEntity. # noqa: E501
:type: list[ReleaseEntity]
@@ -132,6 +132,7 @@ class WebcaptureEntity(object):
def release_ids(self):
"""Gets the release_ids of this WebcaptureEntity. # noqa: E501
+ Set of identifier of release entities this fileset represents a full manifestation of. Usually a single release. # noqa: E501
:return: The release_ids of this WebcaptureEntity. # noqa: E501
:rtype: list[str]
@@ -142,6 +143,7 @@ class WebcaptureEntity(object):
def release_ids(self, release_ids):
"""Sets the release_ids of this WebcaptureEntity.
+ Set of identifier of release entities this fileset represents a full manifestation of. Usually a single release. # noqa: E501
:param release_ids: The release_ids of this WebcaptureEntity. # noqa: E501
:type: list[str]
@@ -153,7 +155,7 @@ class WebcaptureEntity(object):
def timestamp(self):
"""Gets the timestamp of this WebcaptureEntity. # noqa: E501
- same format as CDX line timestamp (UTC, etc). Corresponds to the overall capture timestamp. Can be the earliest or average of CDX timestamps if that makes sense. # noqa: E501
+ Same format as CDX line timestamp (UTC, etc). Corresponds to the overall capture timestamp. Should generally be the timestamp of capture of the primary resource URL. # noqa: E501
:return: The timestamp of this WebcaptureEntity. # noqa: E501
:rtype: datetime
@@ -164,7 +166,7 @@ class WebcaptureEntity(object):
def timestamp(self, timestamp):
"""Sets the timestamp of this WebcaptureEntity.
- same format as CDX line timestamp (UTC, etc). Corresponds to the overall capture timestamp. Can be the earliest or average of CDX timestamps if that makes sense. # noqa: E501
+ Same format as CDX line timestamp (UTC, etc). Corresponds to the overall capture timestamp. Should generally be the timestamp of capture of the primary resource URL. # noqa: E501
:param timestamp: The timestamp of this WebcaptureEntity. # noqa: E501
:type: datetime
@@ -176,6 +178,7 @@ class WebcaptureEntity(object):
def original_url(self):
"""Gets the original_url of this WebcaptureEntity. # noqa: E501
+ Base URL of the primary resource this is a capture of # noqa: E501
:return: The original_url of this WebcaptureEntity. # noqa: E501
:rtype: str
@@ -186,6 +189,7 @@ class WebcaptureEntity(object):
def original_url(self, original_url):
"""Sets the original_url of this WebcaptureEntity.
+ Base URL of the primary resource this is a capture of # noqa: E501
:param original_url: The original_url of this WebcaptureEntity. # noqa: E501
:type: str
@@ -239,6 +243,7 @@ class WebcaptureEntity(object):
def edit_extra(self):
"""Gets the edit_extra of this WebcaptureEntity. # noqa: E501
+ Free-form JSON metadata that will be stored with specific entity edits (eg, creation/update/delete). # noqa: E501
:return: The edit_extra of this WebcaptureEntity. # noqa: E501
:rtype: object
@@ -249,6 +254,7 @@ class WebcaptureEntity(object):
def edit_extra(self, edit_extra):
"""Sets the edit_extra of this WebcaptureEntity.
+ Free-form JSON metadata that will be stored with specific entity edits (eg, creation/update/delete). # noqa: E501
:param edit_extra: The edit_extra of this WebcaptureEntity. # noqa: E501
:type: object
@@ -260,6 +266,7 @@ class WebcaptureEntity(object):
def extra(self):
"""Gets the extra of this WebcaptureEntity. # noqa: E501
+ Free-form JSON metadata that will be stored with the other entity metadata. See guide for (unenforced) schema conventions. # noqa: E501
:return: The extra of this WebcaptureEntity. # noqa: E501
:rtype: object
@@ -270,6 +277,7 @@ class WebcaptureEntity(object):
def extra(self, extra):
"""Sets the extra of this WebcaptureEntity.
+ Free-form JSON metadata that will be stored with the other entity metadata. See guide for (unenforced) schema conventions. # noqa: E501
:param extra: The extra of this WebcaptureEntity. # noqa: E501
:type: object