Skip to content

Inconsistencies in the "IssueType" class #206

@aik099

Description

@aik099

Short story

You'll get an exception about unsupported issue type properties when attempting to use the Api::getIssueTypes method.

Long story

Here is the current state of IssueType class implementation compared to Jira Cloud REST API documentation:

Property Atlassian Documented This Library Supported
avatarId Yes Yes
description Yes Yes
entityId Yes No
hierarchyLevel Yes No
iconUrl Yes Yes
id Yes Yes
name Yes Yes
scope Yes Partial
self Yes Partial
subtask Yes Yes
untranslatedName No No

An exception will occur when creating an instance of the IssueType class by providing any unsupported property (entityId, hierarchyLevel and untranslatedName).

The partially supported properties (scope and self) have no getter method and therefore can't be read from an IssueType class object.

Also, the IssueTypeTest and ApiTest tests don't provide full coverage related to issue type handling.

P.S.
I'm planning to create a PR, that addresses above mentioned problems.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions