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