Incorrect files property in POST /gists

[WillAbides]

• endpoint scope: gists
• endpoint name: Create a gist
• route: POST /gists
• documentation URL: https://developer.github.com/v3/gists/#create-a-gist

Current specification

https://github.com/octokit/routes/blob/d32911fbef9b29a2ae85c3383698176948cba252/openapi/api.github.com/operations/gists/create.json#L373-L382

I expected

The "files" parameter is defined as a map like

{
  "files": {
    "content": "this is my content"
  }
}

What the endpoint actually accepts is like so:

{
  "files": {
    "file1.txt": {
      "content": "file one"
    },
    "file2.txt": {
      "content": "file two"
    }
  }
}

The corrected schema would be:

{
  "files": {
    "type": "object",
    "description": "The filenames and content of each file in the gist. The keys in the `files` object represent the filename and have the type `string`.",
    "additionalProperties": {
      "type": "object",
      "properties": {
        "content": {
          "type": "string",
          "description": "The content of the file."
        }
      }
    }
  }
}

[gr2m]

This is a tricky one. We cannot derive the type automatically by parsing the documentation, we will have to implement a manual override for this endpoint.

If you are interested to send a pull request, you can put the workaround here: /lib/endpoint/overrides/workarounds.js

We documented the process of contributing at https://github.com/octokit/routes/blob/master/CONTRIBUTING.md

[WillAbides]

I started hacking something together on workarounds.js when I submitted the issue, and my lack of js knowledge quickly got in the way. I think I'm better leaving it for somebody who knows what they're doing.

[octokitbot]

:tada: This issue has been resolved in version 28.0.2 :tada:

The release is available on:

• GitHub release
• npm package (@latest dist-tag)

Your semantic-release bot :package::rocket: