@octokit/openapi 7.8.0 → 7.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.
Files changed (33) hide show
  1. package/generated/api.github.com.deref.json +1921 -538
  2. package/generated/api.github.com.json +544 -29
  3. package/generated/ghes-3.2-diff-to-api.github.com.deref.json +1 -1
  4. package/generated/ghes-3.2-diff-to-api.github.com.json +1 -1
  5. package/generated/ghes-3.2-diff-to-ghes-3.3.deref.json +127 -25
  6. package/generated/ghes-3.2-diff-to-ghes-3.3.json +25 -8
  7. package/generated/ghes-3.2.deref.json +134 -27
  8. package/generated/ghes-3.2.json +26 -9
  9. package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json +1 -1
  10. package/generated/ghes-3.3-diff-to-ghes-3.4.json +1 -1
  11. package/generated/ghes-3.3.deref.json +134 -27
  12. package/generated/ghes-3.3.json +26 -9
  13. package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json +2 -2
  14. package/generated/ghes-3.4-diff-to-ghes-3.5.json +2 -2
  15. package/generated/ghes-3.4.deref.json +134 -27
  16. package/generated/ghes-3.4.json +28 -11
  17. package/generated/ghes-3.5-diff-to-api.github.com.deref.json +1 -1
  18. package/generated/ghes-3.5-diff-to-api.github.com.json +1 -1
  19. package/generated/ghes-3.5-diff-to-ghes-3.6.deref.json +127 -25
  20. package/generated/ghes-3.5-diff-to-ghes-3.6.json +25 -8
  21. package/generated/ghes-3.5.deref.json +134 -27
  22. package/generated/ghes-3.5.json +28 -11
  23. package/generated/ghes-3.6-anicca-diff-to-api.github.com.deref.json +82 -0
  24. package/generated/ghes-3.6-diff-to-api.github.com.deref.json +9648 -479
  25. package/generated/ghes-3.6-diff-to-api.github.com.json +1020 -23
  26. package/generated/ghes-3.6.deref.json +544 -234
  27. package/generated/ghes-3.6.json +147 -24
  28. package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +30 -0
  29. package/generated/github.ae-diff-to-api.github.com.deref.json +91 -19
  30. package/generated/github.ae-diff-to-api.github.com.json +25 -8
  31. package/generated/github.ae.deref.json +190 -27
  32. package/generated/github.ae.json +118 -15
  33. package/package.json +1 -1
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "7.8.0",
4
+ "version": "7.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": {
@@ -4706,6 +4706,74 @@
4706
4706
  }
4707
4707
  }
4708
4708
  },
4709
+ "/organizations/{organization_id}/custom_roles": {
4710
+ "get": {
4711
+ "summary": "List custom repository roles in an organization",
4712
+ "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nTo use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope.\nGitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/enterprise-server@3.6/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".",
4713
+ "tags": [
4714
+ "orgs"
4715
+ ],
4716
+ "operationId": "orgs/list-custom-roles",
4717
+ "externalDocs": {
4718
+ "description": "API method documentation",
4719
+ "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/orgs#list-custom-repository-roles-in-an-organization"
4720
+ },
4721
+ "parameters": [
4722
+ {
4723
+ "name": "organization_id",
4724
+ "description": "The unique identifier of the organization.",
4725
+ "in": "path",
4726
+ "required": true,
4727
+ "schema": {
4728
+ "type": "string"
4729
+ }
4730
+ }
4731
+ ],
4732
+ "responses": {
4733
+ "200": {
4734
+ "description": "Response - list of custom role names",
4735
+ "content": {
4736
+ "application/json": {
4737
+ "schema": {
4738
+ "type": "object",
4739
+ "properties": {
4740
+ "total_count": {
4741
+ "description": "The number of custom roles in this organization",
4742
+ "example": 3,
4743
+ "type": "integer"
4744
+ },
4745
+ "custom_roles": {
4746
+ "type": "array",
4747
+ "items": {
4748
+ "$ref": "#/components/schemas/organization-custom-repository-role"
4749
+ }
4750
+ }
4751
+ }
4752
+ },
4753
+ "examples": {
4754
+ "default": {
4755
+ "$ref": "#/components/examples/organization-custom-repository-role-example"
4756
+ }
4757
+ }
4758
+ }
4759
+ }
4760
+ }
4761
+ },
4762
+ "x-github": {
4763
+ "githubCloudOnly": false,
4764
+ "enabledForGitHubApps": true,
4765
+ "category": "orgs",
4766
+ "subcategory": "custom_roles"
4767
+ },
4768
+ "x-octokit": {
4769
+ "diff": {
4770
+ "api.github.com": {
4771
+ "type": "changed"
4772
+ }
4773
+ }
4774
+ }
4775
+ }
4776
+ },
4709
4777
  "/orgs/{org}": {
4710
4778
  "get": {
4711
4779
  "summary": "Get an organization",
@@ -5979,6 +6047,207 @@
5979
6047
  }
5980
6048
  }
