feat: add support for filtering "List workflows runs for a repository…

…" (`GET /repos/{owner}/{repo}/actions/runs`) and "List workflow runs [for a workflow]" (`GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs `) by `head_sha` (see PR for other changes) (#239) * feat: add support for filtering "List workflows runs for a repository" (`GET /repos/{owner}/{repo}/actions/runs`) and "List workflow runs [for a workflow]" (`GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs `) by `head_sha` * fix: tweak the recently-added `state_reason` attribute on issues to be a enum (`completed`, `not_planned` or `reopened`) rather than an unbounded string
octokit · Sep 5, 2022 · 40cac8e · 40cac8e
1 parent f28fe9e
commit 40cac8e
Show file tree

Hide file tree

Showing 21 changed files with 210 additions and 51 deletions.
diff --git a/cache/api.github.com.json b/cache/api.github.com.json
@@ -1,7 +1,7 @@
 {
  "openapi": "3.0.3",
  "info": {
- "version": "7.8.0",
+ "version": "7.9.0",
  "title": "GitHub's official OpenAPI spec + Octokit extension",
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
  "license": {
@@ -21282,6 +21282,9 @@
  },
  {
  "$ref": "#/components/parameters/workflow-run-check-suite-id"
+ },
+ {
+ "$ref": "#/components/parameters/workflow-run-head-sha"
  }
  ],
  "responses": {
@@ -22958,6 +22961,9 @@
  },
  {
  "$ref": "#/components/parameters/workflow-run-check-suite-id"
+ },
+ {
+ "$ref": "#/components/parameters/workflow-run-head-sha"
  }
  ],
  "responses": {
@@ -36993,6 +36999,11 @@
  },
  "state_reason": {
  "type": "string",
+ "enum": [
+ "completed",
+ "not_planned",
+ "reopened"
+ ],
  "nullable": true,
  "description": "The reason for the current state",
  "example": "not_planned"
@@ -64222,7 +64233,12 @@
  "description": "The reason for the current state",
  "example": "not_planned",
  "type": "string",
- "nullable": true
+ "nullable": true,
+ "enum": [
+ "completed",
+ "reopened",
+ "not_planned"
+ ]
  },
  "title": {
  "description": "Title of the issue",
@@ -78851,7 +78867,12 @@
  "description": "The reason for the current state",
  "example": "not_planned",
  "type": "string",
- "nullable": true
+ "nullable": true,
+ "enum": [
+ "completed",
+ "reopened",
+ "not_planned"
+ ]
  },
  "title": {
  "description": "Title of the issue",
@@ -113288,6 +113309,15 @@
  "type": "integer"
  }
  },
