summaryrefslogtreecommitdiffstats
path: root/python_openapi_client/fatcat_openapi_client/models
diff options
context:
space:
mode:
Diffstat (limited to 'python_openapi_client/fatcat_openapi_client/models')
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/__init__.py4
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/auth_oidc.py12
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/auth_oidc_result.py4
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/changelog_entry.py10
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/container_auto_batch.py4
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/container_entity.py20
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/creator_auto_batch.py4
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/creator_entity.py20
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/editgroup.py26
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/editgroup_annotation.py18
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/editgroup_edits.py4
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/editor.py16
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/entity_edit.py28
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/entity_history_entry.py4
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/error_response.py4
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/file_auto_batch.py4
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/file_entity.py22
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/file_url.py8
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/fileset_auto_batch.py4
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/fileset_entity.py14
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/fileset_file.py16
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/fileset_url.py6
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/release_abstract.py12
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/release_auto_batch.py4
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/release_contrib.py24
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/release_entity.py76
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/release_ext_ids.py24
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/release_ref.py22
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/success.py4
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/webcapture_auto_batch.py4
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/webcapture_cdx_line.py22
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/webcapture_entity.py20
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/webcapture_url.py8
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/work_auto_batch.py4
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/work_entity.py8
35 files changed, 352 insertions, 132 deletions
diff --git a/python_openapi_client/fatcat_openapi_client/models/__init__.py b/python_openapi_client/fatcat_openapi_client/models/__init__.py
index 751e4a68..88b5746d 100644
--- a/python_openapi_client/fatcat_openapi_client/models/__init__.py
+++ b/python_openapi_client/fatcat_openapi_client/models/__init__.py
@@ -4,10 +4,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
"""
diff --git a/python_openapi_client/fatcat_openapi_client/models/auth_oidc.py b/python_openapi_client/fatcat_openapi_client/models/auth_oidc.py
index 5d11adab..4fd16901 100644
--- a/python_openapi_client/fatcat_openapi_client/models/auth_oidc.py
+++ b/python_openapi_client/fatcat_openapi_client/models/auth_oidc.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
"""
@@ -62,6 +62,7 @@ class AuthOidc(object):
def provider(self):
"""Gets the provider of this AuthOidc. # noqa: E501
+ Fatcat-specific short name (slug) for remote service being used for authentication. # noqa: E501
:return: The provider of this AuthOidc. # noqa: E501
:rtype: str
@@ -72,6 +73,7 @@ class AuthOidc(object):
def provider(self, provider):
"""Sets the provider of this AuthOidc.
+ Fatcat-specific short name (slug) for remote service being used for authentication. # noqa: E501
:param provider: The provider of this AuthOidc. # noqa: E501
:type: str
@@ -85,6 +87,7 @@ class AuthOidc(object):
def sub(self):
"""Gets the sub of this AuthOidc. # noqa: E501
+ `SUB` from OIDC protocol. Usually a URL. # noqa: E501
:return: The sub of this AuthOidc. # noqa: E501
:rtype: str
@@ -95,6 +98,7 @@ class AuthOidc(object):
def sub(self, sub):
"""Sets the sub of this AuthOidc.
+ `SUB` from OIDC protocol. Usually a URL. # noqa: E501
:param sub: The sub of this AuthOidc. # noqa: E501
:type: str
@@ -108,6 +112,7 @@ class AuthOidc(object):
def iss(self):
"""Gets the iss of this AuthOidc. # noqa: E501
+ `ISS` from OIDC protocol. Usually a stable account username, number, or identifier. # noqa: E501
:return: The iss of this AuthOidc. # noqa: E501
:rtype: str
@@ -118,6 +123,7 @@ class AuthOidc(object):
def iss(self, iss):
"""Sets the iss of this AuthOidc.
+ `ISS` from OIDC protocol. Usually a stable account username, number, or identifier. # noqa: E501
:param iss: The iss of this AuthOidc. # noqa: E501
:type: str
@@ -131,6 +137,7 @@ class AuthOidc(object):
def preferred_username(self):
"""Gets the preferred_username of this AuthOidc. # noqa: E501
+ What it sounds like; returned by OIDC, and used as a hint when creating new editor accounts. Fatcat usernames are usually this string with the `provider` slug as a suffix, though some munging may occur. # noqa: E501
:return: The preferred_username of this AuthOidc. # noqa: E501
:rtype: str
@@ -141,6 +148,7 @@ class AuthOidc(object):
def preferred_username(self, preferred_username):
"""Sets the preferred_username of this AuthOidc.
+ What it sounds like; returned by OIDC, and used as a hint when creating new editor accounts. Fatcat usernames are usually this string with the `provider` slug as a suffix, though some munging may occur. # noqa: E501
:param preferred_username: The preferred_username of this AuthOidc. # noqa: E501
:type: str
diff --git a/python_openapi_client/fatcat_openapi_client/models/auth_oidc_result.py b/python_openapi_client/fatcat_openapi_client/models/auth_oidc_result.py
index ef2d7f32..634770aa 100644
--- a/python_openapi_client/fatcat_openapi_client/models/auth_oidc_result.py
+++ b/python_openapi_client/fatcat_openapi_client/models/auth_oidc_result.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
"""
diff --git a/python_openapi_client/fatcat_openapi_client/models/changelog_entry.py b/python_openapi_client/fatcat_openapi_client/models/changelog_entry.py
index 893a3d2b..dbb1a9ca 100644
--- a/python_openapi_client/fatcat_openapi_client/models/changelog_entry.py
+++ b/python_openapi_client/fatcat_openapi_client/models/changelog_entry.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
"""
@@ -65,6 +65,7 @@ class ChangelogEntry(object):
def index(self):
"""Gets the index of this ChangelogEntry. # noqa: E501
+ Monotonically increasing sequence number of this changelog entry. # noqa: E501
:return: The index of this ChangelogEntry. # noqa: E501
:rtype: int
@@ -75,6 +76,7 @@ class ChangelogEntry(object):
def index(self, index):
"""Sets the index of this ChangelogEntry.
+ Monotonically increasing sequence number of this changelog entry. # noqa: E501
:param index: The index of this ChangelogEntry. # noqa: E501
:type: int
@@ -88,6 +90,7 @@ class ChangelogEntry(object):
def editgroup_id(self):
"""Gets the editgroup_id of this ChangelogEntry. # noqa: E501
+ Identifier of editgroup accepted/merged in this changelog entry. # noqa: E501
:return: The editgroup_id of this ChangelogEntry. # noqa: E501
:rtype: str
@@ -98,6 +101,7 @@ class ChangelogEntry(object):
def editgroup_id(self, editgroup_id):
"""Sets the editgroup_id of this ChangelogEntry.
+ Identifier of editgroup accepted/merged in this changelog entry. # noqa: E501
:param editgroup_id: The editgroup_id of this ChangelogEntry. # noqa: E501
:type: str
@@ -111,6 +115,7 @@ class ChangelogEntry(object):
def timestamp(self):
"""Gets the timestamp of this ChangelogEntry. # noqa: E501
+ Date and time when the editgroup was accpeted. # noqa: E501
:return: The timestamp of this ChangelogEntry. # noqa: E501
:rtype: datetime
@@ -121,6 +126,7 @@ class ChangelogEntry(object):
def timestamp(self, timestamp):
"""Sets the timestamp of this ChangelogEntry.
+ Date and time when the editgroup was accpeted. # noqa: E501
:param timestamp: The timestamp of this ChangelogEntry. # noqa: E501
:type: datetime
diff --git a/python_openapi_client/fatcat_openapi_client/models/container_auto_batch.py b/python_openapi_client/fatcat_openapi_client/models/container_auto_batch.py
index 2a431196..5f35a543 100644
--- a/python_openapi_client/fatcat_openapi_client/models/container_auto_batch.py
+++ b/python_openapi_client/fatcat_openapi_client/models/container_auto_batch.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
"""
diff --git a/python_openapi_client/fatcat_openapi_client/models/container_entity.py b/python_openapi_client/fatcat_openapi_client/models/container_entity.py
index 5fb1a51b..199b2df1 100644
--- a/python_openapi_client/fatcat_openapi_client/models/container_entity.py
+++ b/python_openapi_client/fatcat_openapi_client/models/container_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
"""
@@ -122,6 +122,7 @@ class ContainerEntity(object):
def issnl(self):
"""Gets the issnl of this ContainerEntity. # noqa: E501
+ Linking ISSN number (ISSN-L). Should be valid and registered with issn.org # noqa: E501
:return: The issnl of this ContainerEntity. # noqa: E501
:rtype: str
@@ -132,6 +133,7 @@ class ContainerEntity(object):
def issnl(self, issnl):
"""Sets the issnl of this ContainerEntity.
+ Linking ISSN number (ISSN-L). Should be valid and registered with issn.org # noqa: E501
:param issnl: The issnl of this ContainerEntity. # noqa: E501
:type: str
@@ -149,6 +151,7 @@ class ContainerEntity(object):
def publisher(self):
"""Gets the publisher of this ContainerEntity. # noqa: E501
+ Name of the organization or entity responsible for publication. Not the complete imprint/brand. # noqa: E501
:return: The publisher of this ContainerEntity. # noqa: E501
:rtype: str
@@ -159,6 +162,7 @@ class ContainerEntity(object):
def publisher(self, publisher):
"""Sets the publisher of this ContainerEntity.
+ Name of the organization or entity responsible for publication. Not the complete imprint/brand. # noqa: E501
:param publisher: The publisher of this ContainerEntity. # noqa: E501
:type: str
@@ -170,7 +174,7 @@ class ContainerEntity(object):
def container_type(self):
"""Gets the container_type of this ContainerEntity. # noqa: E501
- Eg, 'journal' # noqa: E501
+ Type of container, eg 'journal' or 'proceedings'. See Guide for list of valid types. # noqa: E501
:return: The container_type of this ContainerEntity. # noqa: E501
:rtype: str
@@ -181,7 +185,7 @@ class ContainerEntity(object):
def container_type(self, container_type):
"""Sets the container_type of this ContainerEntity.
- Eg, 'journal' # noqa: E501
+ Type of container, eg 'journal' or 'proceedings'. See Guide for list of valid types. # noqa: E501
:param container_type: The container_type of this ContainerEntity. # noqa: E501
:type: str
@@ -193,7 +197,7 @@ class ContainerEntity(object):
def name(self):
"""Gets the name of this ContainerEntity. # noqa: E501
- Required for valid entities # noqa: E501
+ Name of the container (eg, Journal title). Required for entity creation. # noqa: E501
:return: The name of this ContainerEntity. # noqa: E501
:rtype: str
@@ -204,7 +208,7 @@ class ContainerEntity(object):
def name(self, name):
"""Sets the name of this ContainerEntity.
- Required for valid entities # noqa: E501
+ Name of the container (eg, Journal title). Required for entity creation. # noqa: E501
:param name: The name of this ContainerEntity. # noqa: E501
:type: str
@@ -216,6 +220,7 @@ class ContainerEntity(object):
def edit_extra(self):
"""Gets the edit_extra of this ContainerEntity. # 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 ContainerEntity. # noqa: E501
:rtype: object
@@ -226,6 +231,7 @@ class ContainerEntity(object):
def edit_extra(self, edit_extra):
"""Sets the edit_extra of this ContainerEntity.
+ 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 ContainerEntity. # noqa: E501
:type: object
@@ -237,6 +243,7 @@ class ContainerEntity(object):
def extra(self):
"""Gets the extra of this ContainerEntity. # 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 ContainerEntity. # noqa: E501
:rtype: object
@@ -247,6 +254,7 @@ class ContainerEntity(object):
def extra(self, extra):
"""Sets the extra of this ContainerEntity.
+ 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 ContainerEntity. # noqa: E501
:type: object
diff --git a/python_openapi_client/fatcat_openapi_client/models/creator_auto_batch.py b/python_openapi_client/fatcat_openapi_client/models/creator_auto_batch.py
index 6080c7dc..31ba126f 100644
--- a/python_openapi_client/fatcat_openapi_client/models/creator_auto_batch.py
+++ b/python_openapi_client/fatcat_openapi_client/models/creator_auto_batch.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
"""
diff --git a/python_openapi_client/fatcat_openapi_client/models/creator_entity.py b/python_openapi_client/fatcat_openapi_client/models/creator_entity.py
index d015701b..d3ac8d4b 100644
--- a/python_openapi_client/fatcat_openapi_client/models/creator_entity.py
+++ b/python_openapi_client/fatcat_openapi_client/models/creator_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
"""
@@ -101,6 +101,7 @@ class CreatorEntity(object):
def wikidata_qid(self):
"""Gets the wikidata_qid of this CreatorEntity. # noqa: E501
+ Wikidata entity QID # noqa: E501
:return: The wikidata_qid of this CreatorEntity. # noqa: E501
:rtype: str
@@ -111,6 +112,7 @@ class CreatorEntity(object):
def wikidata_qid(self, wikidata_qid):
"""Sets the wikidata_qid of this CreatorEntity.
+ Wikidata entity QID # noqa: E501
:param wikidata_qid: The wikidata_qid of this CreatorEntity. # noqa: E501
:type: str
@@ -122,6 +124,7 @@ class CreatorEntity(object):
def orcid(self):
"""Gets the orcid of this CreatorEntity. # noqa: E501
+ ORCiD (https://orcid.org) identifier # noqa: E501
:return: The orcid of this CreatorEntity. # noqa: E501
:rtype: str
@@ -132,6 +135,7 @@ class CreatorEntity(object):
def orcid(self, orcid):
"""Sets the orcid of this CreatorEntity.
+ ORCiD (https://orcid.org) identifier # noqa: E501
:param orcid: The orcid of this CreatorEntity. # noqa: E501
:type: str
@@ -149,6 +153,7 @@ class CreatorEntity(object):
def surname(self):
"""Gets the surname of this CreatorEntity. # noqa: E501
+ In English commonly the last, or family name, but ordering is context and culture specific. # noqa: E501
:return: The surname of this CreatorEntity. # noqa: E501
:rtype: str
@@ -159,6 +164,7 @@ class CreatorEntity(object):
def surname(self, surname):
"""Sets the surname of this CreatorEntity.
+ In English commonly the last, or family name, but ordering is context and culture specific. # noqa: E501
:param surname: The surname of this CreatorEntity. # noqa: E501
:type: str
@@ -170,6 +176,7 @@ class CreatorEntity(object):
def given_name(self):
"""Gets the given_name of this CreatorEntity. # noqa: E501
+ In English commonly the first name, but ordering is context and culture specific. # noqa: E501
:return: The given_name of this CreatorEntity. # noqa: E501
:rtype: str
@@ -180,6 +187,7 @@ class CreatorEntity(object):
def given_name(self, given_name):
"""Sets the given_name of this CreatorEntity.
+ In English commonly the first name, but ordering is context and culture specific. # noqa: E501
:param given_name: The given_name of this CreatorEntity. # noqa: E501
:type: str
@@ -191,7 +199,7 @@ class CreatorEntity(object):
def display_name(self):
"""Gets the display_name of this CreatorEntity. # noqa: E501
- Required for valid entities # noqa: E501
+ Name as should be displayed in web interface or in author lists (not index/sorted). Required for valid entities. # noqa: E501
:return: The display_name of this CreatorEntity. # noqa: E501
:rtype: str
@@ -202,7 +210,7 @@ class CreatorEntity(object):
def display_name(self, display_name):
"""Sets the display_name of this CreatorEntity.
- Required for valid entities # noqa: E501
+ Name as should be displayed in web interface or in author lists (not index/sorted). Required for valid entities. # noqa: E501
:param display_name: The display_name of this CreatorEntity. # noqa: E501
:type: str
@@ -328,6 +336,7 @@ class CreatorEntity(object):
def extra(self):
"""Gets the extra of this CreatorEntity. # 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 CreatorEntity. # noqa: E501
:rtype: object
@@ -338,6 +347,7 @@ class CreatorEntity(object):
def extra(self, extra):
"""Sets the extra of this CreatorEntity.
+ 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 CreatorEntity. # noqa: E501
:type: object
@@ -349,6 +359,7 @@ class CreatorEntity(object):
def edit_extra(self):
"""Gets the edit_extra of this CreatorEntity. # 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 CreatorEntity. # noqa: E501
:rtype: object
@@ -359,6 +370,7 @@ class CreatorEntity(object):
def edit_extra(self, edit_extra):
"""Sets the edit_extra of this CreatorEntity.
+ 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 CreatorEntity. # noqa: E501
:type: object
diff --git a/python_openapi_client/fatcat_openapi_client/models/editgroup.py b/python_openapi_client/fatcat_openapi_client/models/editgroup.py
index 4874f528..3c12db6d 100644
--- a/python_openapi_client/fatcat_openapi_client/models/editgroup.py
+++ b/python_openapi_client/fatcat_openapi_client/models/editgroup.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
"""
@@ -100,7 +100,7 @@ class Editgroup(object):
def editgroup_id(self):
"""Gets the editgroup_id of this Editgroup. # noqa: E501
- base32-encoded unique identifier # noqa: E501
+ Fatcat identifier for this editgroup. Assigned on creation. # noqa: E501
:return: The editgroup_id of this Editgroup. # noqa: E501
:rtype: str
@@ -111,7 +111,7 @@ class Editgroup(object):
def editgroup_id(self, editgroup_id):
"""Sets the editgroup_id of this Editgroup.
- base32-encoded unique identifier # noqa: E501
+ Fatcat identifier for this editgroup. Assigned on creation. # noqa: E501
:param editgroup_id: The editgroup_id of this Editgroup. # noqa: E501
:type: str
@@ -129,7 +129,7 @@ class Editgroup(object):
def editor_id(self):
"""Gets the editor_id of this Editgroup. # noqa: E501
- base32-encoded unique identifier # noqa: E501
+ Fatcat identifer of editor that created this editgroup. # noqa: E501
:return: The editor_id of this Editgroup. # noqa: E501
:rtype: str
@@ -140,7 +140,7 @@ class Editgroup(object):
def editor_id(self, editor_id):
"""Sets the editor_id of this Editgroup.
- base32-encoded unique identifier # noqa: E501
+ Fatcat identifer of editor that created this editgroup. # noqa: E501
:param editor_id: The editor_id of this Editgroup. # noqa: E501
:type: str
@@ -158,6 +158,7 @@ class Editgroup(object):
def editor(self):
"""Gets the editor of this Editgroup. # noqa: E501
+ Complete editor object identified by `container_id` field. Only included in GET responses. # noqa: E501
:return: The editor of this Editgroup. # noqa: E501
:rtype: Editor
@@ -168,6 +169,7 @@ class Editgroup(object):
def editor(self, editor):
"""Sets the editor of this Editgroup.
+ Complete editor object identified by `container_id` field. Only included in GET responses. # noqa: E501
:param editor: The editor of this Editgroup. # noqa: E501
:type: Editor
@@ -179,6 +181,7 @@ class Editgroup(object):
def changelog_index(self):
"""Gets the changelog_index of this Editgroup. # noqa: E501
+ For accepted/merged editgroups, the changelog index that the accept occured at. WARNING: not populated in all contexts that an editgroup could be included in a response. # noqa: E501
:return: The changelog_index of this Editgroup. # noqa: E501
:rtype: int
@@ -189,6 +192,7 @@ class Editgroup(object):
def changelog_index(self, changelog_index):
"""Sets the changelog_index of this Editgroup.
+ For accepted/merged editgroups, the changelog index that the accept occured at. WARNING: not populated in all contexts that an editgroup could be included in a response. # noqa: E501
:param changelog_index: The changelog_index of this Editgroup. # noqa: E501
:type: int
@@ -200,6 +204,7 @@ class Editgroup(object):
def created(self):
"""Gets the created of this Editgroup. # noqa: E501
+ Timestamp when this editgroup was first created. # noqa: E501
:return: The created of this Editgroup. # noqa: E501
:rtype: datetime
@@ -210,6 +215,7 @@ class Editgroup(object):
def created(self, created):
"""Sets the created of this Editgroup.
+ Timestamp when this editgroup was first created. # noqa: E501
:param created: The created of this Editgroup. # noqa: E501
:type: datetime
@@ -221,6 +227,7 @@ class Editgroup(object):
def submitted(self):
"""Gets the submitted of this Editgroup. # noqa: E501
+ Timestamp when this editgroup was most recently submitted for review. If withdrawn, or never submitted, will be `null`. # noqa: E501
:return: The submitted of this Editgroup. # noqa: E501
:rtype: datetime
@@ -231,6 +238,7 @@ class Editgroup(object):
def submitted(self, submitted):
"""Sets the submitted of this Editgroup.
+ Timestamp when this editgroup was most recently submitted for review. If withdrawn, or never submitted, will be `null`. # noqa: E501
:param submitted: The submitted of this Editgroup. # noqa: E501
:type: datetime
@@ -242,6 +250,7 @@ class Editgroup(object):
def description(self):
"""Gets the description of this Editgroup. # noqa: E501
+ Comment describing the changes in this editgroup. Can be updated with PUT request. # noqa: E501
:return: The description of this Editgroup. # noqa: E501
:rtype: str
@@ -252,6 +261,7 @@ class Editgroup(object):
def description(self, description):
"""Sets the description of this Editgroup.
+ Comment describing the changes in this editgroup. Can be updated with PUT request. # noqa: E501
:param description: The description of this Editgroup. # noqa: E501
:type: str
@@ -263,6 +273,7 @@ class Editgroup(object):
def extra(self):
"""Gets the extra of this Editgroup. # noqa: E501
+ Free-form JSON metadata attached to this editgroup. Eg, metadata provenance, or script user-agent details. See guide for (unenforced) schema norms. # noqa: E501
:return: The extra of this Editgroup. # noqa: E501
:rtype: object
@@ -273,6 +284,7 @@ class Editgroup(object):
def extra(self, extra):
"""Sets the extra of this Editgroup.
+ Free-form JSON metadata attached to this editgroup. Eg, metadata provenance, or script user-agent details. See guide for (unenforced) schema norms. # noqa: E501
:param extra: The extra of this Editgroup. # noqa: E501
:type: object
@@ -284,6 +296,7 @@ class Editgroup(object):
def annotations(self):
"""Gets the annotations of this Editgroup. # noqa: E501
+ Only included in GET responses, and not in all contexts. Do not include this field in PUT or POST requests. # noqa: E501
:return: The annotations of this Editgroup. # noqa: E501
:rtype: list[EditgroupAnnotation]
@@ -294,6 +307,7 @@ class Editgroup(object):
def annotations(self, annotations):
"""Sets the annotations of this Editgroup.
+ Only included in GET responses, and not in all contexts. Do not include this field in PUT or POST requests. # noqa: E501
:param annotations: The annotations of this Editgroup. # noqa: E501
:type: list[EditgroupAnnotation]
diff --git a/python_openapi_client/fatcat_openapi_client/models/editgroup_annotation.py b/python_openapi_client/fatcat_openapi_client/models/editgroup_annotation.py
index d2dde642..4fc80c5d 100644
--- a/python_openapi_client/fatcat_openapi_client/models/editgroup_annotation.py
+++ b/python_openapi_client/fatcat_openapi_client/models/editgroup_annotation.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
"""
@@ -112,7 +112,7 @@ class EditgroupAnnotation(object):
def editgroup_id(self):
"""Gets the editgroup_id of this EditgroupAnnotation. # noqa: E501
- base32-encoded unique identifier # noqa: E501
+ Editgroup that this annotation applies to. Set automatically in creations based on URL parameter. # noqa: E501
:return: The editgroup_id of this EditgroupAnnotation. # noqa: E501
:rtype: str
@@ -123,7 +123,7 @@ class EditgroupAnnotation(object):
def editgroup_id(self, editgroup_id):
"""Sets the editgroup_id of this EditgroupAnnotation.
- base32-encoded unique identifier # noqa: E501
+ Editgroup that this annotation applies to. Set automatically in creations based on URL parameter. # noqa: E501
:param editgroup_id: The editgroup_id of this EditgroupAnnotation. # noqa: E501
:type: str
@@ -141,7 +141,7 @@ class EditgroupAnnotation(object):
def editor_id(self):
"""Gets the editor_id of this EditgroupAnnotation. # noqa: E501
- base32-encoded unique identifier # noqa: E501
+ Defaults to editor created the annotation via POST request. # noqa: E501
:return: The editor_id of this EditgroupAnnotation. # noqa: E501
:rtype: str
@@ -152,7 +152,7 @@ class EditgroupAnnotation(object):
def editor_id(self, editor_id):
"""Sets the editor_id of this EditgroupAnnotation.
- base32-encoded unique identifier # noqa: E501
+ Defaults to editor created the annotation via POST request. # noqa: E501
:param editor_id: The editor_id of this EditgroupAnnotation. # noqa: E501
:type: str
@@ -170,6 +170,7 @@ class EditgroupAnnotation(object):
def editor(self):
"""Gets the editor of this EditgroupAnnotation. # noqa: E501
+ Only included in GET responses; ignored in PUT or POST requests. # noqa: E501
:return: The editor of this EditgroupAnnotation. # noqa: E501
:rtype: Editor
@@ -180,6 +181,7 @@ class EditgroupAnnotation(object):
def editor(self, editor):
"""Sets the editor of this EditgroupAnnotation.
+ Only included in GET responses; ignored in PUT or POST requests. # noqa: E501
:param editor: The editor of this EditgroupAnnotation. # noqa: E501
:type: Editor
@@ -191,6 +193,7 @@ class EditgroupAnnotation(object):
def created(self):
"""Gets the created of this EditgroupAnnotation. # noqa: E501
+ Timestamp when annotation was first created. # noqa: E501
:return: The created of this EditgroupAnnotation. # noqa: E501
:rtype: datetime
@@ -201,6 +204,7 @@ class EditgroupAnnotation(object):
def created(self, created):
"""Sets the created of this EditgroupAnnotation.
+ Timestamp when annotation was first created. # noqa: E501
:param created: The created of this EditgroupAnnotation. # noqa: E501
:type: datetime
@@ -233,6 +237,7 @@ class EditgroupAnnotation(object):
def extra(self):
"""Gets the extra of this EditgroupAnnotation. # noqa: E501
+ Additional free-form JSON metadata that can be included as part of the annotation (or even as the primary annotation itself). See guide for details. # noqa: E501
:return: The extra of this EditgroupAnnotation. # noqa: E501
:rtype: object
@@ -243,6 +248,7 @@ class EditgroupAnnotation(object):
def extra(self, extra):
"""Sets the extra of this EditgroupAnnotation.
+ Additional free-form JSON metadata that can be included as part of the annotation (or even as the primary annotation itself). See guide for details. # noqa: E501
:param extra: The extra of this EditgroupAnnotation. # noqa: E501
:type: object
diff --git a/python_openapi_client/fatcat_openapi_client/models/editgroup_edits.py b/python_openapi_client/fatcat_openapi_client/models/editgroup_edits.py
index 07e6b9fc..4842b858 100644
--- a/python_openapi_client/fatcat_openapi_client/models/editgroup_edits.py
+++ b/python_openapi_client/fatcat_openapi_client/models/editgroup_edits.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
"""
diff --git a/python_openapi_client/fatcat_openapi_client/models/editor.py b/python_openapi_client/fatcat_openapi_client/models/editor.py
index 37657266..b06b5126 100644
--- a/python_openapi_client/fatcat_openapi_client/models/editor.py
+++ b/python_openapi_client/fatcat_openapi_client/models/editor.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
"""
@@ -70,7 +70,7 @@ class Editor(object):
def editor_id(self):
"""Gets the editor_id of this Editor. # noqa: E501
- base32-encoded unique identifier # noqa: E501
+ Fatcat identifier for the editor. Can not be changed. # noqa: E501
:return: The editor_id of this Editor. # noqa: E501
:rtype: str
@@ -81,7 +81,7 @@ class Editor(object):
def editor_id(self, editor_id):
"""Sets the editor_id of this Editor.
- base32-encoded unique identifier # noqa: E501
+ Fatcat identifier for the editor. Can not be changed. # noqa: E501
:param editor_id: The editor_id of this Editor. # noqa: E501
:type: str
@@ -99,6 +99,7 @@ class Editor(object):
def username(self):
"""Gets the username of this Editor. # noqa: E501
+ Username/handle (short slug-like string) to identify this editor. May be changed at any time by the editor; use the `editor_id` as a persistend identifer. # noqa: E501
:return: The username of this Editor. # noqa: E501
:rtype: str
@@ -109,6 +110,7 @@ class Editor(object):
def username(self, username):
"""Sets the username of this Editor.
+ Username/handle (short slug-like string) to identify this editor. May be changed at any time by the editor; use the `editor_id` as a persistend identifer. # noqa: E501
:param username: The username of this Editor. # noqa: E501
:type: str
@@ -122,6 +124,7 @@ class Editor(object):
def is_admin(self):
"""Gets the is_admin of this Editor. # noqa: E501
+ Whether this editor has the `admin` role. # noqa: E501
:return: The is_admin of this Editor. # noqa: E501
:rtype: bool
@@ -132,6 +135,7 @@ class Editor(object):
def is_admin(self, is_admin):
"""Sets the is_admin of this Editor.
+ Whether this editor has the `admin` role. # noqa: E501
:param is_admin: The is_admin of this Editor. # noqa: E501
:type: bool
@@ -143,6 +147,7 @@ class Editor(object):
def is_bot(self):
"""Gets the is_bot of this Editor. # noqa: E501
+ Whether this editor is a bot (as opposed to a human making manual edits) # noqa: E501
:return: The is_bot of this Editor. # noqa: E501
:rtype: bool
@@ -153,6 +158,7 @@ class Editor(object):
def is_bot(self, is_bot):
"""Sets the is_bot of this Editor.
+ Whether this editor is a bot (as opposed to a human making manual edits) # noqa: E501
:param is_bot: The is_bot of this Editor. # noqa: E501
:type: bool
@@ -164,6 +170,7 @@ class Editor(object):
def is_active(self):
"""Gets the is_active of this Editor. # noqa: E501
+ Whether this editor's account is enabled (if not API tokens and web logins will not work). # noqa: E501
:return: The is_active of this Editor. # noqa: E501
:rtype: bool
@@ -174,6 +181,7 @@ class Editor(object):
def is_active(self, is_active):
"""Sets the is_active of this Editor.
+ Whether this editor's account is enabled (if not API tokens and web logins will not work). # noqa: E501
:param is_active: The is_active of this Editor. # noqa: E501
:type: bool
diff --git a/python_openapi_client/fatcat_openapi_client/models/entity_edit.py b/python_openapi_client/fatcat_openapi_client/models/entity_edit.py
index f89817c5..2d8da89e 100644
--- a/python_openapi_client/fatcat_openapi_client/models/entity_edit.py
+++ b/python_openapi_client/fatcat_openapi_client/models/entity_edit.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
"""
@@ -78,7 +78,7 @@ class EntityEdit(object):
def edit_id(self):
"""Gets the edit_id of this EntityEdit. # noqa: E501
- UUID (lower-case, dash-separated, hex-encoded 128-bit) # noqa: E501
+ Unique UUID for this specific edit object. # noqa: E501
:return: The edit_id of this EntityEdit. # noqa: E501
:rtype: str
@@ -89,7 +89,7 @@ class EntityEdit(object):
def edit_id(self, edit_id):
"""Sets the edit_id of this EntityEdit.
- UUID (lower-case, dash-separated, hex-encoded 128-bit) # noqa: E501
+ Unique UUID for this specific edit object. # noqa: E501
:param edit_id: The edit_id of this EntityEdit. # noqa: E501
:type: str
@@ -109,7 +109,7 @@ class EntityEdit(object):
def ident(self):
"""Gets the ident of this EntityEdit. # noqa: E501
- base32-encoded unique identifier # noqa: E501
+ Fatcat identifier of the entity this edit is mutating. # noqa: E501
:return: The ident of this EntityEdit. # noqa: E501
:rtype: str
@@ -120,7 +120,7 @@ class EntityEdit(object):
def ident(self, ident):
"""Sets the ident of this EntityEdit.
- base32-encoded unique identifier # noqa: E501
+ Fatcat identifier of the entity this edit is mutating. # noqa: E501
:param ident: The ident of this EntityEdit. # noqa: E501
:type: str
@@ -140,7 +140,7 @@ class EntityEdit(object):
def revision(self):
"""Gets the revision of this EntityEdit. # noqa: E501
- UUID (lower-case, dash-separated, hex-encoded 128-bit) # noqa: E501
+ Entity revision that this edit will set the entity to. May be `null` in the case of deletions. # noqa: E501
:return: The revision of this EntityEdit. # noqa: E501
:rtype: str
@@ -151,7 +151,7 @@ class EntityEdit(object):
def revision(self, revision):
"""Sets the revision of this EntityEdit.
- UUID (lower-case, dash-separated, hex-encoded 128-bit) # noqa: E501
+ Entity revision that this edit will set the entity to. May be `null` in the case of deletions. # noqa: E501
:param revision: The revision of this EntityEdit. # noqa: E501
:type: str
@@ -169,7 +169,7 @@ class EntityEdit(object):
def prev_revision(self):
"""Gets the prev_revision of this EntityEdit. # noqa: E501
- UUID (lower-case, dash-separated, hex-encoded 128-bit) # noqa: E501
+ Revision of entity just before this edit. May be used in the future to prevent edit race conditions. # noqa: E501
:return: The prev_revision of this EntityEdit. # noqa: E501
:rtype: str
@@ -180,7 +180,7 @@ class EntityEdit(object):
def prev_revision(self, prev_revision):
"""Sets the prev_revision of this EntityEdit.
- UUID (lower-case, dash-separated, hex-encoded 128-bit) # noqa: E501
+ Revision of entity just before this edit. May be used in the future to prevent edit race conditions. # noqa: E501
:param prev_revision: The prev_revision of this EntityEdit. # noqa: E501
:type: str
@@ -198,7 +198,7 @@ class EntityEdit(object):
def redirect_ident(self):
"""Gets the redirect_ident of this EntityEdit. # noqa: E501
- base32-encoded unique identifier # noqa: E501
+ When an edit is to merge entities (redirect one to another), this is the entity fatcat identifier for the target entity. # noqa: E501
:return: The redirect_ident of this EntityEdit. # noqa: E501
:rtype: str
@@ -209,7 +209,7 @@ class EntityEdit(object):
def redirect_ident(self, redirect_ident):
"""Sets the redirect_ident of this EntityEdit.
- base32-encoded unique identifier # noqa: E501
+ When an edit is to merge entities (redirect one to another), this is the entity fatcat identifier for the target entity. # noqa: E501
:param redirect_ident: The redirect_ident of this EntityEdit. # noqa: E501
:type: str
@@ -227,7 +227,7 @@ class EntityEdit(object):
def editgroup_id(self):
"""Gets the editgroup_id of this EntityEdit. # noqa: E501
- base32-encoded unique identifier # noqa: E501
+ Editgroup identifier that this edit is part of. # noqa: E501
:return: The editgroup_id of this EntityEdit. # noqa: E501
:rtype: str
@@ -238,7 +238,7 @@ class EntityEdit(object):
def editgroup_id(self, editgroup_id):
"""Sets the editgroup_id of this EntityEdit.
- base32-encoded unique identifier # noqa: E501
+ Editgroup identifier that this edit is part of. # noqa: E501
:param editgroup_id: The editgroup_id of this EntityEdit. # noqa: E501
:type: str
diff --git a/python_openapi_client/fatcat_openapi_client/models/entity_history_entry.py b/python_openapi_client/fatcat_openapi_client/models/entity_history_entry.py
index 5b457202..ad0d269c 100644
--- a/python_openapi_client/fatcat_openapi_client/models/entity_history_entry.py
+++ b/python_openapi_client/fatcat_openapi_client/models/entity_history_entry.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
"""
diff --git a/python_openapi_client/fatcat_openapi_client/models/error_response.py b/python_openapi_client/fatcat_openapi_client/models/error_response.py
index 43eafb9b..a514fc53 100644
--- a/python_openapi_client/fatcat_openapi_client/models/error_response.py
+++ b/python_openapi_client/fatcat_openapi_client/models/error_response.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
"""
diff --git a/python_openapi_client/fatcat_openapi_client/models/file_auto_batch.py b/python_openapi_client/fatcat_openapi_client/models/file_auto_batch.py
index 7f8853d2..5399d394 100644
--- a/python_openapi_client/fatcat_openapi_client/models/file_auto_batch.py
+++ b/python_openapi_client/fatcat_openapi_client/models/file_auto_batch.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
"""
diff --git a/python_openapi_client/fatcat_openapi_client/models/file_entity.py b/python_openapi_client/fatcat_openapi_client/models/file_entity.py
index 9f9a558a..a976a3f6 100644
--- a/python_openapi_client/fatcat_openapi_client/models/file_entity.py
+++ b/python_openapi_client/fatcat_openapi_client/models/file_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
"""
@@ -118,7 +118,7 @@ class FileEntity(object):
def releases(self):
"""Gets the releases of this FileEntity. # 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 FileEntity. # noqa: E501
:rtype: list[ReleaseEntity]
@@ -129,7 +129,7 @@ class FileEntity(object):
def releases(self, releases):
"""Sets the releases of this FileEntity.
- 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 FileEntity. # noqa: E501
:type: list[ReleaseEntity]
@@ -141,6 +141,7 @@ class FileEntity(object):
def release_ids(self):
"""Gets the release_ids of this FileEntity. # noqa: E501
+ Set of identifier of release entities this file represents a full manifestation of. Usually a single release, but some files contain content of multiple full releases (eg, an issue of a journal). # noqa: E501
:return: The release_ids of this FileEntity. # noqa: E501
:rtype: list[str]
@@ -151,6 +152,7 @@ class FileEntity(object):
def release_ids(self, release_ids):
"""Sets the release_ids of this FileEntity.
+ Set of identifier of release entities this file represents a full manifestation of. Usually a single release, but some files contain content of multiple full releases (eg, an issue of a journal). # noqa: E501
:param release_ids: The release_ids of this FileEntity. # noqa: E501
:type: list[str]
@@ -204,6 +206,7 @@ class FileEntity(object):
def sha256(self):
"""Gets the sha256 of this FileEntity. # noqa: E501
+ SHA-256 hash of data, in hex encoding # noqa: E501
:return: The sha256 of this FileEntity. # noqa: E501
:rtype: str
@@ -214,6 +217,7 @@ class FileEntity(object):
def sha256(self, sha256):
"""Sets the sha256 of this FileEntity.
+ SHA-256 hash of data, in hex encoding # noqa: E501
:param sha256: The sha256 of this FileEntity. # noqa: E501
:type: str
@@ -231,6 +235,7 @@ class FileEntity(object):
def sha1(self):
"""Gets the sha1 of this FileEntity. # noqa: E501
+ SHA-1 hash of data, in hex encoding # noqa: E501
:return: The sha1 of this FileEntity. # noqa: E501
:rtype: str
@@ -241,6 +246,7 @@ class FileEntity(object):
def sha1(self, sha1):
"""Sets the sha1 of this FileEntity.
+ SHA-1 hash of data, in hex encoding # noqa: E501
:param sha1: The sha1 of this FileEntity. # noqa: E501
:type: str
@@ -258,6 +264,7 @@ class FileEntity(object):
def md5(self):
"""Gets the md5 of this FileEntity. # noqa: E501
+ MD5 hash of data, in hex encoding # noqa: E501
:return: The md5 of this FileEntity. # noqa: E501
:rtype: str
@@ -268,6 +275,7 @@ class FileEntity(object):
def md5(self, md5):
"""Sets the md5 of this FileEntity.
+ MD5 hash of data, in hex encoding # noqa: E501
:param md5: The md5 of this FileEntity. # noqa: E501
:type: str
@@ -285,6 +293,7 @@ class FileEntity(object):
def size(self):
"""Gets the size of this FileEntity. # noqa: E501
+ Size of file in bytes. Non-zero. # noqa: E501
:return: The size of this FileEntity. # noqa: E501
:rtype: int
@@ -295,6 +304,7 @@ class FileEntity(object):
def size(self, size):
"""Sets the size of this FileEntity.
+ Size of file in bytes. Non-zero. # noqa: E501
:param size: The size of this FileEntity. # noqa: E501
:type: int
@@ -306,6 +316,7 @@ class FileEntity(object):
def edit_extra(self):
"""Gets the edit_extra of this FileEntity. # 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 FileEntity. # noqa: E501
:rtype: object
@@ -316,6 +327,7 @@ class FileEntity(object):
def edit_extra(self, edit_extra):
"""Sets the edit_extra of this FileEntity.
+ 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 FileEntity. # noqa: E501
:type: object
@@ -327,6 +339,7 @@ class FileEntity(object):
def extra(self):
"""Gets the extra of this FileEntity. # 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 FileEntity. # noqa: E501
:rtype: object
@@ -337,6 +350,7 @@ class FileEntity(object):
def extra(self, extra):
"""Sets the extra of this FileEntity.
+ 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 FileEntity. # noqa: E501
:type: object
diff --git a/python_openapi_client/fatcat_openapi_client/models/file_url.py b/python_openapi_client/fatcat_openapi_client/models/file_url.py
index cce0d332..2f3e5121 100644
--- a/python_openapi_client/fatcat_openapi_client/models/file_url.py
+++ b/python_openapi_client/fatcat_openapi_client/models/file_url.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
"""
@@ -54,6 +54,7 @@ class FileUrl(object):
def url(self):
"""Gets the url of this FileUrl. # noqa: E501
+ URL/URI pointing directly to a machine retrievable copy of this exact file. # noqa: E501
:return: The url of this FileUrl. # noqa: E501
:rtype: str
@@ -64,6 +65,7 @@ class FileUrl(object):
def url(self, url):
"""Sets the url of this FileUrl.
+ URL/URI pointing directly to a machine retrievable copy of this exact file. # noqa: E501
:param url: The url of this FileUrl. # noqa: E501
:type: str
@@ -77,6 +79,7 @@ class FileUrl(object):
def rel(self):
"""Gets the rel of this FileUrl. # noqa: E501
+ Indicates type of host this URL points to. Eg, \"publisher\", \"repository\", \"webarchive\". See guide for list of acceptable values. # noqa: E501
:return: The rel of this FileUrl. # noqa: E501
:rtype: str
@@ -87,6 +90,7 @@ class FileUrl(object):
def rel(self, rel):
"""Sets the rel of this FileUrl.
+ Indicates type of host this URL points to. Eg, \"publisher\", \"repository\", \"webarchive\". See guide for list of acceptable values. # noqa: E501
:param rel: The rel of this FileUrl. # noqa: E501
:type: str
diff --git a/python_openapi_client/fatcat_openapi_client/models/fileset_auto_batch.py b/python_openapi_client/fatcat_openapi_client/models/fileset_auto_batch.py
index b252449d..e3f8fb0e 100644
--- a/python_openapi_client/fatcat_openapi_client/models/fileset_auto_batch.py
+++ b/python_openapi_client/fatcat_openapi_client/models/fileset_auto_batch.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
"""
diff --git a/python_openapi_client/fatcat_openapi_client/models/fileset_entity.py b/python_openapi_client/fatcat_openapi_client/models/fileset_entity.py
index c0d02fd3..a3ebba42 100644
--- a/python_openapi_client/fatcat_openapi_client/models/fileset_entity.py
+++ b/python_openapi_client/fatcat_openapi_client/models/fileset_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
"""
@@ -99,7 +99,7 @@ class FilesetEntity(object):
def releases(self):
"""Gets the releases of this FilesetEntity. # 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 FilesetEntity. # noqa: E501
:rtype: list[ReleaseEntity]
@@ -110,7 +110,7 @@ class FilesetEntity(object):
def releases(self, releases):
"""Sets the releases of this FilesetEntity.
- 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 FilesetEntity. # noqa: E501
:type: list[ReleaseEntity]
@@ -122,6 +122,7 @@ class FilesetEntity(object):
def release_ids(self):
"""Gets the release_ids of this FilesetEntity. # 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 FilesetEntity. # noqa: E501
:rtype: list[str]
@@ -132,6 +133,7 @@ class FilesetEntity(object):
def release_ids(self, release_ids):
"""Sets the release_ids of this FilesetEntity.
+ 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 FilesetEntity. # noqa: E501
:type: list[str]
@@ -299,6 +301,7 @@ class FilesetEntity(object):
def extra(self):
"""Gets the extra of this FilesetEntity. # 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 FilesetEntity. # noqa: E501
:rtype: object
@@ -309,6 +312,7 @@ class FilesetEntity(object):
def extra(self, extra):
"""Sets the extra of this FilesetEntity.
+ 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 FilesetEntity. # noqa: E501
:type: object
@@ -320,6 +324,7 @@ class FilesetEntity(object):
def edit_extra(self):
"""Gets the edit_extra of this FilesetEntity. # 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 FilesetEntity. # noqa: E501
:rtype: object
@@ -330,6 +335,7 @@ class FilesetEntity(object):
def edit_extra(self, edit_extra):
"""Sets the edit_extra of this FilesetEntity.
+ 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 FilesetEntity. # noqa: E501
:type: object
diff --git a/python_openapi_client/fatcat_openapi_client/models/fileset_file.py b/python_openapi_client/fatcat_openapi_client/models/fileset_file.py
index 521abc98..c800b83a 100644
--- a/python_openapi_client/fatcat_openapi_client/models/fileset_file.py
+++ b/python_openapi_client/fatcat_openapi_client/models/fileset_file.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
"""
@@ -74,6 +74,7 @@ class FilesetFile(object):
def path(self):
"""Gets the path of this FilesetFile. # noqa: E501
+ Path name of file within this fileset (eg, directory) # noqa: E501
:return: The path of this FilesetFile. # noqa: E501
:rtype: str
@@ -84,6 +85,7 @@ class FilesetFile(object):
def path(self, path):
"""Sets the path of this FilesetFile.
+ Path name of file within this fileset (eg, directory) # noqa: E501
:param path: The path of this FilesetFile. # noqa: E501
:type: str
@@ -97,6 +99,7 @@ class FilesetFile(object):
def size(self):
"""Gets the size of this FilesetFile. # noqa: E501
+ File size in bytes # noqa: E501
:return: The size of this FilesetFile. # noqa: E501
:rtype: int
@@ -107,6 +110,7 @@ class FilesetFile(object):
def size(self, size):
"""Sets the size of this FilesetFile.
+ File size in bytes # noqa: E501
:param size: The size of this FilesetFile. # noqa: E501
:type: int
@@ -120,6 +124,7 @@ class FilesetFile(object):
def md5(self):
"""Gets the md5 of this FilesetFile. # noqa: E501
+ MD5 hash of data, in hex encoding # noqa: E501
:return: The md5 of this FilesetFile. # noqa: E501
:rtype: str
@@ -130,6 +135,7 @@ class FilesetFile(object):
def md5(self, md5):
"""Sets the md5 of this FilesetFile.
+ MD5 hash of data, in hex encoding # noqa: E501
:param md5: The md5 of this FilesetFile. # noqa: E501
:type: str
@@ -147,6 +153,7 @@ class FilesetFile(object):
def sha1(self):
"""Gets the sha1 of this FilesetFile. # noqa: E501
+ SHA-1 hash of data, in hex encoding # noqa: E501
:return: The sha1 of this FilesetFile. # noqa: E501
:rtype: str
@@ -157,6 +164,7 @@ class FilesetFile(object):
def sha1(self, sha1):
"""Sets the sha1 of this FilesetFile.
+ SHA-1 hash of data, in hex encoding # noqa: E501
:param sha1: The sha1 of this FilesetFile. # noqa: E501
:type: str
@@ -174,6 +182,7 @@ class FilesetFile(object):
def sha256(self):
"""Gets the sha256 of this FilesetFile. # noqa: E501
+ SHA-256 hash of data, in hex encoding # noqa: E501
:return: The sha256 of this FilesetFile. # noqa: E501
:rtype: str
@@ -184,6 +193,7 @@ class FilesetFile(object):
def sha256(self, sha256):
"""Sets the sha256 of this FilesetFile.
+ SHA-256 hash of data, in hex encoding # noqa: E501
:param sha256: The sha256 of this FilesetFile. # noqa: E501
:type: str
@@ -201,6 +211,7 @@ class FilesetFile(object):
def extra(self):
"""Gets the extra of this FilesetFile. # noqa: E501
+ Free-form additional metadata about this specific file in the set. Eg, `mimetype`. See guide for nomative (but unenforced) schema fields. # noqa: E501
:return: The extra of this FilesetFile. # noqa: E501
:rtype: object
@@ -211,6 +222,7 @@ class FilesetFile(object):
def extra(self, extra):
"""Sets the extra of this FilesetFile.
+ Free-form additional metadata about this specific file in the set. Eg, `mimetype`. See guide for nomative (but unenforced) schema fields. # noqa: E501
:param extra: The extra of this FilesetFile. # noqa: E501
:type: object
diff --git a/python_openapi_client/fatcat_openapi_client/models/fileset_url.py b/python_openapi_client/fatcat_openapi_client/models/fileset_url.py
index d0e3a1e7..b5c12bfa 100644
--- a/python_openapi_client/fatcat_openapi_client/models/fileset_url.py
+++ b/python_openapi_client/fatcat_openapi_client/models/fileset_url.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
"""
@@ -77,6 +77,7 @@ class FilesetUrl(object):
def rel(self):
"""Gets the rel of this FilesetUrl. # noqa: E501
+ Indicates type of host this URL points to. See guide for list of acceptable values. # noqa: E501
:return: The rel of this FilesetUrl. # noqa: E501
:rtype: str
@@ -87,6 +88,7 @@ class FilesetUrl(object):
def rel(self, rel):
"""Sets the rel of this FilesetUrl.
+ Indicates type of host this URL points to. See guide for list of acceptable values. # noqa: E501
:param rel: The rel of this FilesetUrl. # noqa: E501
:type: str
diff --git a/python_openapi_client/fatcat_openapi_client/models/release_abstract.py b/python_openapi_client/fatcat_openapi_client/models/release_abstract.py
index 173aaa4c..8f2f3588 100644
--- a/python_openapi_client/fatcat_openapi_client/models/release_abstract.py
+++ b/python_openapi_client/fatcat_openapi_client/models/release_abstract.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
"""
@@ -66,6 +66,7 @@ class ReleaseAbstract(object):
def sha1(self):
"""Gets the sha1 of this ReleaseAbstract. # noqa: E501
+ SHA-1 hash of data, in hex encoding # noqa: E501
:return: The sha1 of this ReleaseAbstract. # noqa: E501
:rtype: str
@@ -76,6 +77,7 @@ class ReleaseAbstract(object):
def sha1(self, sha1):
"""Sets the sha1 of this ReleaseAbstract.
+ SHA-1 hash of data, in hex encoding # noqa: E501
:param sha1: The sha1 of this ReleaseAbstract. # noqa: E501
:type: str
@@ -93,6 +95,7 @@ class ReleaseAbstract(object):
def content(self):
"""Gets the content of this ReleaseAbstract. # noqa: E501
+ Abstract content. May be encoded, as per `mimetype` field, but only string/text content may be included. # noqa: E501
:return: The content of this ReleaseAbstract. # noqa: E501
:rtype: str
@@ -103,6 +106,7 @@ class ReleaseAbstract(object):
def content(self, content):
"""Sets the content of this ReleaseAbstract.
+ Abstract content. May be encoded, as per `mimetype` field, but only string/text content may be included. # noqa: E501
:param content: The content of this ReleaseAbstract. # noqa: E501
:type: str
@@ -114,6 +118,7 @@ class ReleaseAbstract(object):
def mimetype(self):
"""Gets the mimetype of this ReleaseAbstract. # noqa: E501
+ Mimetype of abstract contents. `text/plain` is the default if content isn't encoded. # noqa: E501
:return: The mimetype of this ReleaseAbstract. # noqa: E501
:rtype: str
@@ -124,6 +129,7 @@ class ReleaseAbstract(object):
def mimetype(self, mimetype):
"""Sets the mimetype of this ReleaseAbstract.
+ Mimetype of abstract contents. `text/plain` is the default if content isn't encoded. # noqa: E501
:param mimetype: The mimetype of this ReleaseAbstract. # noqa: E501
:type: str
@@ -135,6 +141,7 @@ class ReleaseAbstract(object):
def lang(self):
"""Gets the lang of this ReleaseAbstract. # noqa: E501
+ ISO language code of the abstract. Same semantics as release `language` field. # noqa: E501
:return: The lang of this ReleaseAbstract. # noqa: E501
:rtype: str
@@ -145,6 +152,7 @@ class ReleaseAbstract(object):
def lang(self, lang):
"""Sets the lang of this ReleaseAbstract.
+ ISO language code of the abstract. Same semantics as release `language` field. # noqa: E501
:param lang: The lang of this ReleaseAbstract. # noqa: E501
:type: str
diff --git a/python_openapi_client/fatcat_openapi_client/models/release_auto_batch.py b/python_openapi_client/fatcat_openapi_client/models/release_auto_batch.py
index 30466a78..44aa9a36 100644
--- a/python_openapi_client/fatcat_openapi_client/models/release_auto_batch.py
+++ b/python_openapi_client/fatcat_openapi_client/models/release_auto_batch.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
"""
diff --git a/python_openapi_client/fatcat_openapi_client/models/release_contrib.py b/python_openapi_client/fatcat_openapi_client/models/release_contrib.py
index 8956618a..db87697e 100644
--- a/python_openapi_client/fatcat_openapi_client/models/release_contrib.py
+++ b/python_openapi_client/fatcat_openapi_client/models/release_contrib.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
"""
@@ -93,6 +93,7 @@ class ReleaseContrib(object):
def index(self):
"""Gets the index of this ReleaseContrib. # noqa: E501
+ Internally assigned zero-indexed sequence number of contribution. Authors should come first; this encodes the order of attriubtion. # noqa: E501
:return: The index of this ReleaseContrib. # noqa: E501
:rtype: int
@@ -103,6 +104,7 @@ class ReleaseContrib(object):
def index(self, index):
"""Sets the index of this ReleaseContrib.
+ Internally assigned zero-indexed sequence number of contribution. Authors should come first; this encodes the order of attriubtion. # noqa: E501
:param index: The index of this ReleaseContrib. # noqa: E501
:type: int
@@ -114,7 +116,7 @@ class ReleaseContrib(object):
def creator_id(self):
"""Gets the creator_id of this ReleaseContrib. # noqa: E501
- base32-encoded unique identifier # noqa: E501
+ If known, indicates the creator entity this contribution was made by. # noqa: E501
:return: The creator_id of this ReleaseContrib. # noqa: E501
:rtype: str
@@ -125,7 +127,7 @@ class ReleaseContrib(object):
def creator_id(self, creator_id):
"""Sets the creator_id of this ReleaseContrib.
- base32-encoded unique identifier # noqa: E501
+ If known, indicates the creator entity this contribution was made by. # noqa: E501
:param creator_id: The creator_id of this ReleaseContrib. # noqa: E501
:type: str
@@ -143,7 +145,7 @@ class ReleaseContrib(object):
def creator(self):
"""Gets the creator of this ReleaseContrib. # noqa: E501
- Optional; GET-only # noqa: E501
+ Complete creator entity. Only returned in GET responses, and only if `contribs` included in the `expand` query parameter. # noqa: E501
:return: The creator of this ReleaseContrib. # noqa: E501
:rtype: CreatorEntity
@@ -154,7 +156,7 @@ class ReleaseContrib(object):
def creator(self, creator):
"""Sets the creator of this ReleaseContrib.
- Optional; GET-only # noqa: E501
+ Complete creator entity. Only returned in GET responses, and only if `contribs` included in the `expand` query parameter. # noqa: E501
:param creator: The creator of this ReleaseContrib. # noqa: E501
:type: CreatorEntity
@@ -166,6 +168,7 @@ class ReleaseContrib(object):
def raw_name(self):
"""Gets the raw_name of this ReleaseContrib. # noqa: E501
+ Full name of the contributor as typeset in the release. # noqa: E501
:return: The raw_name of this ReleaseContrib. # noqa: E501
:rtype: str
@@ -176,6 +179,7 @@ class ReleaseContrib(object):
def raw_name(self, raw_name):
"""Sets the raw_name of this ReleaseContrib.
+ Full name of the contributor as typeset in the release. # noqa: E501
:param raw_name: The raw_name of this ReleaseContrib. # noqa: E501
:type: str
@@ -187,6 +191,7 @@ class ReleaseContrib(object):
def given_name(self):
"""Gets the given_name of this ReleaseContrib. # noqa: E501
+ In English commonly the first name, but ordering is context and culture specific. # noqa: E501
:return: The given_name of this ReleaseContrib. # noqa: E501
:rtype: str
@@ -197,6 +202,7 @@ class ReleaseContrib(object):
def given_name(self, given_name):
"""Sets the given_name of this ReleaseContrib.
+ In English commonly the first name, but ordering is context and culture specific. # noqa: E501
:param given_name: The given_name of this ReleaseContrib. # noqa: E501
:type: str
@@ -208,6 +214,7 @@ class ReleaseContrib(object):
def surname(self):
"""Gets the surname of this ReleaseContrib. # noqa: E501
+ In English commonly the last, or family name, but ordering is context and culture specific. # noqa: E501
:return: The surname of this ReleaseContrib. # noqa: E501
:rtype: str
@@ -218,6 +225,7 @@ class ReleaseContrib(object):
def surname(self, surname):
"""Sets the surname of this ReleaseContrib.
+ In English commonly the last, or family name, but ordering is context and culture specific. # noqa: E501
:param surname: The surname of this ReleaseContrib. # noqa: E501
:type: str
@@ -229,6 +237,7 @@ class ReleaseContrib(object):
def role(self):
"""Gets the role of this ReleaseContrib. # noqa: E501
+ Short string (slug) indicating type of contribution (eg, \"author\", \"translator\"). See guide for list of accpeted values. # noqa: E501
:return: The role of this ReleaseContrib. # noqa: E501
:rtype: str
@@ -239,6 +248,7 @@ class ReleaseContrib(object):
def role(self, role):
"""Sets the role of this ReleaseContrib.
+ Short string (slug) indicating type of contribution (eg, \"author\", \"translator\"). See guide for list of accpeted values. # noqa: E501
:param role: The role of this ReleaseContrib. # noqa: E501
:type: str
@@ -273,6 +283,7 @@ class ReleaseContrib(object):
def extra(self):
"""Gets the extra of this ReleaseContrib. # noqa: E501
+ Additional free-form JSON metadata about this contributor/contribution. See guide for normative schema. # noqa: E501
:return: The extra of this ReleaseContrib. # noqa: E501
:rtype: object
@@ -283,6 +294,7 @@ class ReleaseContrib(object):
def extra(self, extra):
"""Sets the extra of this ReleaseContrib.
+ Additional free-form JSON metadata about this contributor/contribution. See guide for normative schema. # noqa: E501
:param extra: The extra of this ReleaseContrib. # noqa: E501
:type: object
diff --git a/python_openapi_client/fatcat_openapi_client/models/release_entity.py b/python_openapi_client/fatcat_openapi_client/models/release_entity.py
index 119f5b1d..792cc0f2 100644
--- a/python_openapi_client/fatcat_openapi_client/models/release_entity.py
+++ b/python_openapi_client/fatcat_openapi_client/models/release_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
"""
@@ -287,7 +287,7 @@ class ReleaseEntity(object):
def license_slug(self):
"""Gets the license_slug of this ReleaseEntity. # noqa: E501
- Short version of license name. Eg, 'CC-BY' # noqa: E501
+ Short string (slug) name of license under which release is openly published (if applicable). # noqa: E501
:return: The license_slug of this ReleaseEntity. # noqa: E501
:rtype: str
@@ -298,7 +298,7 @@ class ReleaseEntity(object):
def license_slug(self, license_slug):
"""Sets the license_slug of this ReleaseEntity.
- Short version of license name. Eg, 'CC-BY' # noqa: E501
+ Short string (slug) name of license under which release is openly published (if applicable). # noqa: E501
:param license_slug: The license_slug of this ReleaseEntity. # noqa: E501
:type: str
@@ -310,7 +310,7 @@ class ReleaseEntity(object):
def language(self):
"""Gets the language of this ReleaseEntity. # noqa: E501
- Two-letter RFC1766/ISO639-1 language code, with extensions # noqa: E501
+ Primary language of the content of the full release. Two-letter RFC1766/ISO639-1 language code, with some custom extensions/additions. See guide. # noqa: E501
:return: The language of this ReleaseEntity. # noqa: E501
:rtype: str
@@ -321,7 +321,7 @@ class ReleaseEntity(object):
def language(self, language):
"""Sets the language of this ReleaseEntity.
- Two-letter RFC1766/ISO639-1 language code, with extensions # noqa: E501
+ Primary language of the content of the full release. Two-letter RFC1766/ISO639-1 language code, with some custom extensions/additions. See guide. # noqa: E501
:param language: The language of this ReleaseEntity. # noqa: E501
:type: str
@@ -333,6 +333,7 @@ class ReleaseEntity(object):
def publisher(self):
"""Gets the publisher of this ReleaseEntity. # noqa: E501
+ Name, usually English, of the entity or institution responsible for publication of this release. Not necessarily the imprint/brand. See guide. # noqa: E501
:return: The publisher of this ReleaseEntity. # noqa: E501
:rtype: str
@@ -343,6 +344,7 @@ class ReleaseEntity(object):
def publisher(self, publisher):
"""Sets the publisher of this ReleaseEntity.
+ Name, usually English, of the entity or institution responsible for publication of this release. Not necessarily the imprint/brand. See guide. # noqa: E501
:param publisher: The publisher of this ReleaseEntity. # noqa: E501
:type: str
@@ -354,6 +356,7 @@ class ReleaseEntity(object):
def version(self):
"""Gets the version of this ReleaseEntity. # noqa: E501
+ For, eg, updated technical reports or software packages, where the version string may be the only field disambiguating between releases. # noqa: E501
:return: The version of this ReleaseEntity. # noqa: E501
:rtype: str
@@ -364,6 +367,7 @@ class ReleaseEntity(object):
def version(self, version):
"""Sets the version of this ReleaseEntity.
+ For, eg, updated technical reports or software packages, where the version string may be the only field disambiguating between releases. # noqa: E501
:param version: The version of this ReleaseEntity. # noqa: E501
:type: str
@@ -375,6 +379,7 @@ class ReleaseEntity(object):
def number(self):
"""Gets the number of this ReleaseEntity. # noqa: E501
+ For, eg, technical reports, which are published in series or assigned some other institutional or container-specific identifier. # noqa: E501
:return: The number of this ReleaseEntity. # noqa: E501
:rtype: str
@@ -385,6 +390,7 @@ class ReleaseEntity(object):
def number(self, number):
"""Sets the number of this ReleaseEntity.
+ For, eg, technical reports, which are published in series or assigned some other institutional or container-specific identifier. # noqa: E501
:param number: The number of this ReleaseEntity. # noqa: E501
:type: str
@@ -396,6 +402,7 @@ class ReleaseEntity(object):
def pages(self):
"""Gets the pages of this ReleaseEntity. # noqa: E501
+ Either a single page number (\"first page\") or a range of pages separated by a dash (\"-\"). See guide for details. # noqa: E501
:return: The pages of this ReleaseEntity. # noqa: E501
:rtype: str
@@ -406,6 +413,7 @@ class ReleaseEntity(object):
def pages(self, pages):
"""Sets the pages of this ReleaseEntity.
+ Either a single page number (\"first page\") or a range of pages separated by a dash (\"-\"). See guide for details. # noqa: E501
:param pages: The pages of this ReleaseEntity. # noqa: E501
:type: str
@@ -417,6 +425,7 @@ class ReleaseEntity(object):
def issue(self):
"""Gets the issue of this ReleaseEntity. # noqa: E501
+ Issue number of volume/container that this release was published in. Sometimes coresponds to a month number in the year, but can be any string. See guide. # noqa: E501
:return: The issue of this ReleaseEntity. # noqa: E501
:rtype: str
@@ -427,6 +436,7 @@ class ReleaseEntity(object):
def issue(self, issue):
"""Sets the issue of this ReleaseEntity.
+ Issue number of volume/container that this release was published in. Sometimes coresponds to a month number in the year, but can be any string. See guide. # noqa: E501
:param issue: The issue of this ReleaseEntity. # noqa: E501
:type: str
@@ -438,6 +448,7 @@ class ReleaseEntity(object):
def volume(self):
"""Gets the volume of this ReleaseEntity. # noqa: E501
+ Volume number of container that this release was published in. Often corresponds to the \"Nth\" year of publication, but can be any string. See guide. # noqa: E501
:return: The volume of this ReleaseEntity. # noqa: E501
:rtype: str
@@ -448,6 +459,7 @@ class ReleaseEntity(object):
def volume(self, volume):
"""Sets the volume of this ReleaseEntity.
+ Volume number of container that this release was published in. Often corresponds to the \"Nth\" year of publication, but can be any string. See guide. # noqa: E501
:param volume: The volume of this ReleaseEntity. # noqa: E501
:type: str
@@ -459,6 +471,7 @@ class ReleaseEntity(object):
def ext_ids(self):
"""Gets the ext_ids of this ReleaseEntity. # noqa: E501
+ Set of external identifiers for this release. # noqa: E501
:return: The ext_ids of this ReleaseEntity. # noqa: E501
:rtype: ReleaseExtIds
@@ -469,6 +482,7 @@ class ReleaseEntity(object):
def ext_ids(self, ext_ids):
"""Sets the ext_ids of this ReleaseEntity.
+ Set of external identifiers for this release. # noqa: E501
:param ext_ids: The ext_ids of this ReleaseEntity. # noqa: E501
:type: ReleaseExtIds
@@ -482,6 +496,7 @@ class ReleaseEntity(object):
def withdrawn_year(self):
"""Gets the withdrawn_year of this ReleaseEntity. # noqa: E501
+ Year corresponding with `withdrawn_date` like `release_year`/`release_date`. # noqa: E501
:return: The withdrawn_year of this ReleaseEntity. # noqa: E501
:rtype: int
@@ -492,6 +507,7 @@ class ReleaseEntity(object):
def withdrawn_year(self, withdrawn_year):
"""Sets the withdrawn_year of this ReleaseEntity.
+ Year corresponding with `withdrawn_date` like `release_year`/`release_date`. # noqa: E501
:param withdrawn_year: The withdrawn_year of this ReleaseEntity. # noqa: E501
:type: int
@@ -503,6 +519,7 @@ class ReleaseEntity(object):
def withdrawn_date(self):
"""Gets the withdrawn_date of this ReleaseEntity. # noqa: E501
+ Full date when this release was formally withdrawn (if applicable). ISO format, like `release_date`. # noqa: E501
:return: The withdrawn_date of this ReleaseEntity. # noqa: E501
:rtype: date
@@ -513,6 +530,7 @@ class ReleaseEntity(object):
def withdrawn_date(self, withdrawn_date):
"""Sets the withdrawn_date of this ReleaseEntity.
+ Full date when this release was formally withdrawn (if applicable). ISO format, like `release_date`. # noqa: E501
:param withdrawn_date: The withdrawn_date of this ReleaseEntity. # noqa: E501
:type: date
@@ -524,6 +542,7 @@ class ReleaseEntity(object):
def withdrawn_status(self):
"""Gets the withdrawn_status of this ReleaseEntity. # noqa: E501
+ Type of withdrawl or retraction of this release, if applicable. If release has not been withdrawn, should be `null` (aka, not set, not the string \"null\" or an empty string). # noqa: E501
:return: The withdrawn_status of this ReleaseEntity. # noqa: E501
:rtype: str
@@ -534,6 +553,7 @@ class ReleaseEntity(object):
def withdrawn_status(self, withdrawn_status):
"""Sets the withdrawn_status of this ReleaseEntity.
+ Type of withdrawl or retraction of this release, if applicable. If release has not been withdrawn, should be `null` (aka, not set, not the string \"null\" or an empty string). # noqa: E501
:param withdrawn_status: The withdrawn_status of this ReleaseEntity. # noqa: E501
:type: str
@@ -545,6 +565,7 @@ class ReleaseEntity(object):
def release_year(self):
"""Gets the release_year of this ReleaseEntity. # noqa: E501
+ Year when this release was formally published. Must match `release_date` if that field is set; this field exists because sometimes only the year is known. # noqa: E501
:return: The release_year of this ReleaseEntity. # noqa: E501
:rtype: int
@@ -555,6 +576,7 @@ class ReleaseEntity(object):
def release_year(self, release_year):
"""Sets the release_year of this ReleaseEntity.
+ Year when this release was formally published. Must match `release_date` if that field is set; this field exists because sometimes only the year is known. # noqa: E501
:param release_year: The release_year of this ReleaseEntity. # noqa: E501
:type: int
@@ -566,6 +588,7 @@ class ReleaseEntity(object):
def release_date(self):
"""Gets the release_date of this ReleaseEntity. # noqa: E501
+ Full date when this release was formally published. ISO format, like `2019-03-05`. See guide for semantics. # noqa: E501
:return: The release_date of this ReleaseEntity. # noqa: E501
:rtype: date
@@ -576,6 +599,7 @@ class ReleaseEntity(object):
def release_date(self, release_date):
"""Sets the release_date of this ReleaseEntity.
+ Full date when this release was formally published. ISO format, like `2019-03-05`. See guide for semantics. # noqa: E501
:param release_date: The release_date of this ReleaseEntity. # noqa: E501
:type: date
@@ -587,6 +611,7 @@ class ReleaseEntity(object):
def release_stage(self):
"""Gets the release_stage of this ReleaseEntity. # noqa: E501
+ The stage of publication of this specific release. See guide for valid values and semantics. # noqa: E501
:return: The release_stage of this ReleaseEntity. # noqa: E501
:rtype: str
@@ -597,6 +622,7 @@ class ReleaseEntity(object):
def release_stage(self, release_stage):
"""Sets the release_stage of this ReleaseEntity.
+ The stage of publication of this specific release. See guide for valid values and semantics. # noqa: E501
:param release_stage: The release_stage of this ReleaseEntity. # noqa: E501
:type: str
@@ -608,6 +634,7 @@ class ReleaseEntity(object):
def release_type(self):
"""Gets the release_type of this ReleaseEntity. # noqa: E501
+ \"Type\" or \"medium\" that this release is published as. See guide for valid values. # noqa: E501
:return: The release_type of this ReleaseEntity. # noqa: E501
:rtype: str
@@ -618,6 +645,7 @@ class ReleaseEntity(object):
def release_type(self, release_type):
"""Sets the release_type of this ReleaseEntity.
+ \"Type\" or \"medium\" that this release is published as. See guide for valid values. # noqa: E501
:param release_type: The release_type of this ReleaseEntity. # noqa: E501
:type: str
@@ -629,6 +657,7 @@ class ReleaseEntity(object):
def container_id(self):
"""Gets the container_id of this ReleaseEntity. # noqa: E501
+ Used to link this release to a container entity that the release was published as part of. # noqa: E501
:return: The container_id of this ReleaseEntity. # noqa: E501
:rtype: str
@@ -639,6 +668,7 @@ class ReleaseEntity(object):
def container_id(self, container_id):
"""Sets the container_id of this ReleaseEntity.
+ Used to link this release to a container entity that the release was published as part of. # noqa: E501
:param container_id: The container_id of this ReleaseEntity. # noqa: E501
:type: str
@@ -650,7 +680,7 @@ class ReleaseEntity(object):
def webcaptures(self):
"""Gets the webcaptures of this ReleaseEntity. # noqa: E501
- Optional; GET-only # noqa: E501
+ Complete webcapture entities identified by `webcapture_ids` field. Only included in GET responses when `webcaptures` included in `expand` parameter; ignored in PUT or POST requests. # noqa: E501
:return: The webcaptures of this ReleaseEntity. # noqa: E501
:rtype: list[WebcaptureEntity]
@@ -661,7 +691,7 @@ class ReleaseEntity(object):
def webcaptures(self, webcaptures):
"""Sets the webcaptures of this ReleaseEntity.
- Optional; GET-only # noqa: E501
+ Complete webcapture entities identified by `webcapture_ids` field. Only included in GET responses when `webcaptures` included in `expand` parameter; ignored in PUT or POST requests. # noqa: E501
:param webcaptures: The webcaptures of this ReleaseEntity. # noqa: E501
:type: list[WebcaptureEntity]
@@ -673,7 +703,7 @@ class ReleaseEntity(object):
def filesets(self):
"""Gets the filesets of this ReleaseEntity. # noqa: E501
- Optional; GET-only # noqa: E501
+ Complete file entities identified by `filesets_ids` field. Only included in GET responses when `filesets` included in `expand` parameter; ignored in PUT or POST requests. # noqa: E501
:return: The filesets of this ReleaseEntity. # noqa: E501
:rtype: list[FilesetEntity]
@@ -684,7 +714,7 @@ class ReleaseEntity(object):
def filesets(self, filesets):
"""Sets the filesets of this ReleaseEntity.
- Optional; GET-only # noqa: E501
+ Complete file entities identified by `filesets_ids` field. Only included in GET responses when `filesets` included in `expand` parameter; ignored in PUT or POST requests. # noqa: E501
:param filesets: The filesets of this ReleaseEntity. # noqa: E501
:type: list[FilesetEntity]
@@ -696,7 +726,7 @@ class ReleaseEntity(object):
def files(self):
"""Gets the files of this ReleaseEntity. # noqa: E501
- Optional; GET-only # noqa: E501
+ Complete file entities identified by `file_ids` field. Only included in GET responses when `files` included in `expand` parameter; ignored in PUT or POST requests. # noqa: E501
:return: The files of this ReleaseEntity. # noqa: E501
:rtype: list[FileEntity]
@@ -707,7 +737,7 @@ class ReleaseEntity(object):
def files(self, files):
"""Sets the files of this ReleaseEntity.
- Optional; GET-only # noqa: E501
+ Complete file entities identified by `file_ids` field. Only included in GET responses when `files` included in `expand` parameter; ignored in PUT or POST requests. # noqa: E501
:param files: The files of this ReleaseEntity. # noqa: E501
:type: list[FileEntity]
@@ -719,7 +749,7 @@ class ReleaseEntity(object):
def container(self):
"""Gets the container of this ReleaseEntity. # noqa: E501
- Optional; GET-only # noqa: E501
+ Complete container entity identified by `container_id` field. Only included in GET reponses when `container` included in `expand` parameter; ignored in PUT or POST requests. # noqa: E501
:return: The container of this ReleaseEntity. # noqa: E501
:rtype: ContainerEntity
@@ -730,7 +760,7 @@ class ReleaseEntity(object):
def container(self, container):
"""Sets the container of this ReleaseEntity.
- Optional; GET-only # noqa: E501
+ Complete container entity identified by `container_id` field. Only included in GET reponses when `container` included in `expand` parameter; ignored in PUT or POST requests. # noqa: E501
:param container: The container of this ReleaseEntity. # noqa: E501
:type: ContainerEntity
@@ -742,6 +772,7 @@ class ReleaseEntity(object):
def work_id(self):
"""Gets the work_id of this ReleaseEntity. # noqa: E501
+ Identifier of work this release is part of. In creation (POST) requests, a work entity will be created automatically if this field is not set. # noqa: E501
:return: The work_id of this ReleaseEntity. # noqa: E501
:rtype: str
@@ -752,6 +783,7 @@ class ReleaseEntity(object):
def work_id(self, work_id):
"""Sets the work_id of this ReleaseEntity.
+ Identifier of work this release is part of. In creation (POST) requests, a work entity will be created automatically if this field is not set. # noqa: E501
:param work_id: The work_id of this ReleaseEntity. # noqa: E501
:type: str
@@ -763,7 +795,7 @@ class ReleaseEntity(object):
def original_title(self):
"""Gets the original_title of this ReleaseEntity. # noqa: E501
- Title in original language (or, the language of the full text of this release) # noqa: E501
+ Title in original language if `title` field has been translated. See guide for details. # noqa: E501
:return: The original_title of this ReleaseEntity. # noqa: E501
:rtype: str
@@ -774,7 +806,7 @@ class ReleaseEntity(object):
def original_title(self, original_title):
"""Sets the original_title of this ReleaseEntity.
- Title in original language (or, the language of the full text of this release) # noqa: E501
+ Title in original language if `title` field has been translated. See guide for details. # noqa: E501
:param original_title: The original_title of this ReleaseEntity. # noqa: E501
:type: str
@@ -786,7 +818,7 @@ class ReleaseEntity(object):
def subtitle(self):
"""Gets the subtitle of this ReleaseEntity. # noqa: E501
- Avoid this field if possible, and merge with title; usually English # noqa: E501
+ Subtitle of release. In many cases, better to merge with title than include as separate field (unless combined title would be very long). See guide for details. # noqa: E501
:return: The subtitle of this ReleaseEntity. # noqa: E501
:rtype: str
@@ -797,7 +829,7 @@ class ReleaseEntity(object):
def subtitle(self, subtitle):
"""Sets the subtitle of this ReleaseEntity.
- Avoid this field if possible, and merge with title; usually English # noqa: E501
+ Subtitle of release. In many cases, better to merge with title than include as separate field (unless combined title would be very long). See guide for details. # noqa: E501
:param subtitle: The subtitle of this ReleaseEntity. # noqa: E501
:type: str
@@ -809,7 +841,7 @@ class ReleaseEntity(object):
def title(self):
"""Gets the title of this ReleaseEntity. # noqa: E501
- Required for valid entities. The title used in citations and for display; usually English # noqa: E501
+ Required for valid entities. The title used in citations and for display. Sometimes the English translation of title e even if release content is not English. # noqa: E501
:return: The title of this ReleaseEntity. # noqa: E501
:rtype: str
@@ -820,7 +852,7 @@ class ReleaseEntity(object):
def title(self, title):
"""Sets the title of this ReleaseEntity.
- Required for valid entities. The title used in citations and for display; usually English # noqa: E501
+ Required for valid entities. The title used in citations and for display. Sometimes the English translation of title e even if release content is not English. # noqa: E501
:param title: The title of this ReleaseEntity. # noqa: E501
:type: str
@@ -946,6 +978,7 @@ class ReleaseEntity(object):
def extra(self):
"""Gets the extra of this ReleaseEntity. # 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 ReleaseEntity. # noqa: E501
:rtype: object
@@ -956,6 +989,7 @@ class ReleaseEntity(object):
def extra(self, extra):
"""Sets the extra of this ReleaseEntity.
+ 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 ReleaseEntity. # noqa: E501
:type: object
@@ -967,6 +1001,7 @@ class ReleaseEntity(object):
def edit_extra(self):
"""Gets the edit_extra of this ReleaseEntity. # 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 ReleaseEntity. # noqa: E501
:rtype: object
@@ -977,6 +1012,7 @@ class ReleaseEntity(object):
def edit_extra(self, edit_extra):
"""Sets the edit_extra of this ReleaseEntity.
+ 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 ReleaseEntity. # noqa: E501
:type: object
diff --git a/python_openapi_client/fatcat_openapi_client/models/release_ext_ids.py b/python_openapi_client/fatcat_openapi_client/models/release_ext_ids.py
index 7c6eb2dd..f4d8bd27 100644
--- a/python_openapi_client/fatcat_openapi_client/models/release_ext_ids.py
+++ b/python_openapi_client/fatcat_openapi_client/models/release_ext_ids.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
"""
@@ -96,6 +96,7 @@ class ReleaseExtIds(object):
def doi(self):
"""Gets the doi of this ReleaseExtIds. # noqa: E501
+ Digital Object Identifier (DOI), mostly for published papers and datasets. Should be registered and resolvable via https://doi.org/ # noqa: E501
:return: The doi of this ReleaseExtIds. # noqa: E501
:rtype: str
@@ -106,6 +107,7 @@ class ReleaseExtIds(object):
def doi(self, doi):
"""Sets the doi of this ReleaseExtIds.
+ Digital Object Identifier (DOI), mostly for published papers and datasets. Should be registered and resolvable via https://doi.org/ # noqa: E501
:param doi: The doi of this ReleaseExtIds. # noqa: E501
:type: str
@@ -117,6 +119,7 @@ class ReleaseExtIds(object):
def wikidata_qid(self):
"""Gets the wikidata_qid of this ReleaseExtIds. # noqa: E501
+ Wikidata entity QID # noqa: E501
:return: The wikidata_qid of this ReleaseExtIds. # noqa: E501
:rtype: str
@@ -127,6 +130,7 @@ class ReleaseExtIds(object):
def wikidata_qid(self, wikidata_qid):
"""Sets the wikidata_qid of this ReleaseExtIds.
+ Wikidata entity QID # noqa: E501
:param wikidata_qid: The wikidata_qid of this ReleaseExtIds. # noqa: E501
:type: str
@@ -138,6 +142,7 @@ class ReleaseExtIds(object):
def isbn13(self):
"""Gets the isbn13 of this ReleaseExtIds. # noqa: E501
+ ISBN-13, for books. Usually not set for chapters. ISBN-10 should be converted to ISBN-13. # noqa: E501
:return: The isbn13 of this ReleaseExtIds. # noqa: E501
:rtype: str
@@ -148,6 +153,7 @@ class ReleaseExtIds(object):
def isbn13(self, isbn13):
"""Sets the isbn13 of this ReleaseExtIds.
+ ISBN-13, for books. Usually not set for chapters. ISBN-10 should be converted to ISBN-13. # noqa: E501
:param isbn13: The isbn13 of this ReleaseExtIds. # noqa: E501
:type: str
@@ -159,6 +165,7 @@ class ReleaseExtIds(object):
def pmid(self):
"""Gets the pmid of this ReleaseExtIds. # noqa: E501
+ PubMed Identifier # noqa: E501
:return: The pmid of this ReleaseExtIds. # noqa: E501
:rtype: str
@@ -169,6 +176,7 @@ class ReleaseExtIds(object):
def pmid(self, pmid):
"""Sets the pmid of this ReleaseExtIds.
+ PubMed Identifier # noqa: E501
:param pmid: The pmid of this ReleaseExtIds. # noqa: E501
:type: str
@@ -180,6 +188,7 @@ class ReleaseExtIds(object):
def pmcid(self):
"""Gets the pmcid of this ReleaseExtIds. # noqa: E501
+ PubMed Central Identifier # noqa: E501
:return: The pmcid of this ReleaseExtIds. # noqa: E501
:rtype: str
@@ -190,6 +199,7 @@ class ReleaseExtIds(object):
def pmcid(self, pmcid):
"""Sets the pmcid of this ReleaseExtIds.
+ PubMed Central Identifier # noqa: E501
:param pmcid: The pmcid of this ReleaseExtIds. # noqa: E501
:type: str
@@ -201,6 +211,7 @@ class ReleaseExtIds(object):
def core(self):
"""Gets the core of this ReleaseExtIds. # noqa: E501
+ CORE (https://core.ac.uk) identifier # noqa: E501
:return: The core of this ReleaseExtIds. # noqa: E501
:rtype: str
@@ -211,6 +222,7 @@ class ReleaseExtIds(object):
def core(self, core):
"""Sets the core of this ReleaseExtIds.
+ CORE (https://core.ac.uk) identifier # noqa: E501
:param core: The core of this ReleaseExtIds. # noqa: E501
:type: str
@@ -222,6 +234,7 @@ class ReleaseExtIds(object):
def arxiv(self):
"""Gets the arxiv of this ReleaseExtIds. # noqa: E501
+ arXiv (https://arxiv.org) identifier; must include version # noqa: E501
:return: The arxiv of this ReleaseExtIds. # noqa: E501
:rtype: str
@@ -232,6 +245,7 @@ class ReleaseExtIds(object):
def arxiv(self, arxiv):
"""Sets the arxiv of this ReleaseExtIds.
+ arXiv (https://arxiv.org) identifier; must include version # noqa: E501
:param arxiv: The arxiv of this ReleaseExtIds. # noqa: E501
:type: str
@@ -243,6 +257,7 @@ class ReleaseExtIds(object):
def jstor(self):
"""Gets the jstor of this ReleaseExtIds. # noqa: E501
+ JSTOR work identifier # noqa: E501
:return: The jstor of this ReleaseExtIds. # noqa: E501
:rtype: str
@@ -253,6 +268,7 @@ class ReleaseExtIds(object):
def jstor(self, jstor):
"""Sets the jstor of this ReleaseExtIds.
+ JSTOR work identifier # noqa: E501
:param jstor: The jstor of this ReleaseExtIds. # noqa: E501
:type: str
@@ -264,6 +280,7 @@ class ReleaseExtIds(object):
def ark(self):
"""Gets the ark of this ReleaseExtIds. # noqa: E501
+ ARK identifier # noqa: E501
:return: The ark of this ReleaseExtIds. # noqa: E501
:rtype: str
@@ -274,6 +291,7 @@ class ReleaseExtIds(object):
def ark(self, ark):
"""Sets the ark of this ReleaseExtIds.
+ ARK identifier # noqa: E501
:param ark: The ark of this ReleaseExtIds. # noqa: E501
:type: str
@@ -285,6 +303,7 @@ class ReleaseExtIds(object):
def mag(self):
"""Gets the mag of this ReleaseExtIds. # noqa: E501
+ Microsoft Academic Graph identifier # noqa: E501
:return: The mag of this ReleaseExtIds. # noqa: E501
:rtype: str
@@ -295,6 +314,7 @@ class ReleaseExtIds(object):
def mag(self, mag):
"""Sets the mag of this ReleaseExtIds.
+ Microsoft Academic Graph identifier # noqa: E501
:param mag: The mag of this ReleaseExtIds. # noqa: E501
:type: str
diff --git a/python_openapi_client/fatcat_openapi_client/models/release_ref.py b/python_openapi_client/fatcat_openapi_client/models/release_ref.py
index ed44158b..19b55990 100644
--- a/python_openapi_client/fatcat_openapi_client/models/release_ref.py
+++ b/python_openapi_client/fatcat_openapi_client/models/release_ref.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
"""
@@ -86,6 +86,7 @@ class ReleaseRef(object):
def index(self):
"""Gets the index of this ReleaseRef. # noqa: E501
+ Zero-indexed sequence number of this reference in the list of references. Assigned automatically and used internally; don't confuse with `key`. # noqa: E501
:return: The index of this ReleaseRef. # noqa: E501
:rtype: int
@@ -96,6 +97,7 @@ class ReleaseRef(object):
def index(self, index):
"""Sets the index of this ReleaseRef.
+ Zero-indexed sequence number of this reference in the list of references. Assigned automatically and used internally; don't confuse with `key`. # noqa: E501
:param index: The index of this ReleaseRef. # noqa: E501
:type: int
@@ -107,7 +109,7 @@ class ReleaseRef(object):
def target_release_id(self):
"""Gets the target_release_id of this ReleaseRef. # noqa: E501
- base32-encoded unique identifier # noqa: E501
+ Optional, fatcat identifier of release entity that this reference is citing. # noqa: E501
:return: The target_release_id of this ReleaseRef. # noqa: E501
:rtype: str
@@ -118,7 +120,7 @@ class ReleaseRef(object):
def target_release_id(self, target_release_id):
"""Sets the target_release_id of this ReleaseRef.
- base32-encoded unique identifier # noqa: E501
+ Optional, fatcat identifier of release entity that this reference is citing. # noqa: E501
:param target_release_id: The target_release_id of this ReleaseRef. # noqa: E501
:type: str
@@ -136,6 +138,7 @@ class ReleaseRef(object):
def extra(self):
"""Gets the extra of this ReleaseRef. # noqa: E501
+ Additional free-form JSON metadata about this citation. Generally follows Citation Style Language (CSL) JSON schema. See guide for details. # noqa: E501
:return: The extra of this ReleaseRef. # noqa: E501
:rtype: object
@@ -146,6 +149,7 @@ class ReleaseRef(object):
def extra(self, extra):
"""Sets the extra of this ReleaseRef.
+ Additional free-form JSON metadata about this citation. Generally follows Citation Style Language (CSL) JSON schema. See guide for details. # noqa: E501
:param extra: The extra of this ReleaseRef. # noqa: E501
:type: object
@@ -157,6 +161,7 @@ class ReleaseRef(object):
def key(self):
"""Gets the key of this ReleaseRef. # noqa: E501
+ Short string used to indicate this reference from within the release text; or numbering of references as typeset in the release itself. Optional; don't confuse with `index` field. # noqa: E501
:return: The key of this ReleaseRef. # noqa: E501
:rtype: str
@@ -167,6 +172,7 @@ class ReleaseRef(object):
def key(self, key):
"""Sets the key of this ReleaseRef.
+ Short string used to indicate this reference from within the release text; or numbering of references as typeset in the release itself. Optional; don't confuse with `index` field. # noqa: E501
:param key: The key of this ReleaseRef. # noqa: E501
:type: str
@@ -178,6 +184,7 @@ class ReleaseRef(object):
def year(self):
"""Gets the year of this ReleaseRef. # noqa: E501
+ Year that the cited work was published in. # noqa: E501
:return: The year of this ReleaseRef. # noqa: E501
:rtype: int
@@ -188,6 +195,7 @@ class ReleaseRef(object):
def year(self, year):
"""Sets the year of this ReleaseRef.
+ Year that the cited work was published in. # noqa: E501
:param year: The year of this ReleaseRef. # noqa: E501
:type: int
@@ -199,6 +207,7 @@ class ReleaseRef(object):
def container_name(self):
"""Gets the container_name of this ReleaseRef. # noqa: E501
+ Name of the container (eg, journal) that the citation work was published as part of. May be an acronym or full name. # noqa: E501
:return: The container_name of this ReleaseRef. # noqa: E501
:rtype: str
@@ -209,6 +218,7 @@ class ReleaseRef(object):
def container_name(self, container_name):
"""Sets the container_name of this ReleaseRef.
+ Name of the container (eg, journal) that the citation work was published as part of. May be an acronym or full name. # noqa: E501
:param container_name: The container_name of this ReleaseRef. # noqa: E501
:type: str
@@ -220,6 +230,7 @@ class ReleaseRef(object):
def title(self):
"""Gets the title of this ReleaseRef. # noqa: E501
+ Name of the work being cited. # noqa: E501
:return: The title of this ReleaseRef. # noqa: E501
:rtype: str
@@ -230,6 +241,7 @@ class ReleaseRef(object):
def title(self, title):
"""Sets the title of this ReleaseRef.
+ Name of the work being cited. # noqa: E501
:param title: The title of this ReleaseRef. # noqa: E501
:type: str
@@ -241,6 +253,7 @@ class ReleaseRef(object):
def locator(self):
"""Gets the locator of this ReleaseRef. # noqa: E501
+ Page number or other indicator of the specific subset of a work being cited. Not to be confused with the first page (or page range) of an entire paper or chapter being cited. # noqa: E501
:return: The locator of this ReleaseRef. # noqa: E501
:rtype: str
@@ -251,6 +264,7 @@ class ReleaseRef(object):
def locator(self, locator):
"""Sets the locator of this ReleaseRef.
+ Page number or other indicator of the specific subset of a work being cited. Not to be confused with the first page (or page range) of an entire paper or chapter being cited. # noqa: E501
:param locator: The locator of this ReleaseRef. # noqa: E501
:type: str
diff --git a/python_openapi_client/fatcat_openapi_client/models/success.py b/python_openapi_client/fatcat_openapi_client/models/success.py
index 337efebb..f5893fef 100644
--- a/python_openapi_client/fatcat_openapi_client/models/success.py
+++ b/python_openapi_client/fatcat_openapi_client/models/success.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
"""
diff --git a/python_openapi_client/fatcat_openapi_client/models/webcapture_auto_batch.py b/python_openapi_client/fatcat_openapi_client/models/webcapture_auto_batch.py
index cc968f8b..b1d19ac1 100644
--- a/python_openapi_client/fatcat_openapi_client/models/webcapture_auto_batch.py
+++ b/python_openapi_client/fatcat_openapi_client/models/webcapture_auto_batch.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
"""
diff --git a/python_openapi_client/fatcat_openapi_client/models/webcapture_cdx_line.py b/python_openapi_client/fatcat_openapi_client/models/webcapture_cdx_line.py
index 623607ba..0b2bb818 100644
--- a/python_openapi_client/fatcat_openapi_client/models/webcapture_cdx_line.py
+++ b/python_openapi_client/fatcat_openapi_client/models/webcapture_cdx_line.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
"""
@@ -82,6 +82,7 @@ class WebcaptureCdxLine(object):
def surt(self):
"""Gets the surt of this WebcaptureCdxLine. # noqa: E501
+ \"Sortable URL\" format. See guide for details. # noqa: E501
:return: The surt of this WebcaptureCdxLine. # noqa: E501
:rtype: str
@@ -92,6 +93,7 @@ class WebcaptureCdxLine(object):
def surt(self, surt):
"""Sets the surt of this WebcaptureCdxLine.
+ \"Sortable URL\" format. See guide for details. # noqa: E501
:param surt: The surt of this WebcaptureCdxLine. # noqa: E501
:type: str
@@ -105,7 +107,7 @@ class WebcaptureCdxLine(object):
def timestamp(self):
"""Gets the timestamp of this WebcaptureCdxLine. # noqa: E501
- UTC, 'Z'-terminated, second (or better) precision # noqa: E501
+ Date and time of capture, in ISO format. UTC, 'Z'-terminated, second (or better) precision. # noqa: E501
:return: The timestamp of this WebcaptureCdxLine. # noqa: E501
:rtype: datetime
@@ -116,7 +118,7 @@ class WebcaptureCdxLine(object):
def timestamp(self, timestamp):
"""Sets the timestamp of this WebcaptureCdxLine.
- UTC, 'Z'-terminated, second (or better) precision # noqa: E501
+ Date and time of capture, in ISO format. UTC, 'Z'-terminated, second (or better) precision. # noqa: E501
:param timestamp: The timestamp of this WebcaptureCdxLine. # noqa: E501
:type: datetime
@@ -130,6 +132,7 @@ class WebcaptureCdxLine(object):
def url(self):
"""Gets the url of this WebcaptureCdxLine. # noqa: E501
+ Full URL/URI of resource captured. # noqa: E501
:return: The url of this WebcaptureCdxLine. # noqa: E501
:rtype: str
@@ -140,6 +143,7 @@ class WebcaptureCdxLine(object):
def url(self, url):
"""Sets the url of this WebcaptureCdxLine.
+ Full URL/URI of resource captured. # noqa: E501
:param url: The url of this WebcaptureCdxLine. # noqa: E501
:type: str
@@ -153,6 +157,7 @@ class WebcaptureCdxLine(object):
def mimetype(self):
"""Gets the mimetype of this WebcaptureCdxLine. # noqa: E501
+ Mimetype of the resource at this URL. May be the Content-Type header, or the actually sniffed file type. # noqa: E501
:return: The mimetype of this WebcaptureCdxLine. # noqa: E501
:rtype: str
@@ -163,6 +168,7 @@ class WebcaptureCdxLine(object):
def mimetype(self, mimetype):
"""Sets the mimetype of this WebcaptureCdxLine.
+ Mimetype of the resource at this URL. May be the Content-Type header, or the actually sniffed file type. # noqa: E501
:param mimetype: The mimetype of this WebcaptureCdxLine. # noqa: E501
:type: str
@@ -174,6 +180,7 @@ class WebcaptureCdxLine(object):
def status_code(self):
"""Gets the status_code of this WebcaptureCdxLine. # noqa: E501
+ HTTP status code. Should generally be 200, especially for the primary resource, but may be 3xx (redirect) or even error codes if embedded resources can not be fetched successfully. # noqa: E501
:return: The status_code of this WebcaptureCdxLine. # noqa: E501
:rtype: int
@@ -184,6 +191,7 @@ class WebcaptureCdxLine(object):
def status_code(self, status_code):
"""Sets the status_code of this WebcaptureCdxLine.
+ HTTP status code. Should generally be 200, especially for the primary resource, but may be 3xx (redirect) or even error codes if embedded resources can not be fetched successfully. # noqa: E501
:param status_code: The status_code of this WebcaptureCdxLine. # noqa: E501
:type: int
@@ -195,6 +203,7 @@ class WebcaptureCdxLine(object):
def size(self):
"""Gets the size of this WebcaptureCdxLine. # noqa: E501
+ Resource (file) size in bytes # noqa: E501
:return: The size of this WebcaptureCdxLine. # noqa: E501
:rtype: int
@@ -205,6 +214,7 @@ class WebcaptureCdxLine(object):
def size(self, size):
"""Sets the size of this WebcaptureCdxLine.
+ Resource (file) size in bytes # noqa: E501
:param size: The size of this WebcaptureCdxLine. # noqa: E501
:type: int
@@ -216,6 +226,7 @@ class WebcaptureCdxLine(object):
def sha1(self):
"""Gets the sha1 of this WebcaptureCdxLine. # noqa: E501
+ SHA-1 hash of data, in hex encoding # noqa: E501
:return: The sha1 of this WebcaptureCdxLine. # noqa: E501
:rtype: str
@@ -226,6 +237,7 @@ class WebcaptureCdxLine(object):
def sha1(self, sha1):
"""Sets the sha1 of this WebcaptureCdxLine.
+ SHA-1 hash of data, in hex encoding # noqa: E501
:param sha1: The sha1 of this WebcaptureCdxLine. # noqa: E501
:type: str
@@ -245,6 +257,7 @@ class WebcaptureCdxLine(object):
def sha256(self):
"""Gets the sha256 of this WebcaptureCdxLine. # noqa: E501
+ SHA-256 hash of data, in hex encoding # noqa: E501
:return: The sha256 of this WebcaptureCdxLine. # noqa: E501
:rtype: str
@@ -255,6 +268,7 @@ class WebcaptureCdxLine(object):
def sha256(self, sha256):
"""Sets the sha256 of this WebcaptureCdxLine.
+ SHA-256 hash of data, in hex encoding # noqa: E501
:param sha256: The sha256 of this WebcaptureCdxLine. # noqa: E501
:type: str
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
diff --git a/python_openapi_client/fatcat_openapi_client/models/webcapture_url.py b/python_openapi_client/fatcat_openapi_client/models/webcapture_url.py
index 9d6f1e21..89a3fbc2 100644
--- a/python_openapi_client/fatcat_openapi_client/models/webcapture_url.py
+++ b/python_openapi_client/fatcat_openapi_client/models/webcapture_url.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
"""
@@ -54,6 +54,7 @@ class WebcaptureUrl(object):
def url(self):
"""Gets the url of this WebcaptureUrl. # noqa: E501
+ URL/URI pointing to archive of this web resource. # noqa: E501
:return: The url of this WebcaptureUrl. # noqa: E501
:rtype: str
@@ -64,6 +65,7 @@ class WebcaptureUrl(object):
def url(self, url):
"""Sets the url of this WebcaptureUrl.
+ URL/URI pointing to archive of this web resource. # noqa: E501
:param url: The url of this WebcaptureUrl. # noqa: E501
:type: str
@@ -77,6 +79,7 @@ class WebcaptureUrl(object):
def rel(self):
"""Gets the rel of this WebcaptureUrl. # noqa: E501
+ Type of archive endpoint. Usually `wayback` (WBM replay of primary resource), or `warc` (direct URL to a WARC file containing all resources of the capture). See guide for full list. # noqa: E501
:return: The rel of this WebcaptureUrl. # noqa: E501
:rtype: str
@@ -87,6 +90,7 @@ class WebcaptureUrl(object):
def rel(self, rel):
"""Sets the rel of this WebcaptureUrl.
+ Type of archive endpoint. Usually `wayback` (WBM replay of primary resource), or `warc` (direct URL to a WARC file containing all resources of the capture). See guide for full list. # noqa: E501
:param rel: The rel of this WebcaptureUrl. # noqa: E501
:type: str
diff --git a/python_openapi_client/fatcat_openapi_client/models/work_auto_batch.py b/python_openapi_client/fatcat_openapi_client/models/work_auto_batch.py
index 76a8ae1e..b404e1b9 100644
--- a/python_openapi_client/fatcat_openapi_client/models/work_auto_batch.py
+++ b/python_openapi_client/fatcat_openapi_client/models/work_auto_batch.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
"""
diff --git a/python_openapi_client/fatcat_openapi_client/models/work_entity.py b/python_openapi_client/fatcat_openapi_client/models/work_entity.py
index 80cb2330..cddb19da 100644
--- a/python_openapi_client/fatcat_openapi_client/models/work_entity.py
+++ b/python_openapi_client/fatcat_openapi_client/models/work_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
"""
@@ -76,6 +76,7 @@ class WorkEntity(object):
def edit_extra(self):
"""Gets the edit_extra of this WorkEntity. # 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 WorkEntity. # noqa: E501
:rtype: object
@@ -86,6 +87,7 @@ class WorkEntity(object):
def edit_extra(self, edit_extra):
"""Sets the edit_extra of this WorkEntity.
+ 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 WorkEntity. # noqa: E501
:type: object
@@ -97,6 +99,7 @@ class WorkEntity(object):
def extra(self):
"""Gets the extra of this WorkEntity. # 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 WorkEntity. # noqa: E501
:rtype: object
@@ -107,6 +110,7 @@ class WorkEntity(object):
def extra(self, extra):
"""Sets the extra of this WorkEntity.
+ 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 WorkEntity. # noqa: E501
:type: object