5981
6049
  },
6050
+ "/repos/{owner}/{repo}/actions/runs": {
6051
+ "get": {
6052
+ "summary": "List workflow runs for a repository",
6053
+ "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone 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.",
6054
+ "tags": [
6055
+ "actions"
6056
+ ],
6057
+ "operationId": "actions/list-workflow-runs-for-repo",
6058
+ "externalDocs": {
6059
+ "description": "API method documentation",
6060
+ "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/actions#list-workflow-runs-for-a-repository"
6061
+ },
6062
+ "parameters": [
6063
+ {
6064
+ "$ref": "#/components/parameters/owner"
6065
+ },
6066
+ {
6067
+ "$ref": "#/components/parameters/repo"
6068
+ },
6069
+ {
6070
+ "$ref": "#/components/parameters/actor"
6071
+ },
6072
+ {
6073
+ "$ref": "#/components/parameters/workflow-run-branch"
6074
+ },
6075
+ {
6076
+ "$ref": "#/components/parameters/event"
6077
+ },
6078
+ {
6079
+ "$ref": "#/components/parameters/workflow-run-status"
6080
+ },
6081
+ {
6082
+ "$ref": "#/components/parameters/per-page"
6083
+ },
6084
+ {
6085
+ "$ref": "#/components/parameters/page"
6086
+ },
6087
+ {
6088
+ "$ref": "#/components/parameters/created"
6089
+ },
6090
+ {
6091
+ "$ref": "#/components/parameters/exclude-pull-requests"
6092
+ },
6093
+ {
6094
+ "$ref": "#/components/parameters/workflow-run-check-suite-id"
6095
+ }
6096
+ ],
6097
+ "responses": {
6098
+ "200": {
6099
+ "description": "Response",
6100
+ "content": {
6101
+ "application/json": {
6102
+ "schema": {
6103
+ "type": "object",
6104
+ "required": [
6105
+ "total_count",
6106
+ "workflow_runs"
6107
+ ],
6108
+ "properties": {
6109
+ "total_count": {
6110
+ "type": "integer"
6111
+ },
6112
+ "workflow_runs": {
6113
+ "type": "array",
6114
+ "items": {
6115
+ "$ref": "#/components/schemas/workflow-run"
6116
+ }
6117
+ }
6118
+ }
6119
+ },
6120
+ "examples": {
6121
+ "default": {
6122
+ "$ref": "#/components/examples/workflow-run-paginated"
6123
+ }
6124
+ }
6125
+ }
6126
+ },
6127
+ "headers": {
6128
+ "Link": {
6129
+ "$ref": "#/components/headers/link"
6130
+ }
6131
+ }
6132
+ }
6133
+ },
6134
+ "x-github": {
6135
+ "githubCloudOnly": false,
6136
+ "enabledForGitHubApps": true,
6137
+ "category": "actions",
6138
+ "subcategory": "workflow-runs"
6139
+ },
6140
+ "x-octokit": {
6141
+ "diff": {
6142
+ "api.github.com": {
6143
+ "type": "changed"
6144
+ }
6145
+ }
6146
+ }
6147
+ }
6148
+ },
6149
+ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": {
6150
+ "get": {
6151
+ "summary": "List workflow runs for a workflow",
6152
+ "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone 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.",
6153
+ "tags": [
6154
+ "actions"
6155
+ ],
6156
+ "operationId": "actions/list-workflow-runs",
6157
+ "externalDocs": {
6158
+ "description": "API method documentation",
6159
+ "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/actions#list-workflow-runs"
6160
+ },
6161
+ "parameters": [
6162
+ {
6163
+ "$ref": "#/components/parameters/owner"
6164
+ },
6165
+ {
6166
+ "$ref": "#/components/parameters/repo"
6167
+ },
6168
+ {
6169
+ "$ref": "#/components/parameters/workflow-id"
6170
+ },
6171
+ {
6172
+ "$ref": "#/components/parameters/actor"
6173
+ },
6174
+ {
6175
+ "$ref": "#/components/parameters/workflow-run-branch"
6176
+ },
6177
+ {
6178
+ "$ref": "#/components/parameters/event"
6179
+ },
6180
+ {
6181
+ "$ref": "#/components/parameters/workflow-run-status"
6182
+ },
6183
+ {
6184
+ "$ref": "#/components/parameters/per-page"
6185
+ },
6186
+ {
6187
+ "$ref": "#/components/parameters/page"
6188
+ },
6189
+ {
6190
+ "$ref": "#/components/parameters/created"
6191
+ },
6192
+ {
6193
+ "$ref": "#/components/parameters/exclude-pull-requests"
6194
+ },
6195
+ {
6196
+ "$ref": "#/components/parameters/workflow-run-check-suite-id"
6197
+ }
6198
+ ],
6199
+ "responses": {
6200
+ "200": {
6201
+ "description": "Response",
6202
+ "content": {
6203
+ "application/json": {
6204
+ "schema": {
6205
+ "type": "object",
6206
+ "required": [
6207
+ "total_count",
6208
+ "workflow_runs"
6209
+ ],
6210
+ "properties": {
6211
+ "total_count": {
6212
+ "type": "integer"
6213
+ },
6214
+ "workflow_runs": {
6215
+ "type": "array",
6216
+ "items": {
6217
+ "$ref": "#/components/schemas/workflow-run"
6218
+ }
6219
+ }
6220
+ }
6221
+ },
6222
+ "examples": {
6223
+ "default": {
6224
+ "$ref": "#/components/examples/workflow-run-paginated"
6225
+ }
6226
+ }
6227
+ }
6228
+ },
6229
+ "headers": {
6230
+ "Link": {
6231
+ "$ref": "#/components/headers/link"
6232
+ }
6233
+ }
6234
+ }
6235
+ },
6236
+ "x-github": {
6237
+ "githubCloudOnly": false,
6238
+ "enabledForGitHubApps": true,
6239
+ "category": "actions",
6240
+ "subcategory": "workflow-runs"
6241
+ },
6242
+ "x-octokit": {
6243
+ "diff": {
6244
+ "api.github.com": {
6245
+ "type": "changed"
6246
+ }
6247
+ }
6248
+ }
6249
+ }
6250
+ },
5982
6251
  "/repos/{owner}/{repo}/autolinks": {
5983
6252
  "get": {
5984
6253
  "summary": "List all autolinks of a repository",
@@ -9172,6 +9441,101 @@
9172
9441
  "type": "string"
9173
9442
  }
9174
9443
  },
