@octokit/openapi 5.8.0 → 5.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "5.8.0",
4
+ "version": "5.10.0",
5
5
  "title": "GitHub's official OpenAPI spec + Octokit extension",
6
6
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
7
7
  "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -29005,6 +29005,9 @@
29005
29005
  }
29006
29006
  }
29007
29007
  }
29008
+ },
29009
+ "422": {
29010
+ "description": "Response if you upload an asset with the same filename as another uploaded asset"
29008
29011
  }
29009
29012
  },
29010
29013
  "x-github": {
@@ -8741,6 +8741,9 @@
8741
8741
  "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}": [
8742
8742
  "get"
8743
8743
  ],
8744
+ "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": [
8745
+ "get"
8746
+ ],
8744
8747
  "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": [
8745
8748
  "get"
8746
8749
  ],
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "5.8.0",
4
+ "version": "5.10.0",
5
5
  "title": "GitHub's official OpenAPI spec + Octokit extension",
6
6
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
7
7
  "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "5.8.0",
4
+ "version": "5.10.0",
5
5
  "title": "GitHub's official OpenAPI spec + Octokit extension",
6
6
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
7
7
  "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "5.8.0",
4
+ "version": "5.10.0",
5
5
  "title": "GitHub's official OpenAPI spec + Octokit extension",
6
6
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
7
7
  "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -251241,6 +251241,9 @@
251241
251241
  }
251242
251242
  }
251243
251243
  }
251244
+ },
251245
+ "422": {
251246
+ "description": "Response if you upload an asset with the same filename as another uploaded asset"
251244
251247
  }
251245
251248
  },
251246
251249
  "x-github": {
@@ -319585,6 +319588,20 @@
319585
319588
  "responses": { "501": { "description": "Not Implemented" } }
319586
319589
  }
319587
319590
  },
319591
+ "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": {
319592
+ "get": {
319593
+ "summary": "List jobs for a workflow run attempt",
319594
+ "description": "This endpoint does not exist ghes-3.2. It was added in api.github.com",
319595
+ "tags": ["actions"],
319596
+ "operationId": "actions/list-jobs-for-workflow-run-attempt",
319597
+ "externalDocs": {
319598
+ "description": "API method documentation",
319599
+ "url": "https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run-attempt"
319600
+ },
319601
+ "x-octokit": { "api.github.com": "removed" },
319602
+ "responses": { "501": { "description": "Not Implemented" } }
319603
+ }
319604
+ },
319588
319605
  "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": {
319589
319606
  "get": {
319590
319607
  "summary": "Download workflow run attempt logs",
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "5.8.0",
4
+ "version": "5.10.0",
5
5
  "title": "GitHub's official OpenAPI spec + Octokit extension",
6
6
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
7
7
  "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -29751,6 +29751,9 @@
29751
29751
  }
29752
29752
  }
29753
29753
  }
29754
+ },
29755
+ "422": {
29756
+ "description": "Response if you upload an asset with the same filename as another uploaded asset"
29754
29757
  }
29755
29758
  },
29756
29759
  "x-github": {
@@ -37250,9 +37253,7 @@
37250
37253
  "application/json": {
37251
37254
  "schema": { "$ref": "#/components/schemas/code-of-conduct" },
37252
37255
  "examples": {
37253
- "default": {
37254
- "$ref": "#/components/examples/code-of-conduct-2"
37255
- }
37256
+ "default": { "$ref": "#/components/examples/code-of-conduct" }
37256
37257
  }
37257
37258
  }
37258
37259
  }
@@ -37943,6 +37944,20 @@
37943
37944
  "responses": { "501": { "description": "Not Implemented" } }
37944
37945
  }
37945
37946
  },
37947
+ "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": {
37948
+ "get": {
37949
+ "summary": "List jobs for a workflow run attempt",
37950
+ "description": "This endpoint does not exist ghes-3.2.json. It was added in api.github.com.json",
37951
+ "tags": ["actions"],
37952
+ "operationId": "actions/list-jobs-for-workflow-run-attempt",
37953
+ "externalDocs": {
37954
+ "description": "API method documentation",
37955
+ "url": "https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run-attempt"
37956
+ },
37957
+ "x-octokit": { "api.github.com.json": "removed" },
37958
+ "responses": { "501": { "description": "Not Implemented" } }
37959
+ }
37960
+ },
37946
37961
  "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": {
37947
37962
  "get": {
37948
37963
  "summary": "Download workflow run attempt logs",
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "5.8.0",
4
+ "version": "5.10.0",
5
5
  "title": "GitHub's official OpenAPI spec + Octokit extension",
6
6
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
7
7
  "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "5.8.0",
4
+ "version": "5.10.0",
5
5
  "title": "GitHub's official OpenAPI spec + Octokit extension",
6
6
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
7
7
  "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "5.8.0",
4
+ "version": "5.10.0",
5
5
  "title": "GitHub's official OpenAPI spec + Octokit extension",
6
6
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
7
7
  "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -76700,6 +76700,395 @@
76700
76700
  "x-octokit": {}
76701
76701
  }
76702
76702
  },
