[BUG]: uploadReleaseAsset does not accept data as buffer

[StephenHodgson]

What happened?

Currently you have to fool the data input parameter into thinking that the buffer is a string:

await octokit.repos.uploadReleaseAsset({
      owner,
      repo,
      url: release.data.upload_url,
      release_id: release.data.id,
      data: (fs.readFileSync(asset) as unknown as string), // fool octokit into accepting the Buffer
      headers: {
        'content-type': contentType,
        'content-length': fs.statSync(asset).size,
      },
      name,
    });

Ideally you should be able to pass the buffer directly:

await octokit.repos.uploadReleaseAsset({
      owner,
      repo,
      url: release.data.upload_url,
      release_id: release.data.id,
      data: fs.readFileSync(asset),
      headers: {
        'content-type': contentType,
        'content-length': fs.statSync(asset).size,
      },
      name,
    });

Versions

latest

Code of Conduct

• I agree to follow this project's Code of Conduct

[github-actions]

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

[wolfy1339]

The root cause of the issue is at the source

    requestBody?: {
      content: {
        "application/octet-stream": string;
      };
    };

vs the openapi spec:

  "requestBody": {
    "required": false,
    "content": {
      "application/octet-stream": {
        "schema": {
          "type": "string",
          "format": "binary",
          "description": "The raw file data"
        },
        "examples": {
          "default": {
            "value": "@example.zip"
          }
        }
      }
    }
  }

I'm not sure how to fix this at all....

[StephenHodgson]

Unsure what client generator they're using to generate the library from the spec, but would be the way to fix it.

Either update the TypeScript library generator that uses the spec, or fix the spec so that it allows for the buffer input.

[wolfy1339]

Unsure what client generator they're using to generate the library from the spec, but would be the way to fix it.

It's all custom scripts, and types, and templates

fix the spec so that it allows for the buffer input.

The spec, is correct.
The types have to be platform agnostic, and have to account using only the basic types in TypeScript

Here are the relevant repositories:

• https://github.com/github/rest-api-description
• https://github.com/octokit/openapi
• https://github.com/octokit/openapi-types.ts
• https://github.com/octokit/types.ts
• https://github.com/octokit/plugin-rest-endpoint-methods.js/blob/main/src/generated/method-types.ts#L13985-L13993

[StephenHodgson]

It's all custom scripts, and types, and templates

lol but why? insert gif here

There's so many good foss spec client library generators out there that respect RFCs and use basic node fetch or other common fetch middlewares, lol. Seems like a lot of overhead could be streamlined.

[wolfy1339]

Because every part of octokit is modular using plugins.

The only basic thing included in the core are the octokit.request and octokit.graphql functions.

Because octokit was written pretty much by a singular person. Because a lot of it takes its core back to the node-github package writen in 2010

Seems like a lot of overhead could be streamlined.

Feel free to send in PRs

[StephenHodgson]

Feel free to send in PRs

Nah, I'm good. I just wanted to report bug. It is workable around for now. Just annoying.
lol, I wonder if it is just easier to generate a new client library from just the spec in my own org.

Because octokit was written pretty much by a singular person.

That is where spec driven development has its advantages, you just focus on the spec and the rest is auto generated.

[wolfy1339]

Some insights at: openapi-ts/openapi-typescript#1214

#2087