module documentation

Jira resource definitions. This module implements the Resource classes that translate JSON from Jira REST resources into usable objects.

Class AgileResource A generic Agile resource. Also known as Jira Agile Server, Jira Software and formerly GreenHopper.
Class Attachment An issue attachment.
Class Board An Agile board.
Class Component A project component.
Class Customer A Service Desk customer.
Class CustomFieldOption An existing option for a custom issue field.
Class Dashboard A Jira dashboard.
Class Filter An issue navigator filter.
Class Group A Jira user group.
Class IssueLink Link between two issues.
Class IssueLinkType Type of link between two issues.
Class IssueProperty Custom data against an issue.
Class IssueSecurityLevelScheme IssueSecurityLevelScheme information on a project.
Class IssueType Type of issue.
Class IssueTypeScheme An issue type scheme.
Class NotificationScheme NotificationScheme information on a project.
Class PermissionScheme Permissionscheme information on a project.
Class PriorityScheme PriorityScheme information on a project.
Class PropertyHolder An object for storing named attributes.
Class RemoteLink A link to a remote application from an issue.
Class RequestType A Service Desk Request Type.
Class Resolution A resolution for an issue.
Class Resource Models a URL-addressable resource in the Jira REST API.
Class SecurityLevel A security level for an issue or project.
Class ServiceDesk A Service Desk.
Class Sprint An Agile sprint.
Class Status Status for an issue.
Class StatusCategory StatusCategory for an issue.
Class TimeTracking Undocumented
Class UnknownResource A Resource from Jira that is not (yet) supported.
Class Version A version of a project.
Class Votes Vote information on an issue.
Class WorkflowScheme WorkflowScheme information on a project.
Function cls_for_resource Undocumented
Function dict2resource Convert a dictionary into a Jira Resource object.
Variable resource_class_map Undocumented
def cls_for_resource(resource_literal: str) -> Type[Resource]: (source)

Undocumented

def dict2resource(raw: Dict[str, Any], top=None, options=None, session=None) -> Union[PropertyHolder, Type[Resource]]: (source)

Convert a dictionary into a Jira Resource object. Recursively walks a dict structure, transforming the properties into attributes on a new ``Resource`` object of the appropriate type (if a ``self`` link is present) or a ``PropertyHolder`` object (if no ``self`` link is present).

resource_class_map: Dict[str, Type[Resource]] = (source)

Undocumented