76703
+ "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": {
76704
+ "get": {
76705
+ "summary": "List jobs for a workflow run attempt",
76706
+ "description": "Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#parameters).",
76707
+ "tags": ["actions"],
76708
+ "operationId": "actions/list-jobs-for-workflow-run-attempt",
76709
+ "externalDocs": {
76710
+ "description": "API method documentation",
76711
+ "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-jobs-for-a-workflow-run-attempt"
76712
+ },
76713
+ "parameters": [
76714
+ {
76715
+ "name": "owner",
76716
+ "in": "path",
76717
+ "required": true,
76718
+ "schema": { "type": "string" }
76719
+ },
76720
+ {
76721
+ "name": "repo",
76722
+ "in": "path",
76723
+ "required": true,
76724
+ "schema": { "type": "string" }
76725
+ },
76726
+ {
76727
+ "name": "run_id",
76728
+ "description": "The id of the workflow run.",
76729
+ "in": "path",
76730
+ "required": true,
76731
+ "schema": { "type": "integer" }
76732
+ },
76733
+ {
76734
+ "name": "attempt_number",
76735
+ "description": "The attempt number of the workflow run.",
76736
+ "in": "path",
76737
+ "required": true,
76738
+ "schema": { "type": "integer" }
76739
+ },
76740
+ {
76741
+ "name": "per_page",
76742
+ "description": "Results per page (max 100)",
76743
+ "in": "query",
76744
+ "schema": { "type": "integer", "default": 30 }
76745
+ },
76746
+ {
76747
+ "name": "page",
76748
+ "description": "Page number of the results to fetch.",
76749
+ "in": "query",
76750
+ "schema": { "type": "integer", "default": 1 }
76751
+ }
76752
+ ],
76753
+ "responses": {
76754
+ "200": {
76755
+ "description": "Response",
76756
+ "content": {
76757
+ "application/json": {
76758
+ "schema": {
76759
+ "type": "object",
76760
+ "required": ["total_count", "jobs"],
76761
+ "properties": {
76762
+ "total_count": { "type": "integer" },
76763
+ "jobs": {
76764
+ "type": "array",
76765
+ "items": {
76766
+ "title": "Job",
76767
+ "description": "Information of a job execution in a workflow run",
76768
+ "type": "object",
76769
+ "properties": {
76770
+ "id": {
76771
+ "description": "The id of the job.",
76772
+ "example": 21,
76773
+ "type": "integer"
76774
+ },
76775
+ "run_id": {
76776
+ "description": "The id of the associated workflow run.",
76777
+ "example": 5,
76778
+ "type": "integer"
76779
+ },
76780
+ "run_url": {
76781
+ "type": "string",
76782
+ "example": "https://api.github.com/repos/github/hello-world/actions/runs/5"
76783
+ },
76784
+ "run_attempt": {
76785
+ "type": "integer",
76786
+ "description": "Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.",
76787
+ "example": 1
76788
+ },
76789
+ "node_id": {
76790
+ "type": "string",
76791
+ "example": "MDg6Q2hlY2tSdW40"
76792
+ },
76793
+ "head_sha": {
76794
+ "description": "The SHA of the commit that is being run.",
76795
+ "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d",
76796
+ "type": "string"
76797
+ },
76798
+ "url": {
76799
+ "type": "string",
76800
+ "example": "https://api.github.com/repos/github/hello-world/actions/jobs/21"
76801
+ },
76802
+ "html_url": {
76803
+ "type": "string",
76804
+ "example": "https://github.com/github/hello-world/runs/4",
76805
+ "nullable": true
76806
+ },
76807
+ "status": {
76808
+ "description": "The phase of the lifecycle that the job is currently in.",
76809
+ "example": "queued",
76810
+ "type": "string",
76811
+ "enum": ["queued", "in_progress", "completed"]
76812
+ },
76813
+ "conclusion": {
76814
+ "description": "The outcome of the job.",
76815
+ "example": "success",
76816
+ "type": "string",
76817
+ "nullable": true
76818
+ },
76819
+ "started_at": {
76820
+ "description": "The time that the job started, in ISO 8601 format.",
76821
+ "example": "2019-08-08T08:00:00-07:00",
76822
+ "format": "date-time",
76823
+ "type": "string"
76824
+ },
76825
+ "completed_at": {
76826
+ "description": "The time that the job finished, in ISO 8601 format.",
76827
+ "example": "2019-08-08T08:00:00-07:00",
76828
+ "format": "date-time",
76829
+ "type": "string",
76830
+ "nullable": true
76831
+ },
76832
+ "name": {
76833
+ "description": "The name of the job.",
76834
+ "example": "test-coverage",
76835
+ "type": "string"
76836
+ },
76837
+ "steps": {
76838
+ "description": "Steps in this job.",
76839
+ "type": "array",
76840
+ "items": {
76841
+ "type": "object",
76842
+ "required": [
76843
+ "name",
76844
+ "status",
76845
+ "conclusion",
76846
+ "number"
76847
+ ],
76848
+ "properties": {
76849
+ "status": {
76850
+ "description": "The phase of the lifecycle that the job is currently in.",
76851
+ "example": "queued",
76852
+ "type": "string",
76853
+ "enum": ["queued", "in_progress", "completed"]
76854
+ },
76855
+ "conclusion": {
76856
+ "description": "The outcome of the job.",
76857
+ "example": "success",
76858
+ "type": "string",
76859
+ "nullable": true
76860
+ },
76861
+ "name": {
76862
+ "description": "The name of the job.",
76863
+ "example": "test-coverage",
76864
+ "type": "string"
76865
+ },
76866
+ "number": { "type": "integer", "example": 1 },
76867
+ "started_at": {
76868
+ "description": "The time that the step started, in ISO 8601 format.",
76869
+ "example": "2019-08-08T08:00:00-07:00",
76870
+ "format": "date-time",
76871
+ "type": "string",
76872
+ "nullable": true
76873
+ },
76874
+ "completed_at": {
76875
+ "description": "The time that the job finished, in ISO 8601 format.",
76876
+ "example": "2019-08-08T08:00:00-07:00",
76877
+ "format": "date-time",
76878
+ "type": "string",
76879
+ "nullable": true
76880
+ }
76881
+ }
76882
+ }
76883
+ },
76884
+ "check_run_url": {
76885
+ "type": "string",
76886
+ "example": "https://api.github.com/repos/github/hello-world/check-runs/4"
76887
+ },
76888
+ "labels": {
76889
+ "type": "array",
76890
+ "items": { "type": "string" },
76891
+ "description": "Labels for the workflow job. Specified by the \"runs_on\" attribute in the action's workflow file.",
76892
+ "example": ["self-hosted", "foo", "bar"]
76893
+ },
76894
+ "runner_id": {
76895
+ "type": "integer",
76896
+ "nullable": true,
76897
+ "example": 1,
76898
+ "description": "The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)"
76899
+ },
76900
+ "runner_name": {
76901
+ "type": "string",
76902
+ "nullable": true,
76903
+ "example": "my runner",
76904
+ "description": "The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)"
76905
+ },
76906
+ "runner_group_id": {
76907
+ "type": "integer",
76908
+ "nullable": true,
76909
+ "example": 2,
76910
+ "description": "The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)"
76911
+ },
76912
+ "runner_group_name": {
76913
+ "type": "string",
76914
+ "nullable": true,
76915
+ "example": "my runner group",
76916
+ "description": "The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)"
76917
+ }
76918
+ },
76919
+ "required": [
76920
+ "id",
76921
+ "node_id",
76922
+ "run_id",
76923
+ "run_url",
76924
+ "head_sha",
76925
+ "name",
76926
+ "url",
76927
+ "html_url",
76928
+ "status",
76929
+ "conclusion",
76930
+ "started_at",
76931
+ "completed_at",
76932
+ "check_run_url",
76933
+ "labels",
76934
+ "runner_id",
76935
+ "runner_name",
76936
+ "runner_group_id",
76937
+ "runner_group_name"
76938
+ ]
76939
+ }
76940
+ }
76941
+ }
76942
+ },
76943
+ "examples": {
76944
+ "default": {
76945
+ "value": {
76946
+ "total_count": 1,
76947
+ "jobs": [
76948
+ {
76949
+ "id": 399444496,
76950
+ "run_id": 29679449,
76951
+ "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449",
76952
+ "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
76953
+ "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
76954
+ "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496",
76955
+ "html_url": "https://github.com/octo-org/octo-repo/runs/399444496",
76956
+ "status": "completed",
76957
+ "conclusion": "success",
76958
+ "started_at": "2020-01-20T17:42:40Z",
76959
+ "completed_at": "2020-01-20T17:44:39Z",
76960
+ "name": "build",
76961
+ "steps": [
76962
+ {
76963
+ "name": "Set up job",
76964
+ "status": "completed",
76965
+ "conclusion": "success",
76966
+ "number": 1,
76967
+ "started_at": "2020-01-20T09:42:40.000-08:00",
76968
+ "completed_at": "2020-01-20T09:42:41.000-08:00"
76969
+ },
76970
+ {
76971
+ "name": "Run actions/checkout@v2",
76972
+ "status": "completed",
76973
+ "conclusion": "success",
76974
+ "number": 2,
76975
+ "started_at": "2020-01-20T09:42:41.000-08:00",
76976
+ "completed_at": "2020-01-20T09:42:45.000-08:00"
76977
+ },
76978
+ {
76979
+ "name": "Set up Ruby",
76980
+ "status": "completed",
76981
+ "conclusion": "success",
76982
+ "number": 3,
76983
+ "started_at": "2020-01-20T09:42:45.000-08:00",
76984
+ "completed_at": "2020-01-20T09:42:45.000-08:00"
76985
+ },
76986
+ {
76987
+ "name": "Run actions/cache@v2",
76988
+ "status": "completed",
76989
+ "conclusion": "success",
76990
+ "number": 4,
76991
+ "started_at": "2020-01-20T09:42:45.000-08:00",
76992
+ "completed_at": "2020-01-20T09:42:48.000-08:00"
76993
+ },
76994
+ {
76995
+ "name": "Install Bundler",
76996
+ "status": "completed",
76997
+ "conclusion": "success",
76998
+ "number": 5,
76999
+ "started_at": "2020-01-20T09:42:48.000-08:00",
77000
+ "completed_at": "2020-01-20T09:42:52.000-08:00"
77001
+ },
77002
+ {
77003
+ "name": "Install Gems",
77004
+ "status": "completed",
77005
+ "conclusion": "success",
77006
+ "number": 6,
77007
+ "started_at": "2020-01-20T09:42:52.000-08:00",
77008
+ "completed_at": "2020-01-20T09:42:53.000-08:00"
77009
+ },
77010
+ {
77011
+ "name": "Run Tests",
77012
+ "status": "completed",
77013
+ "conclusion": "success",
77014
+ "number": 7,
77015
+ "started_at": "2020-01-20T09:42:53.000-08:00",
77016
+ "completed_at": "2020-01-20T09:42:59.000-08:00"
77017
+ },
77018
+ {
77019
+ "name": "Deploy to Heroku",
77020
+ "status": "completed",
77021
+ "conclusion": "success",
77022
+ "number": 8,
77023
+ "started_at": "2020-01-20T09:42:59.000-08:00",
77024
+ "completed_at": "2020-01-20T09:44:39.000-08:00"
77025
+ },
77026
+ {
77027
+ "name": "Post actions/cache@v2",
77028
+ "status": "completed",
77029
+ "conclusion": "success",
77030
+ "number": 16,
77031
+ "started_at": "2020-01-20T09:44:39.000-08:00",
77032
+ "completed_at": "2020-01-20T09:44:39.000-08:00"
77033
+ },
77034
+ {
77035
+ "name": "Complete job",
77036
+ "status": "completed",
77037
+ "conclusion": "success",
77038
+ "number": 17,
77039
+ "started_at": "2020-01-20T09:44:39.000-08:00",
77040
+ "completed_at": "2020-01-20T09:44:39.000-08:00"
77041
+ }
77042
+ ],
77043
+ "check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496",
77044
+ "labels": ["self-hosted", "foo", "bar"],
77045
+ "runner_id": 1,
77046
+ "runner_name": "my runner",
77047
+ "runner_group_id": 2,
77048
+ "runner_group_name": "my runner group"
77049
+ }
77050
+ ]
77051
+ }
77052
+ }
77053
+ }
77054
+ }
77055
+ },
77056
+ "headers": {
77057
+ "Link": {
77058
+ "example": "<https://api.github.com/resource?page=2>; rel=\"next\", <https://api.github.com/resource?page=5>; rel=\"last\"",
77059
+ "schema": { "type": "string" }
77060
+ }
77061
+ }
77062
+ },
77063
+ "404": {
77064
+ "description": "Resource not found",
77065
+ "content": {
77066
+ "application/json": {
77067
+ "schema": {
77068
+ "title": "Basic Error",
77069
+ "description": "Basic Error",
77070
+ "type": "object",
77071
+ "properties": {
77072
+ "message": { "type": "string" },
77073
+ "documentation_url": { "type": "string" },
77074
+ "url": { "type": "string" },
77075
+ "status": { "type": "string" }
77076
+ }
77077
+ }
77078
+ }
77079
+ }
77080
+ }
77081
+ },
77082
+ "x-github": {
77083
+ "githubCloudOnly": false,
77084
+ "enabledForGitHubApps": true,
77085
+ "previews": [],
77086
+ "category": "actions",
77087
+ "subcategory": "workflow-jobs"
77088
+ },
77089
+ "x-octokit": {}
77090
+ }
77091
+ },
76703
77092
  "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": {
76704
77093
  "get": {
76705
77094
  "summary": "Download workflow run attempt logs",
@@ -224125,6 +224514,9 @@
224125
224514
  }
224126
224515
  }
224127
224516
  }
224517
+ },
224518
+ "422": {
224519
+ "description": "Response if you upload an asset with the same filename as another uploaded asset"
224128
224520
  }
224129
224521
  },
224130
224522
  "x-github": {