9444
+ "actor": {
9445
+ "name": "actor",
9446
+ "description": "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.",
9447
+ "in": "query",
9448
+ "required": false,
9449
+ "schema": {
9450
+ "type": "string"
9451
+ }
9452
+ },
9453
+ "workflow-run-branch": {
9454
+ "name": "branch",
9455
+ "description": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`.",
9456
+ "in": "query",
9457
+ "required": false,
9458
+ "schema": {
9459
+ "type": "string"
9460
+ }
9461
+ },
9462
+ "event": {
9463
+ "name": "event",
9464
+ "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"",
9465
+ "in": "query",
9466
+ "required": false,
9467
+ "schema": {
9468
+ "type": "string"
9469
+ }
9470
+ },
9471
+ "workflow-run-status": {
9472
+ "name": "status",
9473
+ "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`.",
9474
+ "in": "query",
9475
+ "required": false,
9476
+ "schema": {
9477
+ "type": "string",
9478
+ "enum": [
9479
+ "completed",
9480
+ "action_required",
9481
+ "cancelled",
9482
+ "failure",
9483
+ "neutral",
9484
+ "skipped",
9485
+ "stale",
9486
+ "success",
9487
+ "timed_out",
9488
+ "in_progress",
9489
+ "queued",
9490
+ "requested",
9491
+ "waiting"
9492
+ ]
9493
+ }
9494
+ },
9495
+ "created": {
9496
+ "name": "created",
9497
+ "description": "Returns workflow runs created within the given date-time range. For more information on the syntax, see \"[Understanding the search syntax](https://docs.github.com/enterprise-server@3.6/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"",
9498
+ "in": "query",
9499
+ "required": false,
9500
+ "schema": {
9501
+ "type": "string",
9502
+ "format": "date-time"
9503
+ }
9504
+ },
9505
+ "exclude-pull-requests": {
9506
+ "name": "exclude_pull_requests",
9507
+ "description": "If `true` pull requests are omitted from the response (empty array).",
9508
+ "in": "query",
9509
+ "required": false,
9510
+ "schema": {
9511
+ "type": "boolean",
9512
+ "default": false
9513
+ }
9514
+ },
9515
+ "workflow-run-check-suite-id": {
9516
+ "name": "check_suite_id",
9517
+ "description": "Returns workflow runs with the `check_suite_id` that you specify.",
9518
+ "in": "query",
9519
+ "schema": {
9520
+ "type": "integer"
9521
+ }
9522
+ },
9523
+ "workflow-id": {
9524
+ "name": "workflow_id",
9525
+ "in": "path",
9526
+ "description": "The ID of the workflow. You can also pass the workflow file name as a string.",
9527
+ "required": true,
9528
+ "schema": {
9529
+ "oneOf": [
9530
+ {
9531
+ "type": "integer"
9532
+ },
9533
+ {
9534
+ "type": "string"
9535
+ }
9536
+ ]
9537
+ }
9538
+ },
9175
9539
  "autolink-id": {
9176
9540
  "name": "autolink_id",
9177
9541
  "description": "The unique identifier of the autolink.",
@@ -10995,6 +11359,25 @@
10995
11359
  "verifiable_password_authentication"
10996
11360
  ]
