Skip to content
This repository has been archived by the owner on Jul 27, 2020. It is now read-only.

List pull requests: parameter type "enum" should be "string" #62

Closed
gr2m opened this issue Mar 27, 2018 · 1 comment · Fixed by #88
Closed

List pull requests: parameter type "enum" should be "string" #62

gr2m opened this issue Mar 27, 2018 · 1 comment · Fixed by #88
Assignees
Labels
bug Something isn't working as documented, or is being fixed

Comments

@gr2m
Copy link
Contributor

gr2m commented Mar 27, 2018

Current specification

{
"name": "List pull requests",
"enabledForApps": true,
"method": "GET",
"path": "/repos/:owner/:repo/pulls",
"params": [
{
"name": "owner",
"type": "string",
"required": true,
"description": ""
},
{
"name": "repo",
"type": "string",
"required": true,
"description": ""
},
{
"name": "state",
"type": "enum",
"options": [
"open",
"closed",
"all"
],
"description": "Either `open`, `closed`, or `all` to filter by state.",
"default": "open",
"required": false
},
{
"name": "head",
"type": "string",
"description": "Filter pulls by head user and branch name in the format of `user:ref-name`. Example: `github:new-script-format`.",
"required": false
},
{
"name": "base",
"type": "string",
"description": "Filter pulls by base branch name. Example: `gh-pages`.",
"required": false
},
{
"name": "sort",
"type": "string",
"description": "What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month).",
"default": "created",
"required": false
},
{
"name": "direction",
"type": "string",
"description": "The direction of the sort. Can be either `asc` or `desc`.",
"default": "`desc` when sort is `created` or sort is not specified, otherwise `asc`",
"required": false
},
{
"name": "per_page",
"type": "number",
"required": false,
"description": "Results per page (max 100)",
"default": 30
},
{
"name": "page",
"type": "number",
"required": false,
"description": "Page number of the results to fetch.",
"default": 1
}
],
"description": "",
"documentationUrl": "https://developer.github.com/v3/pulls/#list-pull-requests"
}

I expected

"enum" should be "string"
{
  "name": "List pull requests",
  "enabledForApps": true,
  "method": "GET",
  "path": "/repos/:owner/:repo/pulls",
  "params": [
    {
      "name": "owner",
      "type": "string",
      "required": true,
      "description": ""
    },
    {
      "name": "repo",
      "type": "string",
      "required": true,
      "description": ""
    },
    {
      "name": "state",
      "type": "string",
      "enum": [
        "open",
        "closed",
        "all"
      ],
      "description": "Either `open`, `closed`, or `all` to filter by state.",
      "default": "open",
      "required": false
    },
    {
      "name": "head",
      "type": "string",
      "description": "Filter pulls by head user and branch name in the format of `user:ref-name`. Example: `github:new-script-format`.",
      "required": false
    },
    {
      "name": "base",
      "type": "string",
      "description": "Filter pulls by base branch name. Example: `gh-pages`.",
      "required": false
    },
    {
      "name": "sort",
      "type": "string",
      "description": "What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month).",
      "default": "created",
      "required": false
    },
    {
      "name": "direction",
      "type": "string",
      "description": "The direction of the sort. Can be either `asc` or `desc`.",
      "default": "`desc` when sort is `created` or sort is not specified, otherwise `asc`",
      "required": false
    },
    {
      "name": "per_page",
      "type": "number",
      "required": false,
      "description": "Results per page (max 100)",
      "default": 30
    },
    {
      "name": "page",
      "type": "number",
      "required": false,
      "description": "Page number of the results to fetch.",
      "default": 1
    }
  ],
  "description": "",
  "documentationUrl": "https://developer.github.com/v3/pulls/#list-pull-requests"
}

has failing test at #73

@gr2m gr2m added the bug Something isn't working as documented, or is being fixed label Mar 27, 2018
@gr2m gr2m added help wanted Contributions appreciated has-failing-test labels Mar 27, 2018
@gr2m gr2m mentioned this issue Mar 27, 2018
@gr2m gr2m removed the help wanted Contributions appreciated label Mar 30, 2018
@gr2m gr2m self-assigned this Mar 30, 2018
@gr2m gr2m closed this as completed in #88 Mar 30, 2018
@octokitbot
Copy link
Collaborator

🎉 This issue has been resolved in version 5.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Something isn't working as documented, or is being fixed
Projects
None yet
2 participants