+ "workflow-run-head-sha": {
+ "name": "head_sha",
+ "description": "Only returns workflow runs that are associated with the specified `head_sha`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
  "run-id": {
  "name": "run_id",
  "description": "The unique identifier of the workflow run.",

diff --git a/cache/ghes-3.2.json b/cache/ghes-3.2.json
@@ -1,7 +1,7 @@
 {
  "openapi": "3.0.3",
  "info": {
- "version": "7.8.0",
+ "version": "7.9.0",
  "title": "GitHub's official OpenAPI spec + Octokit extension",
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
  "license": {
@@ -32633,6 +32633,11 @@
  },
  "state_reason": {
  "type": "string",
+ "enum": [
+ "completed",
+ "not_planned",
+ "reopened"
+ ],
  "nullable": true,
  "description": "The reason for the current state",
  "example": "not_planned"
@@ -54843,7 +54848,12 @@
  "description": "The reason for the current state",
  "example": "not_planned",
  "type": "string",
- "nullable": true
+ "nullable": true,
+ "enum": [
+ "completed",
+ "reopened",
+ "not_planned"
+ ]
  },
  "title": {
  "description": "Title of the issue",
@@ -66323,7 +66333,12 @@
  "description": "The reason for the current state",
  "example": "not_planned",
  "type": "string",
- "nullable": true
+ "nullable": true,
+ "enum": [
+ "completed",
+ "reopened",
+ "not_planned"
+ ]
  },
  "title": {
  "description": "Title of the issue",

diff --git a/cache/ghes-3.3.json b/cache/ghes-3.3.json
@@ -1,7 +1,7 @@
 {
  "openapi": "3.0.3",
  "info": {
- "version": "7.8.0",
+ "version": "7.9.0",
  "title": "GitHub's official OpenAPI spec + Octokit extension",
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
  "license": {
@@ -32322,6 +32322,11 @@
  },
  "state_reason": {
  "type": "string",
+ "enum": [
+ "completed",
+ "not_planned",
+ "reopened"
+ ],
  "nullable": true,
  "description": "The reason for the current state",
  "example": "not_planned"
@@ -55079,7 +55084,12 @@
  "description": "The reason for the current state",
  "example": "not_planned",
  "type": "string",
- "nullable": true
+ "nullable": true,
+ "enum": [
+ "completed",
+ "reopened",
+ "not_planned"
+ ]
  },
  "title": {
  "description": "Title of the issue",
@@ -67013,7 +67023,12 @@
  "description": "The reason for the current state",
  "example": "not_planned",
  "type": "string",
- "nullable": true
+ "nullable": true,
+ "enum": [
+ "completed",
+ "reopened",
+ "not_planned"
+ ]
  },
  "title": {
  "description": "Title of the issue",

diff --git a/cache/ghes-3.4.json b/cache/ghes-3.4.json
@@ -1,7 +1,7 @@
 {
  "openapi": "3.0.3",
  "info": {
- "version": "7.8.0",
+ "version": "7.9.0",
  "title": "GitHub's official OpenAPI spec + Octokit extension",
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
  "license": {
@@ -34175,6 +34175,11 @@
  },
  "state_reason": {
  "type": "string",
+ "enum": [
+ "completed",
+ "not_planned",
+ "reopened"
+ ],
  "nullable": true,
  "description": "The reason for the current state",
  "example": "not_planned"
@@ -57220,7 +57225,12 @@
  "description": "The reason for the current state",
  "example": "not_planned",
  "type": "string",
- "nullable": true
+ "nullable": true,
+ "enum": [
+ "completed",
+ "reopened",
+ "not_planned"
+ ]
  },
  "title": {
  "description": "Title of the issue",
@@ -69069,7 +69079,12 @@
  "description": "The reason for the current state",
  "example": "not_planned",
  "type": "string",
- "nullable": true
+ "nullable": true,
+ "enum": [
+ "completed",
+ "reopened",
+ "not_planned"
+ ]
  },
  "title": {
  "description": "Title of the issue",

diff --git a/cache/ghes-3.5.json b/cache/ghes-3.5.json
@@ -1,7 +1,7 @@
 {
  "openapi": "3.0.3",
  "info": {
- "version": "7.8.0",
+ "version": "7.9.0",
  "title": "GitHub's official OpenAPI spec + Octokit extension",
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
  "license": {
@@ -35437,6 +35437,11 @@
  },
  "state_reason": {
  "type": "string",
+ "enum": [
+ "completed",
+ "not_planned",
+ "reopened"
+ ],
  "nullable": true,
  "description": "The reason for the current state",
  "example": "not_planned"
@@ -58516,7 +58521,12 @@
  "description": "The reason for the current state",
  "example": "not_planned",
  "type": "string",
- "nullable": true
+ "nullable": true,
+ "enum": [
+ "completed",
+ "reopened",
+ "not_planned"
+ ]
  },
  "title": {
  "description": "Title of the issue",
@@ -70650,7 +70660,12 @@
  "description": "The reason for the current state",
  "example": "not_planned",
  "type": "string",
- "nullable": true
+ "nullable": true,
+ "enum": [
+ "completed",
+ "reopened",
+ "not_planned"
+ ]
  },
  "title": {
  "description": "Title of the issue",

diff --git a/cache/ghes-3.6.json b/cache/ghes-3.6.json
@@ -1,7 +1,7 @@
 {
  "openapi": "3.0.3",
  "info": {
- "version": "7.8.0",
+ "version": "7.9.0",
  "title": "GitHub's official OpenAPI spec + Octokit extension",
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
  "license": {
@@ -22081,7 +22081,13 @@
  "category": "actions",
  "subcategory": "workflow-runs"
  },
- "x-octokit": {}
+ "x-octokit": {
+ "diff": {
+ "api.github.com": {
+ "type": "changed"
+ }
+ }
+ }
  }
  },
  "/repos/{owner}/{repo}/actions/runs/{run_id}": {
@@ -23653,7 +23659,13 @@
  "category": "actions",
  "subcategory": "workflow-runs"
  },
- "x-octokit": {}
+ "x-octokit": {
+ "diff": {
+ "api.github.com": {
+ "type": "changed"
+ }
+ }
+ }
  }
  },
  "/repos/{owner}/{repo}/assignees": {
@@ -35927,6 +35939,11 @@
  },
  "state_reason": {
  "type": "string",
+ "enum": [
+ "completed",
+ "not_planned",
+ "reopened"
+ ],
  "nullable": true,
  "description": "The reason for the current state",
  "example": "not_planned"
@@ -62825,7 +62842,12 @@
  "description": "The reason for the current state",
  "example": "not_planned",
  "type": "string",
- "nullable": true
+ "nullable": true,
+ "enum": [
+ "completed",
+ "reopened",
+ "not_planned"
+ ]
  },
  "title": {
  "description": "Title of the issue",
@@ -75202,7 +75224,12 @@
  "description": "The reason for the current state",
  "example": "not_planned",
  "type": "string",
- "nullable": true
+ "nullable": true,
+ "enum": [
+ "completed",
+ "reopened",
+ "not_planned"
+ ]
  },
  "title": {
  "description": "Title of the issue",