10997
11361
  },
11362
+ "organization-custom-repository-role": {
11363
+ "title": "Organization Custom Repository Role",
11364
+ "description": "Custom repository roles created by organization administrators",
11365
+ "type": "object",
11366
+ "properties": {
11367
+ "id": {
11368
+ "description": "The unique identifier of the custom role.",
11369
+ "type": "integer"
11370
+ },
11371
+ "name": {
11372
+ "description": "The name of the custom role.",
11373
+ "type": "string"
11374
+ }
11375
+ },
11376
+ "required": [
11377
+ "id",
11378
+ "name"
11379
+ ]
11380
+ },
10998
11381
  "organization-full": {
10999
11382
  "title": "Organization Full",
11000
11383
  "description": "Organization Full",
@@ -11734,28 +12117,227 @@
11734
12117
  "search"
11735
12118
  ]
11736
12119
  },
11737
- "rate": {
11738
- "$ref": "#/components/schemas/rate-limit"
11739
- }
11740
- },
11741
- "required": [
11742
- "rate",
11743
- "resources"
11744
- ]
11745
- },
11746
- "actions-cache-usage-policy-for-repository": {
11747
- "title": "Actions cache usage policy for repository",
11748
- "description": "GitHub Actions cache usage policy for repository.",
11749
- "type": "object",
11750
- "properties": {
11751
- "repo_cache_size_limit_in_gb": {
11752
- "description": "The size limit for the sum of all caches, in gigabytes.",
12120
+ "rate": {
12121
+ "$ref": "#/components/schemas/rate-limit"
12122
+ }
12123
+ },
12124
+ "required": [
12125
+ "rate",
12126
+ "resources"
12127
+ ]
12128
+ },
12129
+ "actions-cache-usage-policy-for-repository": {
12130
+ "title": "Actions cache usage policy for repository",
12131
+ "description": "GitHub Actions cache usage policy for repository.",
12132
+ "type": "object",
12133
+ "properties": {
12134
+ "repo_cache_size_limit_in_gb": {
12135
+ "description": "The size limit for the sum of all caches, in gigabytes.",
12136
+ "type": "integer",
12137
+ "example": 14
12138
+ }
12139
+ },
12140
+ "required": [
12141
+ "repo_cache_size_limit_in_gb"
12142
+ ]
12143
+ },
12144
+ "workflow-run": {
12145
+ "title": "Workflow Run",
12146
+ "description": "An invocation of a workflow",
12147
+ "type": "object",
12148
+ "properties": {
12149
+ "id": {
12150
+ "type": "integer",
12151
+ "description": "The ID of the workflow run.",
12152
+ "example": 5
12153
+ },
12154
+ "name": {
12155
+ "type": "string",
12156
+ "description": "The name of the workflow run.",
12157
+ "nullable": true,
12158
+ "example": "Build"
12159
+ },
12160
+ "node_id": {
12161
+ "type": "string",
12162
+ "example": "MDEwOkNoZWNrU3VpdGU1"
12163
+ },
12164
+ "check_suite_id": {
12165
+ "type": "integer",
12166
+ "description": "The ID of the associated check suite.",
12167
+ "example": 42
12168
+ },
12169
+ "check_suite_node_id": {
12170
+ "type": "string",
12171
+ "description": "The node ID of the associated check suite.",
12172
+ "example": "MDEwOkNoZWNrU3VpdGU0Mg=="
12173
+ },
12174
+ "head_branch": {
12175
+ "type": "string",
12176
+ "nullable": true,
12177
+ "example": "master"
12178
+ },
12179
+ "head_sha": {
12180
+ "description": "The SHA of the head commit that points to the version of the workflow being run.",
12181
+ "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d",
12182
+ "type": "string"
12183
+ },
12184
+ "path": {
12185
+ "description": "The full path of the workflow",
12186
+ "example": "octocat/octo-repo/.github/workflows/ci.yml@main",
12187
+ "type": "string"
12188
+ },
12189
+ "run_number": {
12190
+ "type": "integer",
12191
+ "description": "The auto incrementing run number for the workflow run.",
12192
+ "example": 106
12193
+ },
12194
+ "run_attempt": {
12195
+ "type": "integer",
12196
+ "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was re-run.",
12197
+ "example": 1
12198
+ },
12199
+ "referenced_workflows": {
12200
+ "type": "array",
12201
+ "nullable": true,
12202
+ "items": {
12203
+ "$ref": "#/components/schemas/referenced-workflow"
12204
+ }
12205
+ },
12206
+ "event": {
12207
+ "type": "string",
12208
+ "example": "push"
12209
+ },
12210
+ "status": {
12211
+ "type": "string",
12212
+ "nullable": true,
12213
+ "example": "completed"
12214
+ },
12215
+ "conclusion": {
12216
+ "type": "string",
12217
+ "nullable": true,
12218
+ "example": "neutral"
12219
+ },
12220
+ "workflow_id": {
12221
+ "type": "integer",
12222
+ "description": "The ID of the parent workflow.",
12223
+ "example": 5
12224
+ },
12225
+ "url": {
12226
+ "type": "string",
12227
+ "description": "The URL to the workflow run.",
12228
+ "example": "https://api.github.com/repos/github/hello-world/actions/runs/5"
12229
+ },
12230
+ "html_url": {
12231
+ "type": "string",
12232
+ "example": "https://github.com/github/hello-world/suites/4"
12233
+ },
12234
+ "pull_requests": {
12235
+ "type": "array",
12236
+ "nullable": true,
12237
+ "items": {
12238
+ "$ref": "#/components/schemas/pull-request-minimal"
12239
+ }
12240
+ },
12241
+ "created_at": {
12242
+ "type": "string",
12243
+ "format": "date-time"
12244
+ },
12245
+ "updated_at": {
12246
+ "type": "string",
12247
+ "format": "date-time"
12248
+ },
12249
+ "actor": {
12250
+ "$ref": "#/components/schemas/simple-user"
12251
+ },
12252
+ "triggering_actor": {
12253
+ "$ref": "#/components/schemas/simple-user"
12254
+ },
12255
+ "run_started_at": {
12256
+ "type": "string",
12257
+ "format": "date-time",
12258
+ "description": "The start time of the latest run. Resets on re-run."
12259
+ },
12260
+ "jobs_url": {
12261
+ "description": "The URL to the jobs for the workflow run.",
12262
+ "type": "string",
12263
+ "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/jobs"
12264
+ },
12265
+ "logs_url": {
12266
+ "description": "The URL to download the logs for the workflow run.",
12267
+ "type": "string",
12268
+ "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/logs"
12269
+ },
12270
+ "check_suite_url": {
12271
+ "description": "The URL to the associated check suite.",
12272
+ "type": "string",
12273
+ "example": "https://api.github.com/repos/github/hello-world/check-suites/12"
12274
+ },
12275
+ "artifacts_url": {
12276
+ "description": "The URL to the artifacts for the workflow run.",
12277
+ "type": "string",
12278
+ "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts"
12279
+ },
12280
+ "cancel_url": {
12281
+ "description": "The URL to cancel the workflow run.",
12282
+ "type": "string",
12283
+ "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/cancel"
12284
+ },
12285
+ "rerun_url": {
12286
+ "description": "The URL to rerun the workflow run.",
12287
+ "type": "string",
12288
+ "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun"
12289
+ },
12290
+ "previous_attempt_url": {
12291
+ "nullable": true,
12292
+ "description": "The URL to the previous attempted run of this workflow, if one exists.",
12293
+ "type": "string",
12294
+ "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3"
12295
+ },
12296
+ "workflow_url": {
12297
+ "description": "The URL to the workflow.",
12298
+ "type": "string",
12299
+ "example": "https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml"
12300
+ },
12301
+ "head_commit": {
12302
+ "$ref": "#/components/schemas/nullable-simple-commit"
12303
+ },
12304
+ "repository": {
12305
+ "$ref": "#/components/schemas/minimal-repository"
12306
+ },
12307
+ "head_repository": {
12308
+ "$ref": "#/components/schemas/minimal-repository"
12309
+ },
12310
+ "head_repository_id": {
11753
12311
  "type": "integer",
11754
- "example": 14
12312
+ "example": 5
11755
12313
  }
11756
12314
  },
11757
12315
  "required": [
11758
- "repo_cache_size_limit_in_gb"
12316
+ "id",
12317
+ "node_id",
12318
+ "head_branch",
12319
+ "run_number",
12320
+ "event",
12321
+ "status",
12322
+ "conclusion",
12323
+ "head_sha",
12324
+ "path",
12325
+ "workflow_id",
12326
+ "url",
12327
+ "html_url",
12328
+ "created_at",
12329
+ "updated_at",
12330
+ "head_commit",
12331
+ "head_repository",
12332
+ "repository",
12333
+ "jobs_url",
12334
+ "logs_url",
12335
+ "check_suite_url",
12336
+ "cancel_url",
12337
+ "rerun_url",
12338
+ "artifacts_url",
12339
+ "workflow_url",
12340
+ "pull_requests"
11759
12341
  ]
11760
12342
  },
11761
12343
  "autolink": {
@@ -14765,8 +15347,9 @@
14765
15347
  },
14766
15348
  "use_squash_pr_title_as_default": {
14767
15349
  "type": "boolean",
14768
- "description": "Whether a squash merge commit can use the pull request title as default.",
14769
- "default": false
15350
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
15351
+ "default": false,
15352
+ "deprecated": true
14770
15353
  },
14771
15354
  "squash_merge_commit_title": {
14772
15355
  "type": "string",
@@ -15682,6 +16265,179 @@
15682
16265
  "used"
15683
16266
  ]
15684
16267
  },
