any way to upload files to an existing github issue by REST API

[vincezh0205]

Select Topic Area

Question

Body

I tried to add one comment with file attached to an existing github issue by calling github REST API in Python code. But I have no idea how to do this. I could only add some plain txt into as a new comment. Here is my existing code for adding a plain txt comment into an issue. Anyone could help me to figure out how to upload files into a comment. Thanks a lot

url = "https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/comments".format(owner="", repo="", issue_number='')

headers = {
    "Authorization": "token XXX",
    "Accept": "application/vnd.github+json",
}

response = requests.post(url, headers=headers, data=json.dumps({'comment': 'test'}))

if response.status_code == 201:
    print("File attached successfully")
else:
    print("Failed to attach file. Response status code:", response.status_code)

[jge162]

Hello @vincezh0205 here is some pseudo code. Give it a try but you will have to verify if I works or not for your use case. As I cannot.

import requests
import json

url = "https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/comments".format(owner="", repo="", issue_number='')

headers = {
    "Authorization": "token XXX",
    "Accept": "application/vnd.github+json",
    "Content-Type": "application/octet-stream",
}

file = open("path/to/file.ext", "rb")

response = requests.post(url, headers=headers, data=file)

if response.status_code == 201:
    print("File attached successfully")
else:
    print("Failed to attach file. Response status code:", response.status_code)

[vincezh0205]

I did a try on this method. But It's failed with error code 400.

[Travisnarkle79]

#47103

[franke-biosaxs]

Could you please be more specific about where this number applies? Educated guess says that it is an Issue ID - what of and which? Looking for this number in "Issues" does not exactly help. Thanks.

[franke-biosaxs]

I have the same question. I would like to migrate 2000+ PRs from bugzilla to GitHub Issues. I managed to export the PRs to XML and found the GitHub Issues REST API v2022-11-28. Based on this I should be able to create new issues and comments from the XML. But how do I add attachments? Is it possible at all?

@vincezh0205 any insights from your recent attempts? Thanks.

[joseberlines]

Quite old thread here. I am in the same situation.
using the @jge162 code I get a 401 status code of the response and the image is not attached.

example.png was read with rb and
I get this type of data <class '_io.BufferedReader'>

https://api.github.com/repos/...../issues/1/comments
Failed to attach file. Response status code: 401

[jge162]

Looks like a credential issue not syntax.

[jge162]

Double check your credentials are correct.

[joseberlines]

actually they were. sorry. I report immediately once that is solved.

[joseberlines]

Here is the whole code modified to truly check that the credentials are ok:

issue_number = 1
url = f"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/comments"

# adding normal comment to test taht token works
# headers normal
headers_normal = {
    'Authorization': f'token {access_token}',
    'Accept': 'application/vnd.github.v3+json'}
comment_body=str(datetime.now().strftime("%H:%M:%S"))
print(f"Text of the comment added: {comment_body}")
response = requests.post(url, headers=headers, json={'body': comment_body})
print(f"Adding a text comment: {response.status_code == 201}")

# adding image

# headers file
headers_file = {
    "Authorization": f"token {access_token}",
    "Accept": "application/vnd.github.v3+json",
    "Content-Type": "application/octet-stream", }# this is the difference with the text
file_name = "example.png"
file = open(file_name, "rb")
print(f"{file_name} was read with rb and\nI get this type of data {type(file)}")

response = requests.post(url, headers=headers_file, data=file)

if response.status_code == 201:
    print("File attached successfully")
else:
    print("Failed to attach file. Response status code:", response.status_code)

This gives now response 400, Bad request.
The first comment is added, i.e. the text
but not the second one which is a png file

[jge162]

response = requests.post(url, headers=headers, data=file_data, params={'name': file_name})

[joseberlines]

So this is the result:
basically a link is created but it leads nowhere.

[joseberlines]

with the last try:

file_data = open(file_name, "rb") response = requests.post(url, headers=headers, data=file_data, params={'name': file_name})
also 400

I am aso trying different combinations.
INcluding chatgpt (which gives only false answers in this regard)

I am starting to think that this is not possible, which makes like impossible to truly migrate a bitbucket project with 1000s of JIRA issues when include pics.

[jge162]

Yeah shouldn’t be this hard. Has to be a platform compatibility issue between GitHub API sending pics through the different platforms. Maybe consider reaching out to GitHub support to confirm.

[joseberlines]

Thanks a lot anyway

[franke-biosaxs]

I am starting to think that this is not possible, which makes like impossible to truly migrate a bitbucket project with 1000s of JIRA issues when include pics.

I recently managed to import some 2000 bugzilla reports via:

#    https://gist.github.com/jonmagic/5282384165e0f86ef105
# This is NOT the official REST API - that has the issue of
# not being able to control the creation and update times.

Instead of attaching files via Rest API, I created a repository of attachments, stored by bugzilla ID (attachments/attachment-N, N=1,...) and converted attachment links in reports to URLs in this repository via their ID. This has the added advantage of not being limited to GitHub allowed file types/extensions.

[inoa-vcmachado]

I did not get how do you manage to

converted attachment links in reports to URLs

Can you explain it?

[franke-biosaxs]

The exported XML from bugzilla contained (a) the standard text "attachment ${N}" and (b) an "attachid". I looked for the latter and replaced the former with the link to the files my own repository. Here's the anonymised snippet I used:

    [read the bugzilla XML into 'bug']

    comments = []
    for comment in bug.findall("long_desc"):
      who = comment.find("who")
      text = "{0} <{1}> wrote:\n\n".format(who.attrib["name"], who.text)
      text += comment.findtext("thetext")
      attachid = comment.findtext("attachid")
      if attachid:
        text = text.replace("attachment {0}".format(attachid), 
                            "[attachment {0}](https://github.com/owner/repository/tree/main/attachments/attachment-{0})".format(attachid))
      comments.append({
        "created_at" : datetime.strptime(comment.findtext("bug_when"), '%Y-%m-%d %H:%M:%S %z').isoformat(),
        "body" : text
      })

    [snip unrelated]

    body = {
      "issue" : {
         "title"      : bug.findtext("short_desc"),
         "closed_at"  : datetime.strptime(bug.findtext("delta_ts"), '%Y-%m-%d %H:%M:%S %z').isoformat(),
         "updated_at" : datetime.strptime(bug.findtext("delta_ts"), '%Y-%m-%d %H:%M:%S %z').isoformat(),
         "assignee"   : None,
         "closed"     : bug.findtext("bug_status") == "RESOLVED" or bug.findtext("bug_status") == "CLOSED",
         "labels"     : labels,
      } | comments[0],
      "comments" : comments[1:],
    }

HTH.

[github-actions[bot]]

🕒 Discussion Activity Reminder 🕒

This Discussion has been labeled as dormant by an automated system for having no activity in the last 60 days. Please consider one the following actions:

1️⃣ Close as Out of Date: If the topic is no longer relevant, close the Discussion as out of date at the bottom of the page.

2️⃣ Provide More Information: Share additional details or context — or let the community know if you've found a solution on your own.

3️⃣ Mark a Reply as Answer: If your question has been answered by a reply, mark the most helpful reply as the solution.

Note: This dormant notification will only apply to Discussions with the Question label. To learn more, see our recent announcement.

Thank you for helping bring this Discussion to a resolution! 💬