Forums

Articles
Create
cancel
Showing results for 
Search instead for 
Did you mean: 

jira-python documentation / implementation misleading

Chris Graf
I'm New Here
I'm New Here
Those new to the Atlassian Community have posted less than three times. Give them a warm welcome!
May 10, 2019

Hello,

the documentation of createmeta(projectKeys=NoneprojectIds=[]issuetypeIds=NoneissuetypeNames=Noneexpand=None) (see https://jira.readthedocs.io/en/master/api.html) is misleading in my opinion.

The parameter issuetypeNames is described as:

(Optional[str]) – Names of the issue types to filter the results with. Can be a single value or a comma-delimited string. May be combined with issuetypeIds.

That seems not to be the case, I can only provide exactly one value issuetypeNames (e.g., "Bug"). Lists are not allowed (however, this is also not stated in the description). But, a comma-delimited string is also not allowed (e.g., issuetypeNames="Bug, Incident"), even though it is mentioned in the description.

The official JIRA API also states that this is not possible:

combinded with issuetypeIds, lists the issue types with which to filter the results. If null, all issue types are returned. This parameter can be specified multiple times, but is NOT interpreted as a comma-separated list. Specifiying an issue type that does not exist is not an error.

see: https://docs.atlassian.com/software/jira/docs/api/REST/8.1.0/?_ga=2.103331465.847026257.1557491763-596257740.1548408320#api/2/issue-getCreateIssueMeta

 

So is there a possibility to add multiple issuetypeNames in jira-python without using issuetypeIds?

1 answer

0 votes
Gonchik Tsymzhitov
Community Champion
May 22, 2019

Hi! 

Feel free to provide a pull request for fix your request

https://github.com/atlassian-api/atlassian-python-api

Suggest an answer

Log in or Sign up to answer
TAGS
AUG Leaders

Atlassian Community Events