PUT /issue: API Documentation

I don't know if this should be in the bug tracker, or where but the API documentation is very confusing.  Specifically, with Creating a new issue (http://confluence.jetbrains.net/display/YTD4/Create+New+Issue).

The "signature" is:

PUT /rest/issue?{project}&{summary}&{description}&{attachments}&{permittedGroup}

All of the parameters are labeled as "string" except for attachement, which is labeled "file".

What does that mean?  I can't imagine that a file is supposed to be BASE64 encoded and sent as a query parameter.  I looked at the Python library to see if maybe the attachment was being sent in the body.  As far as I can tell from https://github.com/JetBrains/youtrack-rest-python-library/blob/master/python/youtrack/connection.py#L80 it isn't.  In fact, it doesn't even seem as though the Python library deals with "attachments" in createIssue.  On top of that, the createIssue methods includes a bunch of other fields in the URL.

So, is the documentation incomplete?  Is it wrong? Does one add "attachments" when creating an issue?  Or does one simply create the issue and then use http://confluence.jetbrains.net/display/YTD4/Attach+File+to+an+Issue to add the attachment?
1 comment
Comment actions Permalink
Hello, John!
You should upload file  using multipart/form-data encoding. You can
read about its implementation in java f.e. here:
http://stackoverflow.com/questions/2793150/how-to-use-java-net-urlconnection-to-fire-and-handle-http-requests/2793153#2793153
What about other fields used in Python library, but not described in documentation - use of this fields is currently deprecated.
0

Please sign in to leave a comment.