16268
+ "referenced-workflow": {
16269
+ "title": "Referenced workflow",
16270
+ "description": "A workflow referenced/reused by the initial caller workflow",
16271
+ "type": "object",
16272
+ "properties": {
16273
+ "path": {
16274
+ "type": "string"
16275
+ },
16276
+ "sha": {
16277
+ "type": "string"
16278
+ },
16279
+ "ref": {
16280
+ "type": "string"
16281
+ }
16282
+ },
16283
+ "required": [
16284
+ "path",
16285
+ "sha"
16286
+ ]
16287
+ },
16288
+ "pull-request-minimal": {
16289
+ "title": "Pull Request Minimal",
16290
+ "type": "object",
16291
+ "properties": {
16292
+ "id": {
16293
+ "type": "integer"
16294
+ },
16295
+ "number": {
16296
+ "type": "integer"
16297
+ },
16298
+ "url": {
16299
+ "type": "string"
16300
+ },
16301
+ "head": {
16302
+ "type": "object",
16303
+ "properties": {
16304
+ "ref": {
16305
+ "type": "string"
16306
+ },
16307
+ "sha": {
16308
+ "type": "string"
16309
+ },
16310
+ "repo": {
16311
+ "type": "object",
16312
+ "properties": {
16313
+ "id": {
16314
+ "type": "integer"
16315
+ },
16316
+ "url": {
16317
+ "type": "string"
16318
+ },
16319
+ "name": {
16320
+ "type": "string"
16321
+ }
16322
+ },
16323
+ "required": [
16324
+ "id",
16325
+ "url",
16326
+ "name"
16327
+ ]
16328
+ }
16329
+ },
16330
+ "required": [
16331
+ "ref",
16332
+ "sha",
16333
+ "repo"
16334
+ ]
16335
+ },
16336
+ "base": {
16337
+ "type": "object",
16338
+ "properties": {
16339
+ "ref": {
16340
+ "type": "string"
16341
+ },
16342
+ "sha": {
16343
+ "type": "string"
16344
+ },
16345
+ "repo": {
16346
+ "type": "object",
16347
+ "properties": {
16348
+ "id": {
16349
+ "type": "integer"
16350
+ },
16351
+ "url": {
16352
+ "type": "string"
16353
+ },
16354
+ "name": {
16355
+ "type": "string"
16356
+ }
16357
+ },
16358
+ "required": [
16359
+ "id",
16360
+ "url",
16361
+ "name"
16362
+ ]
16363
+ }
16364
+ },
16365
+ "required": [
16366
+ "ref",
16367
+ "sha",
16368
+ "repo"
16369
+ ]
16370
+ }
16371
+ },
16372
+ "required": [
16373
+ "id",
16374
+ "number",
16375
+ "url",
16376
+ "head",
16377
+ "base"
16378
+ ]
16379
+ },
16380
+ "nullable-simple-commit": {
16381
+ "title": "Simple Commit",
16382
+ "description": "Simple Commit",
16383
+ "type": "object",
16384
+ "properties": {
16385
+ "id": {
16386
+ "type": "string"
16387
+ },
16388
+ "tree_id": {
16389
+ "type": "string"
16390
+ },
16391
+ "message": {
16392
+ "type": "string"
16393
+ },
16394
+ "timestamp": {
16395
+ "type": "string",
16396
+ "format": "date-time"
16397
+ },
16398
+ "author": {
16399
+ "type": "object",
16400
+ "properties": {
16401
+ "name": {
16402
+ "type": "string"
16403
+ },
16404
+ "email": {
16405
+ "type": "string"
16406
+ }
16407
+ },
16408
+ "required": [
16409
+ "name",
16410
+ "email"
16411
+ ],
16412
+ "nullable": true
16413
+ },
16414
+ "committer": {
16415
+ "type": "object",
16416
+ "properties": {
16417
+ "name": {
16418
+ "type": "string"
16419
+ },
16420
+ "email": {
16421
+ "type": "string"
16422
+ }
16423
+ },
16424
+ "required": [
16425
+ "name",
16426
+ "email"
16427
+ ],
16428
+ "nullable": true
16429
+ }
16430
+ },
16431
+ "required": [
16432
+ "id",
16433
+ "tree_id",
16434
+ "message",
16435
+ "timestamp",
16436
+ "author",
16437
+ "committer"
16438
+ ],
16439
+ "nullable": true
16440
+ },
15685
16441
  "code-scanning-analysis-tool-name": {
15686
16442
  "type": "string",
15687
16443
  "description": "The name of the tool used to generate the code scanning analysis."
@@ -16655,8 +17411,9 @@
16655
17411
  },
