jira.resources.Version

class documentation

class Version(Resource): (source)

View In Hierarchy

A version of a project.

Method __init__ Initializes a generic resource.
Method delete Delete this project version from the server.
Method update Update this project version from the server. It is prior used to archive versions.
Instance Variable raw Undocumented

Inherited from Resource:

Method __eq__ Default equality test.
Method __getattr__ Allow access of attributes via names.
Method __getstate__ Pickling the resource.
Method __hash__ Hash calculation.
Method __repr__ Identify the class and include any and all relevant values.
Method __setstate__ Unpickling of the resource.
Method __str__ Return the first value we find that is likely to be human-readable.
Method find Finds a resource based on the input parameters.
Constant JIRA_BASE_URL Undocumented
Method _default_headers Undocumented
Method _find_by_url Finds a resource on the specified url.
Method _get_url Gets the url for the specified path.
Method _load Load a resource.
Method _parse_raw Parse a raw dictionary to create a resource.
Constant _HASH_IDS Undocumented
Constant _READABLE_IDS Undocumented
Instance Variable _base_url Undocumented
Instance Variable _options Undocumented
Instance Variable _resource Undocumented
Instance Variable _session Undocumented
def __init__(self, options: Dict[str, str], session: ResilientSession, raw: Dict[str, Any] = None): (source)
overrides jira.resources.Resource.__init__

Initializes a generic resource. Args: resource (str): The name of the resource. options (Dict[str,str]): Options for the new resource session (ResilientSession): Session used for the resource. base_url (Optional[str]): The Base Jira url.

def delete(self, moveFixIssuesTo=None, moveAffectedIssuesTo=None): (source)
overrides jira.resources.Resource.delete

Delete this project version from the server. If neither of the arguments are specified, the version is removed from all issues it is attached to. Args: moveFixIssuesTo: in issues for which this version is a fix version, add this version to the fix version list moveAffectedIssuesTo: in issues for which this version is an affected version, add this version to the affected version list

def update(self, **kwargs): (source)
overrides jira.resources.Resource.update

Update this project version from the server. It is prior used to archive versions. Refer to Atlassian REST API `documentation`_. .. _documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-project-versions/#api-rest-api-2-version-id-put :Example: .. code-block:: python >> version_id = "10543" >> version = JIRA("https://atlassian.org").version(version_id) >> print(version.name) "some_version_name" >> version.update(name="another_name") >> print(version.name) "another_name" >> version.update(archived=True) >> print(version.archived) True

raw: Dict[str, Any] = (source)
overrides jira.resources.Resource.raw

Undocumented