aboutsummaryrefslogtreecommitdiffstats
path: root/python_openapi_client/fatcat_openapi_client/models/release_ref.py
diff options
context:
space:
mode:
Diffstat (limited to 'python_openapi_client/fatcat_openapi_client/models/release_ref.py')
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/release_ref.py22
1 files changed, 18 insertions, 4 deletions
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