16656
17412
  "use_squash_pr_title_as_default": {
16657
17413
  "type": "boolean",
16658
- "description": "Whether a squash merge commit can use the pull request title as default.",
16659
- "default": false
17414
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
17415
+ "default": false,
17416
+ "deprecated": true
16660
17417
  },
16661
17418
  "squash_merge_commit_title": {
16662
17419
  "type": "string",
@@ -18107,6 +18864,21 @@
18107
18864
  "installed_version": "3.6.0"
18108
18865
  }
18109
18866
  },
18867
+ "organization-custom-repository-role-example": {
18868
+ "value": {
18869
+ "total_count": 2,
18870
+ "custom_roles": [
18871
+ {
18872
+ "id": 8030,
18873
+ "name": "Developer"
18874
+ },
18875
+ {
18876
+ "id": 8031,
18877
+ "name": "Designer"
18878
+ }
18879
+ ]
18880
+ }
18881
+ },
18110
18882
  "organization-full-default-response": {
18111
18883
  "summary": "Default response",
18112
18884
  "value": {
@@ -18801,6 +19573,231 @@
18801
19573
  "repo_cache_size_limit_in_gb": 14
18802
19574
  }
18803
19575
  },
19576
+ "workflow-run-paginated": {
19577
+ "value": {
19578
+ "total_count": 1,
19579
+ "workflow_runs": [
19580
+ {
19581
+ "id": 30433642,
19582
+ "name": "Build",
19583
+ "node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==",
19584
+ "check_suite_id": 42,
19585
+ "check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==",
19586
+ "head_branch": "master",
19587
+ "head_sha": "acb5820ced9479c074f688cc328bf03f341a511d",
19588
+ "run_number": 562,
19589
+ "event": "push",
19590
+ "status": "queued",
19591
+ "conclusion": null,
19592
+ "workflow_id": 159038,
19593
+ "url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642",
19594
+ "html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642",
19595
+ "pull_requests": [],
19596
+ "created_at": "2020-01-22T19:33:08Z",
19597
+ "updated_at": "2020-01-22T19:33:08Z",
19598
+ "actor": {
19599
+ "login": "octocat",
19600
+ "id": 1,
19601
+ "node_id": "MDQ6VXNlcjE=",
19602
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
19603
+ "gravatar_id": "",
19604
+ "url": "https://api.github.com/users/octocat",
19605
+ "html_url": "https://github.com/octocat",
19606
+ "followers_url": "https://api.github.com/users/octocat/followers",
19607
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
19608
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
19609
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
19610
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
19611
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
19612
+ "repos_url": "https://api.github.com/users/octocat/repos",
19613
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
19614
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
19615
+ "type": "User",
19616
+ "site_admin": false
19617
+ },
19618
+ "run_attempt": 1,
19619
+ "run_started_at": "2020-01-22T19:33:08Z",
19620
+ "triggering_actor": {
19621
+ "login": "octocat",
19622
+ "id": 1,
19623
+ "node_id": "MDQ6VXNlcjE=",
19624
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
19625
+ "gravatar_id": "",
19626
+ "url": "https://api.github.com/users/octocat",
19627
+ "html_url": "https://github.com/octocat",
19628
+ "followers_url": "https://api.github.com/users/octocat/followers",
19629
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
19630
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
19631
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
19632
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
19633
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
19634
+ "repos_url": "https://api.github.com/users/octocat/repos",
19635
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
19636
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
19637
+ "type": "User",
19638
+ "site_admin": false
19639
+ },
19640
+ "jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs",
19641
+ "logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs",
19642
+ "check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374",
19643
+ "artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts",
19644
+ "cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel",
19645
+ "rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun",
19646
+ "workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038",
19647
+ "head_commit": {
19648
+ "id": "acb5820ced9479c074f688cc328bf03f341a511d",
19649
+ "tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223",
19650
+ "message": "Create linter.yaml",
19651
+ "timestamp": "2020-01-22T19:33:05Z",
19652
+ "author": {
19653
+ "name": "Octo Cat",
19654
+ "email": "octocat@github.com"
19655
+ },
19656
+ "committer": {
19657
+ "name": "GitHub",
19658
+ "email": "noreply@github.com"
19659
+ }
19660
+ },
19661
+ "repository": {
19662
+ "id": 1296269,
19663
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
19664
+ "name": "Hello-World",
19665
+ "full_name": "octocat/Hello-World",
19666
+ "owner": {
19667
+ "login": "octocat",
19668
+ "id": 1,
19669
+ "node_id": "MDQ6VXNlcjE=",
19670
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
19671
+ "gravatar_id": "",
19672
+ "url": "https://api.github.com/users/octocat",
19673
+ "html_url": "https://github.com/octocat",
19674
+ "followers_url": "https://api.github.com/users/octocat/followers",
19675
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
19676
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
19677
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
19678
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
19679
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
19680
+ "repos_url": "https://api.github.com/users/octocat/repos",
19681
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
19682
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
19683
+ "type": "User",
19684
+ "site_admin": false
19685
+ },
19686
+ "private": false,
19687
+ "html_url": "https://github.com/octocat/Hello-World",
19688
+ "description": "This your first repo!",
19689
+ "fork": false,
19690
+ "url": "https://api.github.com/repos/octocat/Hello-World",
19691
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
19692
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
19693
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
19694
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
19695
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
19696
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
19697
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
19698
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
19699
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
19700
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
19701
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
19702
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
19703
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
19704
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
19705
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
19706
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
19707
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
19708
+ "git_url": "git:github.com/octocat/Hello-World.git",
19709
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
19710
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
19711
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
19712
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
19713
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
19714
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
19715
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
19716
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
19717
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
19718
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
19719
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
19720
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
19721
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
19722
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
19723
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
19724
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
19725
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
19726
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
19727
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
19728
+ "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
19729
+ },
19730
+ "head_repository": {
19731
+ "id": 217723378,
19732
+ "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=",
19733
+ "name": "octo-repo",
19734
+ "full_name": "octo-org/octo-repo",
19735
+ "private": true,
19736
+ "owner": {
19737
+ "login": "octocat",
19738
+ "id": 1,
19739
+ "node_id": "MDQ6VXNlcjE=",
19740
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
19741
+ "gravatar_id": "",
19742
+ "url": "https://api.github.com/users/octocat",
19743
+ "html_url": "https://github.com/octocat",
19744
+ "followers_url": "https://api.github.com/users/octocat/followers",
19745
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
19746
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
19747
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
19748
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
19749
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
19750
+ "repos_url": "https://api.github.com/users/octocat/repos",
19751
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
19752
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
19753
+ "type": "User",
19754
+ "site_admin": false
19755
+ },
19756
+ "html_url": "https://github.com/octo-org/octo-repo",
19757
+ "description": null,
19758
+ "fork": false,
19759
+ "url": "https://api.github.com/repos/octo-org/octo-repo",
19760
+ "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
19761
+ "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
19762
+ "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
19763
+ "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
19764
+ "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
19765
+ "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
19766
+ "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
19767
+ "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
19768
+ "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
19769
+ "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
19770
+ "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
19771
+ "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
19772
+ "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
19773
+ "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
19774
+ "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
19775
+ "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
19776
+ "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
19777
+ "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
19778
+ "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
19779
+ "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
19780
+ "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
19781
+ "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
19782
+ "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
19783
+ "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
19784
+ "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
19785
+ "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
19786
+ "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
19787
+ "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
19788
+ "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
19789
+ "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
19790
+ "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
19791
+ "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
19792
+ "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
19793
+ "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
19794
+ "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
19795
+ "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments"
19796
+ }
19797
+ }
19798
+ ]
19799
+ }
19800
+ },
18804
19801
  "autolink-items": {
18805
19802
  "value": [
18806
19803
  {