@octokit/openapi 5.7.0 → 5.8.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.
- package/generated/api.github.com.deref.json +31 -3
- package/generated/api.github.com.json +16 -5
- package/generated/ghes-2.22-diff-to-ghes-3.0.deref.json +1 -1
- package/generated/ghes-2.22-diff-to-ghes-3.0.json +1 -1
- package/generated/ghes-2.22.deref.json +1 -1
- package/generated/ghes-2.22.json +1 -1
- package/generated/ghes-3.0-anicca-diff-to-ghes-3.1.deref.json +145 -0
- package/generated/ghes-3.0-diff-to-ghes-3.1.deref.json +14378 -3642
- package/generated/ghes-3.0-diff-to-ghes-3.1.json +1522 -240
- package/generated/ghes-3.0.deref.json +47 -26
- package/generated/ghes-3.0.json +39 -29
- package/generated/ghes-3.1-anicca-diff-to-ghes-3.2.deref.json +1292 -111
- package/generated/ghes-3.1-diff-to-ghes-3.2.deref.json +72178 -24463
- package/generated/ghes-3.1-diff-to-ghes-3.2.json +8486 -3212
- package/generated/ghes-3.1.deref.json +78 -57
- package/generated/ghes-3.1.json +70 -60
- package/generated/ghes-3.2-anicca-diff-to-api.github.com.deref.json +152 -0
- package/generated/ghes-3.2-diff-to-api.github.com.deref.json +3162 -894
- package/generated/ghes-3.2-diff-to-api.github.com.json +931 -100
- package/generated/ghes-3.2.deref.json +48 -27
- package/generated/ghes-3.2.json +54 -30
- package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +52 -22
- package/generated/github.ae-diff-to-api.github.com.deref.json +4920 -29
- package/generated/github.ae-diff-to-api.github.com.json +2883 -282
- package/generated/github.ae.deref.json +42 -10
- package/generated/github.ae.json +26 -11
- package/package.json +1 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "5.
|
|
4
|
+
"version": "5.8.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" },
|
|
@@ -6476,6 +6476,65 @@
|
|
|
6476
6476
|
"subcategory": "actions"
|
|
6477
6477
|
},
|
|
6478
6478
|
"x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
|
|
6479
|
+
},
|
|
6480
|
+
"put": {
|
|
6481
|
+
"summary": "Set allowed actions for an enterprise",
|
|
6482
|
+
"description": "Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
6483
|
+
"operationId": "enterprise-admin/set-allowed-actions-enterprise",
|
|
6484
|
+
"tags": ["enterprise-admin"],
|
|
6485
|
+
"externalDocs": {
|
|
6486
|
+
"description": "API method documentation",
|
|
6487
|
+
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#set-allowed-actions-for-an-enterprise"
|
|
6488
|
+
},
|
|
6489
|
+
"parameters": [
|
|
6490
|
+
{
|
|
6491
|
+
"name": "enterprise",
|
|
6492
|
+
"description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
|
|
6493
|
+
"in": "path",
|
|
6494
|
+
"required": true,
|
|
6495
|
+
"schema": { "type": "string" }
|
|
6496
|
+
}
|
|
6497
|
+
],
|
|
6498
|
+
"responses": { "204": { "description": "Response" } },
|
|
6499
|
+
"requestBody": {
|
|
6500
|
+
"required": true,
|
|
6501
|
+
"content": {
|
|
6502
|
+
"application/json": {
|
|
6503
|
+
"schema": {
|
|
6504
|
+
"type": "object",
|
|
6505
|
+
"properties": {
|
|
6506
|
+
"github_owned_allowed": {
|
|
6507
|
+
"type": "boolean",
|
|
6508
|
+
"description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization."
|
|
6509
|
+
},
|
|
6510
|
+
"patterns_allowed": {
|
|
6511
|
+
"type": "array",
|
|
6512
|
+
"description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
|
|
6513
|
+
"items": { "type": "string" }
|
|
6514
|
+
}
|
|
6515
|
+
},
|
|
6516
|
+
"required": ["github_owned_allowed", "patterns_allowed"]
|
|
6517
|
+
},
|
|
6518
|
+
"examples": {
|
|
6519
|
+
"selected_actions": {
|
|
6520
|
+
"value": {
|
|
6521
|
+
"github_owned_allowed": true,
|
|
6522
|
+
"verified_allowed": false,
|
|
6523
|
+
"patterns_allowed": ["monalisa/octocat@*", "docker/*"]
|
|
6524
|
+
}
|
|
6525
|
+
}
|
|
6526
|
+
}
|
|
6527
|
+
}
|
|
6528
|
+
}
|
|
6529
|
+
},
|
|
6530
|
+
"x-github": {
|
|
6531
|
+
"enabledForGitHubApps": false,
|
|
6532
|
+
"githubCloudOnly": false,
|
|
6533
|
+
"previews": [],
|
|
6534
|
+
"category": "enterprise-admin",
|
|
6535
|
+
"subcategory": "actions"
|
|
6536
|
+
},
|
|
6537
|
+
"x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
|
|
6479
6538
|
}
|
|
6480
6539
|
},
|
|
6481
6540
|
"/meta": {
|
|
@@ -6549,15 +6608,15 @@
|
|
|
6549
6608
|
"x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
|
|
6550
6609
|
}
|
|
6551
6610
|
},
|
|
6552
|
-
"/orgs/{org}
|
|
6553
|
-
"
|
|
6554
|
-
"summary": "
|
|
6555
|
-
"description": "
|
|
6556
|
-
"
|
|
6557
|
-
"
|
|
6611
|
+
"/orgs/{org}": {
|
|
6612
|
+
"patch": {
|
|
6613
|
+
"summary": "Update an organization",
|
|
6614
|
+
"description": "**Parameter Deprecation Notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nEnables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges.",
|
|
6615
|
+
"tags": ["orgs"],
|
|
6616
|
+
"operationId": "orgs/update",
|
|
6558
6617
|
"externalDocs": {
|
|
6559
6618
|
"description": "API method documentation",
|
|
6560
|
-
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/
|
|
6619
|
+
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs/#update-an-organization"
|
|
6561
6620
|
},
|
|
6562
6621
|
"parameters": [
|
|
6563
6622
|
{
|
|
@@ -6567,230 +6626,474 @@
|
|
|
6567
6626
|
"schema": { "type": "string" }
|
|
6568
6627
|
}
|
|
6569
6628
|
],
|
|
6570
|
-
"
|
|
6571
|
-
"
|
|
6572
|
-
"
|
|
6573
|
-
|
|
6574
|
-
|
|
6575
|
-
"
|
|
6576
|
-
"
|
|
6577
|
-
|
|
6578
|
-
"
|
|
6579
|
-
"type": "boolean",
|
|
6580
|
-
"description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization."
|
|
6581
|
-
},
|
|
6582
|
-
"patterns_allowed": {
|
|
6583
|
-
"type": "array",
|
|
6584
|
-
"description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
|
|
6585
|
-
"items": { "type": "string" }
|
|
6586
|
-
}
|
|
6629
|
+
"requestBody": {
|
|
6630
|
+
"content": {
|
|
6631
|
+
"application/json": {
|
|
6632
|
+
"schema": {
|
|
6633
|
+
"type": "object",
|
|
6634
|
+
"properties": {
|
|
6635
|
+
"billing_email": {
|
|
6636
|
+
"type": "string",
|
|
6637
|
+
"description": "Billing email address. This address is not publicized."
|
|
6587
6638
|
},
|
|
6588
|
-
"
|
|
6589
|
-
|
|
6590
|
-
|
|
6591
|
-
|
|
6592
|
-
|
|
6593
|
-
|
|
6594
|
-
|
|
6595
|
-
|
|
6596
|
-
|
|
6639
|
+
"company": {
|
|
6640
|
+
"type": "string",
|
|
6641
|
+
"description": "The company name."
|
|
6642
|
+
},
|
|
6643
|
+
"email": {
|
|
6644
|
+
"type": "string",
|
|
6645
|
+
"description": "The publicly visible email address."
|
|
6646
|
+
},
|
|
6647
|
+
"twitter_username": {
|
|
6648
|
+
"type": "string",
|
|
6649
|
+
"description": "The Twitter username of the company."
|
|
6650
|
+
},
|
|
6651
|
+
"location": {
|
|
6652
|
+
"type": "string",
|
|
6653
|
+
"description": "The location."
|
|
6654
|
+
},
|
|
6655
|
+
"name": {
|
|
6656
|
+
"type": "string",
|
|
6657
|
+
"description": "The shorthand name of the company."
|
|
6658
|
+
},
|
|
6659
|
+
"description": {
|
|
6660
|
+
"type": "string",
|
|
6661
|
+
"description": "The description of the company."
|
|
6662
|
+
},
|
|
6663
|
+
"has_organization_projects": {
|
|
6664
|
+
"type": "boolean",
|
|
6665
|
+
"description": "Toggles whether an organization can use organization projects."
|
|
6666
|
+
},
|
|
6667
|
+
"has_repository_projects": {
|
|
6668
|
+
"type": "boolean",
|
|
6669
|
+
"description": "Toggles whether repositories that belong to the organization can use repository projects."
|
|
6670
|
+
},
|
|
6671
|
+
"default_repository_permission": {
|
|
6672
|
+
"type": "string",
|
|
6673
|
+
"description": "Default permission level members have for organization repositories: \n\\* `read` - can pull, but not push to or administer this repository. \n\\* `write` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push, and administer this repository. \n\\* `none` - no permissions granted by default.",
|
|
6674
|
+
"enum": ["read", "write", "admin", "none"],
|
|
6675
|
+
"default": "read"
|
|
6676
|
+
},
|
|
6677
|
+
"members_can_create_repositories": {
|
|
6678
|
+
"type": "boolean",
|
|
6679
|
+
"description": "Toggles the ability of non-admin organization members to create repositories. Can be one of: \n\\* `true` - all organization members can create repositories. \n\\* `false` - only organization owners can create repositories. \nDefault: `true` \n**Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.",
|
|
6680
|
+
"default": true
|
|
6681
|
+
},
|
|
6682
|
+
"members_can_create_internal_repositories": {
|
|
6683
|
+
"type": "boolean",
|
|
6684
|
+
"description": "Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of: \n\\* `true` - all organization members can create internal repositories. \n\\* `false` - only organization owners can create internal repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation."
|
|
6685
|
+
},
|
|
6686
|
+
"members_can_create_private_repositories": {
|
|
6687
|
+
"type": "boolean",
|
|
6688
|
+
"description": "Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: \n\\* `true` - all organization members can create private repositories. \n\\* `false` - only organization owners can create private repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation."
|
|
6689
|
+
},
|
|
6690
|
+
"members_can_create_public_repositories": {
|
|
6691
|
+
"type": "boolean",
|
|
6692
|
+
"description": "Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: \n\\* `true` - all organization members can create public repositories. \n\\* `false` - only organization owners can create public repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation."
|
|
6693
|
+
},
|
|
6694
|
+
"members_allowed_repository_creation_type": {
|
|
6695
|
+
"type": "string",
|
|
6696
|
+
"description": "Specifies which types of repositories non-admin organization members can create. Can be one of: \n\\* `all` - all organization members can create public and private repositories. \n\\* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n\\* `none` - only admin members can create repositories. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.",
|
|
6697
|
+
"enum": ["all", "private", "none"]
|
|
6698
|
+
},
|
|
6699
|
+
"members_can_create_pages": {
|
|
6700
|
+
"type": "boolean",
|
|
6701
|
+
"description": "Toggles whether organization members can create GitHub Pages sites. Can be one of: \n\\* `true` - all organization members can create GitHub Pages sites. \n\\* `false` - no organization members can create GitHub Pages sites. Existing published sites will not be impacted.",
|
|
6702
|
+
"default": true
|
|
6703
|
+
},
|
|
6704
|
+
"blog": {
|
|
6705
|
+
"type": "string",
|
|
6706
|
+
"example": "\"http://github.blog\""
|
|
6597
6707
|
}
|
|
6598
6708
|
}
|
|
6709
|
+
},
|
|
6710
|
+
"example": {
|
|
6711
|
+
"billing_email": "mona@github.com",
|
|
6712
|
+
"company": "GitHub",
|
|
6713
|
+
"email": "mona@github.com",
|
|
6714
|
+
"twitter_username": "github",
|
|
6715
|
+
"location": "San Francisco",
|
|
6716
|
+
"name": "github",
|
|
6717
|
+
"description": "GitHub, the company.",
|
|
6718
|
+
"default_repository_permission": "read",
|
|
6719
|
+
"members_can_create_repositories": true,
|
|
6720
|
+
"members_allowed_repository_creation_type": "all"
|
|
6599
6721
|
}
|
|
6600
6722
|
}
|
|
6601
6723
|
}
|
|
6602
6724
|
},
|
|
6603
|
-
"x-github": {
|
|
6604
|
-
"enabledForGitHubApps": true,
|
|
6605
|
-
"githubCloudOnly": false,
|
|
6606
|
-
"previews": [],
|
|
6607
|
-
"category": "actions",
|
|
6608
|
-
"subcategory": "permissions"
|
|
6609
|
-
},
|
|
6610
|
-
"x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
|
|
6611
|
-
}
|
|
6612
|
-
},
|
|
6613
|
-
"/orgs/{org}/pre-receive-hooks": {
|
|
6614
|
-
"get": {
|
|
6615
|
-
"summary": "List pre-receive hooks for an organization",
|
|
6616
|
-
"description": "List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.",
|
|
6617
|
-
"operationId": "enterprise-admin/list-pre-receive-hooks-for-org",
|
|
6618
|
-
"tags": ["enterprise-admin"],
|
|
6619
|
-
"externalDocs": {
|
|
6620
|
-
"description": "API method documentation",
|
|
6621
|
-
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#list-pre-receive-hooks-for-an-organization"
|
|
6622
|
-
},
|
|
6623
|
-
"parameters": [
|
|
6624
|
-
{
|
|
6625
|
-
"name": "org",
|
|
6626
|
-
"in": "path",
|
|
6627
|
-
"required": true,
|
|
6628
|
-
"schema": { "type": "string" }
|
|
6629
|
-
},
|
|
6630
|
-
{
|
|
6631
|
-
"name": "per_page",
|
|
6632
|
-
"description": "Results per page (max 100)",
|
|
6633
|
-
"in": "query",
|
|
6634
|
-
"schema": { "type": "integer", "default": 30 }
|
|
6635
|
-
},
|
|
6636
|
-
{
|
|
6637
|
-
"name": "page",
|
|
6638
|
-
"description": "Page number of the results to fetch.",
|
|
6639
|
-
"in": "query",
|
|
6640
|
-
"schema": { "type": "integer", "default": 1 }
|
|
6641
|
-
},
|
|
6642
|
-
{
|
|
6643
|
-
"name": "direction",
|
|
6644
|
-
"description": "One of `asc` (ascending) or `desc` (descending).",
|
|
6645
|
-
"in": "query",
|
|
6646
|
-
"required": false,
|
|
6647
|
-
"schema": {
|
|
6648
|
-
"type": "string",
|
|
6649
|
-
"enum": ["asc", "desc"],
|
|
6650
|
-
"default": "desc"
|
|
6651
|
-
}
|
|
6652
|
-
},
|
|
6653
|
-
{
|
|
6654
|
-
"name": "sort",
|
|
6655
|
-
"description": "The sort order for the response collection.",
|
|
6656
|
-
"in": "query",
|
|
6657
|
-
"required": false,
|
|
6658
|
-
"schema": {
|
|
6659
|
-
"type": "string",
|
|
6660
|
-
"enum": ["created", "updated", "name"],
|
|
6661
|
-
"default": "created"
|
|
6662
|
-
}
|
|
6663
|
-
}
|
|
6664
|
-
],
|
|
6665
|
-
"responses": {
|
|
6666
|
-
"200": {
|
|
6667
|
-
"description": "Response",
|
|
6668
|
-
"content": {
|
|
6669
|
-
"application/json": {
|
|
6670
|
-
"schema": {
|
|
6671
|
-
"type": "array",
|
|
6672
|
-
"items": {
|
|
6673
|
-
"type": "object",
|
|
6674
|
-
"properties": {
|
|
6675
|
-
"id": { "type": "integer" },
|
|
6676
|
-
"name": { "type": "string" },
|
|
6677
|
-
"enforcement": { "type": "string" },
|
|
6678
|
-
"configuration_url": { "type": "string" },
|
|
6679
|
-
"allow_downstream_configuration": { "type": "boolean" }
|
|
6680
|
-
}
|
|
6681
|
-
}
|
|
6682
|
-
},
|
|
6683
|
-
"examples": {
|
|
6684
|
-
"default": {
|
|
6685
|
-
"value": [
|
|
6686
|
-
{
|
|
6687
|
-
"id": 42,
|
|
6688
|
-
"name": "Check Commits",
|
|
6689
|
-
"enforcement": "disabled",
|
|
6690
|
-
"configuration_url": "https://github.example.com/api/v3/admin/pre-receive-hooks/42",
|
|
6691
|
-
"allow_downstream_configuration": true
|
|
6692
|
-
}
|
|
6693
|
-
]
|
|
6694
|
-
}
|
|
6695
|
-
}
|
|
6696
|
-
}
|
|
6697
|
-
}
|
|
6698
|
-
}
|
|
6699
|
-
},
|
|
6700
|
-
"x-github": {
|
|
6701
|
-
"githubCloudOnly": false,
|
|
6702
|
-
"enabledForGitHubApps": true,
|
|
6703
|
-
"previews": [
|
|
6704
|
-
{
|
|
6705
|
-
"required": true,
|
|
6706
|
-
"name": "eye-scream",
|
|
6707
|
-
"note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
|
|
6708
|
-
}
|
|
6709
|
-
],
|
|
6710
|
-
"category": "enterprise-admin",
|
|
6711
|
-
"subcategory": "org-pre-receive-hooks"
|
|
6712
|
-
},
|
|
6713
|
-
"x-octokit": { "diff": { "api.github.com": { "type": "added" } } }
|
|
6714
|
-
}
|
|
6715
|
-
},
|
|
6716
|
-
"/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}": {
|
|
6717
|
-
"get": {
|
|
6718
|
-
"summary": "Get a pre-receive hook for an organization",
|
|
6719
|
-
"description": "",
|
|
6720
|
-
"operationId": "enterprise-admin/get-pre-receive-hook-for-org",
|
|
6721
|
-
"tags": ["enterprise-admin"],
|
|
6722
|
-
"externalDocs": {
|
|
6723
|
-
"description": "API method documentation",
|
|
6724
|
-
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-an-organization"
|
|
6725
|
-
},
|
|
6726
|
-
"parameters": [
|
|
6727
|
-
{
|
|
6728
|
-
"name": "org",
|
|
6729
|
-
"in": "path",
|
|
6730
|
-
"required": true,
|
|
6731
|
-
"schema": { "type": "string" }
|
|
6732
|
-
},
|
|
6733
|
-
{
|
|
6734
|
-
"name": "pre_receive_hook_id",
|
|
6735
|
-
"description": "pre_receive_hook_id parameter",
|
|
6736
|
-
"in": "path",
|
|
6737
|
-
"required": true,
|
|
6738
|
-
"schema": { "type": "integer" }
|
|
6739
|
-
}
|
|
6740
|
-
],
|
|
6741
6725
|
"responses": {
|
|
6742
6726
|
"200": {
|
|
6743
6727
|
"description": "Response",
|
|
6744
6728
|
"content": {
|
|
6745
6729
|
"application/json": {
|
|
6746
6730
|
"schema": {
|
|
6731
|
+
"title": "Organization Full",
|
|
6732
|
+
"description": "Organization Full",
|
|
6747
6733
|
"type": "object",
|
|
6748
6734
|
"properties": {
|
|
6749
|
-
"
|
|
6750
|
-
"
|
|
6751
|
-
"
|
|
6752
|
-
|
|
6753
|
-
|
|
6754
|
-
|
|
6735
|
+
"login": { "type": "string", "example": "github" },
|
|
6736
|
+
"id": { "type": "integer", "example": 1 },
|
|
6737
|
+
"node_id": {
|
|
6738
|
+
"type": "string",
|
|
6739
|
+
"example": "MDEyOk9yZ2FuaXphdGlvbjE="
|
|
6740
|
+
},
|
|
6741
|
+
"url": {
|
|
6742
|
+
"type": "string",
|
|
6743
|
+
"format": "uri",
|
|
6744
|
+
"example": "https://api.github.com/orgs/github"
|
|
6745
|
+
},
|
|
6746
|
+
"repos_url": {
|
|
6747
|
+
"type": "string",
|
|
6748
|
+
"format": "uri",
|
|
6749
|
+
"example": "https://api.github.com/orgs/github/repos"
|
|
6750
|
+
},
|
|
6751
|
+
"events_url": {
|
|
6752
|
+
"type": "string",
|
|
6753
|
+
"format": "uri",
|
|
6754
|
+
"example": "https://api.github.com/orgs/github/events"
|
|
6755
|
+
},
|
|
6756
|
+
"hooks_url": {
|
|
6757
|
+
"type": "string",
|
|
6758
|
+
"example": "https://api.github.com/orgs/github/hooks"
|
|
6759
|
+
},
|
|
6760
|
+
"issues_url": {
|
|
6761
|
+
"type": "string",
|
|
6762
|
+
"example": "https://api.github.com/orgs/github/issues"
|
|
6763
|
+
},
|
|
6764
|
+
"members_url": {
|
|
6765
|
+
"type": "string",
|
|
6766
|
+
"example": "https://api.github.com/orgs/github/members{/member}"
|
|
6767
|
+
},
|
|
6768
|
+
"public_members_url": {
|
|
6769
|
+
"type": "string",
|
|
6770
|
+
"example": "https://api.github.com/orgs/github/public_members{/member}"
|
|
6771
|
+
},
|
|
6772
|
+
"avatar_url": {
|
|
6773
|
+
"type": "string",
|
|
6774
|
+
"example": "https://github.com/images/error/octocat_happy.gif"
|
|
6775
|
+
},
|
|
6776
|
+
"description": {
|
|
6777
|
+
"type": "string",
|
|
6778
|
+
"example": "A great organization",
|
|
6779
|
+
"nullable": true
|
|
6780
|
+
},
|
|
6781
|
+
"name": { "type": "string", "example": "github" },
|
|
6782
|
+
"company": { "type": "string", "example": "GitHub" },
|
|
6783
|
+
"blog": {
|
|
6784
|
+
"type": "string",
|
|
6785
|
+
"format": "uri",
|
|
6786
|
+
"example": "https://github.com/blog"
|
|
6787
|
+
},
|
|
6788
|
+
"location": {
|
|
6789
|
+
"type": "string",
|
|
6790
|
+
"example": "San Francisco"
|
|
6791
|
+
},
|
|
6792
|
+
"email": {
|
|
6793
|
+
"type": "string",
|
|
6794
|
+
"format": "email",
|
|
6795
|
+
"example": "octocat@github.com"
|
|
6796
|
+
},
|
|
6797
|
+
"twitter_username": {
|
|
6798
|
+
"type": "string",
|
|
6799
|
+
"example": "github",
|
|
6800
|
+
"nullable": true
|
|
6801
|
+
},
|
|
6802
|
+
"is_verified": { "type": "boolean", "example": true },
|
|
6803
|
+
"has_organization_projects": {
|
|
6804
|
+
"type": "boolean",
|
|
6805
|
+
"example": true
|
|
6806
|
+
},
|
|
6807
|
+
"has_repository_projects": {
|
|
6808
|
+
"type": "boolean",
|
|
6809
|
+
"example": true
|
|
6810
|
+
},
|
|
6811
|
+
"public_repos": { "type": "integer", "example": 2 },
|
|
6812
|
+
"public_gists": { "type": "integer", "example": 1 },
|
|
6813
|
+
"followers": { "type": "integer", "example": 20 },
|
|
6814
|
+
"following": { "type": "integer", "example": 0 },
|
|
6815
|
+
"html_url": {
|
|
6816
|
+
"type": "string",
|
|
6817
|
+
"format": "uri",
|
|
6818
|
+
"example": "https://github.com/octocat"
|
|
6819
|
+
},
|
|
6820
|
+
"created_at": {
|
|
6821
|
+
"type": "string",
|
|
6822
|
+
"format": "date-time",
|
|
6823
|
+
"example": "2008-01-14T04:33:35Z"
|
|
6824
|
+
},
|
|
6825
|
+
"type": { "type": "string", "example": "Organization" },
|
|
6826
|
+
"total_private_repos": {
|
|
6827
|
+
"type": "integer",
|
|
6828
|
+
"example": 100
|
|
6829
|
+
},
|
|
6830
|
+
"owned_private_repos": {
|
|
6831
|
+
"type": "integer",
|
|
6832
|
+
"example": 100
|
|
6833
|
+
},
|
|
6834
|
+
"private_gists": {
|
|
6835
|
+
"type": "integer",
|
|
6836
|
+
"example": 81,
|
|
6837
|
+
"nullable": true
|
|
6838
|
+
},
|
|
6839
|
+
"disk_usage": {
|
|
6840
|
+
"type": "integer",
|
|
6841
|
+
"example": 10000,
|
|
6842
|
+
"nullable": true
|
|
6843
|
+
},
|
|
6844
|
+
"collaborators": {
|
|
6845
|
+
"type": "integer",
|
|
6846
|
+
"example": 8,
|
|
6847
|
+
"nullable": true
|
|
6848
|
+
},
|
|
6849
|
+
"billing_email": {
|
|
6850
|
+
"type": "string",
|
|
6851
|
+
"format": "email",
|
|
6852
|
+
"example": "org@example.com",
|
|
6853
|
+
"nullable": true
|
|
6854
|
+
},
|
|
6855
|
+
"plan": {
|
|
6856
|
+
"type": "object",
|
|
6857
|
+
"properties": {
|
|
6858
|
+
"name": { "type": "string" },
|
|
6859
|
+
"space": { "type": "integer" },
|
|
6860
|
+
"private_repos": { "type": "integer" },
|
|
6861
|
+
"filled_seats": { "type": "integer" },
|
|
6862
|
+
"seats": { "type": "integer" }
|
|
6863
|
+
},
|
|
6864
|
+
"required": ["name", "space", "private_repos"]
|
|
6865
|
+
},
|
|
6866
|
+
"default_repository_permission": {
|
|
6867
|
+
"type": "string",
|
|
6868
|
+
"nullable": true
|
|
6869
|
+
},
|
|
6870
|
+
"members_can_create_repositories": {
|
|
6871
|
+
"type": "boolean",
|
|
6872
|
+
"example": true,
|
|
6873
|
+
"nullable": true
|
|
6874
|
+
},
|
|
6875
|
+
"two_factor_requirement_enabled": {
|
|
6876
|
+
"type": "boolean",
|
|
6877
|
+
"example": true,
|
|
6878
|
+
"nullable": true
|
|
6879
|
+
},
|
|
6880
|
+
"members_allowed_repository_creation_type": {
|
|
6881
|
+
"type": "string",
|
|
6882
|
+
"example": "all"
|
|
6883
|
+
},
|
|
6884
|
+
"members_can_create_public_repositories": {
|
|
6885
|
+
"type": "boolean",
|
|
6886
|
+
"example": true
|
|
6887
|
+
},
|
|
6888
|
+
"members_can_create_private_repositories": {
|
|
6889
|
+
"type": "boolean",
|
|
6890
|
+
"example": true
|
|
6891
|
+
},
|
|
6892
|
+
"members_can_create_internal_repositories": {
|
|
6893
|
+
"type": "boolean",
|
|
6894
|
+
"example": true
|
|
6895
|
+
},
|
|
6896
|
+
"members_can_create_pages": {
|
|
6897
|
+
"type": "boolean",
|
|
6898
|
+
"example": true
|
|
6899
|
+
},
|
|
6900
|
+
"members_can_create_public_pages": {
|
|
6901
|
+
"type": "boolean",
|
|
6902
|
+
"example": true
|
|
6903
|
+
},
|
|
6904
|
+
"members_can_create_private_pages": {
|
|
6905
|
+
"type": "boolean",
|
|
6906
|
+
"example": true
|
|
6907
|
+
},
|
|
6908
|
+
"updated_at": { "type": "string", "format": "date-time" }
|
|
6909
|
+
},
|
|
6910
|
+
"required": [
|
|
6911
|
+
"login",
|
|
6912
|
+
"url",
|
|
6913
|
+
"id",
|
|
6914
|
+
"node_id",
|
|
6915
|
+
"repos_url",
|
|
6916
|
+
"events_url",
|
|
6917
|
+
"hooks_url",
|
|
6918
|
+
"issues_url",
|
|
6919
|
+
"members_url",
|
|
6920
|
+
"public_members_url",
|
|
6921
|
+
"avatar_url",
|
|
6922
|
+
"description",
|
|
6923
|
+
"html_url",
|
|
6924
|
+
"has_organization_projects",
|
|
6925
|
+
"has_repository_projects",
|
|
6926
|
+
"public_repos",
|
|
6927
|
+
"public_gists",
|
|
6928
|
+
"followers",
|
|
6929
|
+
"following",
|
|
6930
|
+
"type",
|
|
6931
|
+
"created_at",
|
|
6932
|
+
"updated_at"
|
|
6933
|
+
]
|
|
6755
6934
|
},
|
|
6756
6935
|
"examples": {
|
|
6757
6936
|
"default": {
|
|
6758
6937
|
"value": {
|
|
6759
|
-
"
|
|
6760
|
-
"
|
|
6761
|
-
"
|
|
6762
|
-
"
|
|
6763
|
-
"
|
|
6938
|
+
"login": "github",
|
|
6939
|
+
"id": 1,
|
|
6940
|
+
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
|
|
6941
|
+
"url": "https://api.github.com/orgs/github",
|
|
6942
|
+
"repos_url": "https://api.github.com/orgs/github/repos",
|
|
6943
|
+
"events_url": "https://api.github.com/orgs/github/events",
|
|
6944
|
+
"hooks_url": "https://api.github.com/orgs/github/hooks",
|
|
6945
|
+
"issues_url": "https://api.github.com/orgs/github/issues",
|
|
6946
|
+
"members_url": "https://api.github.com/orgs/github/members{/member}",
|
|
6947
|
+
"public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
|
|
6948
|
+
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
|
|
6949
|
+
"description": "A great organization",
|
|
6950
|
+
"name": "github",
|
|
6951
|
+
"company": "GitHub",
|
|
6952
|
+
"blog": "https://github.com/blog",
|
|
6953
|
+
"location": "San Francisco",
|
|
6954
|
+
"email": "octocat@github.com",
|
|
6955
|
+
"twitter_username": "github",
|
|
6956
|
+
"is_verified": true,
|
|
6957
|
+
"has_organization_projects": true,
|
|
6958
|
+
"has_repository_projects": true,
|
|
6959
|
+
"public_repos": 2,
|
|
6960
|
+
"public_gists": 1,
|
|
6961
|
+
"followers": 20,
|
|
6962
|
+
"following": 0,
|
|
6963
|
+
"html_url": "https://github.com/octocat",
|
|
6964
|
+
"created_at": "2008-01-14T04:33:35Z",
|
|
6965
|
+
"type": "Organization",
|
|
6966
|
+
"total_private_repos": 100,
|
|
6967
|
+
"owned_private_repos": 100,
|
|
6968
|
+
"private_gists": 81,
|
|
6969
|
+
"disk_usage": 10000,
|
|
6970
|
+
"collaborators": 8,
|
|
6971
|
+
"billing_email": "mona@github.com",
|
|
6972
|
+
"plan": {
|
|
6973
|
+
"name": "Medium",
|
|
6974
|
+
"space": 400,
|
|
6975
|
+
"private_repos": 20
|
|
6976
|
+
},
|
|
6977
|
+
"default_repository_permission": "read",
|
|
6978
|
+
"members_can_create_repositories": true,
|
|
6979
|
+
"two_factor_requirement_enabled": true,
|
|
6980
|
+
"members_allowed_repository_creation_type": "all",
|
|
6981
|
+
"members_can_create_public_repositories": false,
|
|
6982
|
+
"members_can_create_private_repositories": false,
|
|
6983
|
+
"members_can_create_internal_repositories": false,
|
|
6984
|
+
"members_can_create_pages": true,
|
|
6985
|
+
"members_can_create_public_pages": true,
|
|
6986
|
+
"members_can_create_private_pages": true,
|
|
6987
|
+
"updated_at": "2014-03-03T18:58:10Z"
|
|
6764
6988
|
}
|
|
6765
6989
|
}
|
|
6766
6990
|
}
|
|
6767
6991
|
}
|
|
6768
6992
|
}
|
|
6993
|
+
},
|
|
6994
|
+
"409": {
|
|
6995
|
+
"description": "Conflict",
|
|
6996
|
+
"content": {
|
|
6997
|
+
"application/json": {
|
|
6998
|
+
"schema": {
|
|
6999
|
+
"title": "Basic Error",
|
|
7000
|
+
"description": "Basic Error",
|
|
7001
|
+
"type": "object",
|
|
7002
|
+
"properties": {
|
|
7003
|
+
"message": { "type": "string" },
|
|
7004
|
+
"documentation_url": { "type": "string" },
|
|
7005
|
+
"url": { "type": "string" },
|
|
7006
|
+
"status": { "type": "string" }
|
|
7007
|
+
}
|
|
7008
|
+
}
|
|
7009
|
+
}
|
|
7010
|
+
}
|
|
7011
|
+
},
|
|
7012
|
+
"422": {
|
|
7013
|
+
"description": "Validation failed",
|
|
7014
|
+
"content": {
|
|
7015
|
+
"application/json": {
|
|
7016
|
+
"schema": {
|
|
7017
|
+
"oneOf": [
|
|
7018
|
+
{
|
|
7019
|
+
"title": "Validation Error",
|
|
7020
|
+
"description": "Validation Error",
|
|
7021
|
+
"type": "object",
|
|
7022
|
+
"required": ["message", "documentation_url"],
|
|
7023
|
+
"properties": {
|
|
7024
|
+
"message": { "type": "string" },
|
|
7025
|
+
"documentation_url": { "type": "string" },
|
|
7026
|
+
"errors": {
|
|
7027
|
+
"type": "array",
|
|
7028
|
+
"items": {
|
|
7029
|
+
"type": "object",
|
|
7030
|
+
"required": ["code"],
|
|
7031
|
+
"properties": {
|
|
7032
|
+
"resource": { "type": "string" },
|
|
7033
|
+
"field": { "type": "string" },
|
|
7034
|
+
"message": { "type": "string" },
|
|
7035
|
+
"code": { "type": "string" },
|
|
7036
|
+
"index": { "type": "integer" },
|
|
7037
|
+
"value": {
|
|
7038
|
+
"oneOf": [
|
|
7039
|
+
{ "type": "string", "nullable": true },
|
|
7040
|
+
{ "type": "integer", "nullable": true },
|
|
7041
|
+
{
|
|
7042
|
+
"type": "array",
|
|
7043
|
+
"nullable": true,
|
|
7044
|
+
"items": { "type": "string" }
|
|
7045
|
+
}
|
|
7046
|
+
]
|
|
7047
|
+
}
|
|
7048
|
+
}
|
|
7049
|
+
}
|
|
7050
|
+
}
|
|
7051
|
+
}
|
|
7052
|
+
},
|
|
7053
|
+
{
|
|
7054
|
+
"title": "Validation Error Simple",
|
|
7055
|
+
"description": "Validation Error Simple",
|
|
7056
|
+
"type": "object",
|
|
7057
|
+
"required": ["message", "documentation_url"],
|
|
7058
|
+
"properties": {
|
|
7059
|
+
"message": { "type": "string" },
|
|
7060
|
+
"documentation_url": { "type": "string" },
|
|
7061
|
+
"errors": {
|
|
7062
|
+
"type": "array",
|
|
7063
|
+
"items": { "type": "string" }
|
|
7064
|
+
}
|
|
7065
|
+
}
|
|
7066
|
+
}
|
|
7067
|
+
]
|
|
7068
|
+
}
|
|
7069
|
+
}
|
|
7070
|
+
}
|
|
6769
7071
|
}
|
|
6770
7072
|
},
|
|
6771
7073
|
"x-github": {
|
|
6772
7074
|
"githubCloudOnly": false,
|
|
6773
7075
|
"enabledForGitHubApps": true,
|
|
7076
|
+
"category": "orgs",
|
|
6774
7077
|
"previews": [
|
|
6775
7078
|
{
|
|
6776
|
-
"required":
|
|
6777
|
-
"name": "
|
|
6778
|
-
"note": "
|
|
7079
|
+
"required": false,
|
|
7080
|
+
"name": "surtur",
|
|
7081
|
+
"note": "New repository creation permissions are available to preview. You can now use `members_can_create_public_repositories`, `members_can_create_private_repositories`, and `members_can_create_internal_repositories`. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. These parameters provide more granular permissions to configure the type of repositories organization members can create.\n\nTo access these new parameters during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.surtur-preview+json\n```"
|
|
6779
7082
|
}
|
|
6780
|
-
]
|
|
6781
|
-
"category": "enterprise-admin",
|
|
6782
|
-
"subcategory": "org-pre-receive-hooks"
|
|
7083
|
+
]
|
|
6783
7084
|
},
|
|
6784
|
-
"x-octokit": { "diff": { "api.github.com": { "type": "
|
|
6785
|
-
}
|
|
6786
|
-
|
|
6787
|
-
|
|
6788
|
-
|
|
6789
|
-
"
|
|
6790
|
-
"
|
|
7085
|
+
"x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
|
|
7086
|
+
}
|
|
7087
|
+
},
|
|
7088
|
+
"/orgs/{org}/actions/permissions/selected-actions": {
|
|
7089
|
+
"get": {
|
|
7090
|
+
"summary": "Get allowed actions for an organization",
|
|
7091
|
+
"description": "Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
|
|
7092
|
+
"operationId": "actions/get-allowed-actions-organization",
|
|
7093
|
+
"tags": ["actions"],
|
|
6791
7094
|
"externalDocs": {
|
|
6792
7095
|
"description": "API method documentation",
|
|
6793
|
-
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/
|
|
7096
|
+
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-allowed-actions-for-an-organization"
|
|
6794
7097
|
},
|
|
6795
7098
|
"parameters": [
|
|
6796
7099
|
{
|
|
@@ -6798,13 +7101,6 @@
|
|
|
6798
7101
|
"in": "path",
|
|
6799
7102
|
"required": true,
|
|
6800
7103
|
"schema": { "type": "string" }
|
|
6801
|
-
},
|
|
6802
|
-
{
|
|
6803
|
-
"name": "pre_receive_hook_id",
|
|
6804
|
-
"description": "pre_receive_hook_id parameter",
|
|
6805
|
-
"in": "path",
|
|
6806
|
-
"required": true,
|
|
6807
|
-
"schema": { "type": "integer" }
|
|
6808
7104
|
}
|
|
6809
7105
|
],
|
|
6810
7106
|
"responses": {
|
|
@@ -6815,21 +7111,24 @@
|
|
|
6815
7111
|
"schema": {
|
|
6816
7112
|
"type": "object",
|
|
6817
7113
|
"properties": {
|
|
6818
|
-
"
|
|
6819
|
-
|
|
6820
|
-
|
|
6821
|
-
|
|
6822
|
-
"
|
|
6823
|
-
|
|
7114
|
+
"github_owned_allowed": {
|
|
7115
|
+
"type": "boolean",
|
|
7116
|
+
"description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization."
|
|
7117
|
+
},
|
|
7118
|
+
"patterns_allowed": {
|
|
7119
|
+
"type": "array",
|
|
7120
|
+
"description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
|
|
7121
|
+
"items": { "type": "string" }
|
|
7122
|
+
}
|
|
7123
|
+
},
|
|
7124
|
+
"required": ["github_owned_allowed", "patterns_allowed"]
|
|
6824
7125
|
},
|
|
6825
7126
|
"examples": {
|
|
6826
7127
|
"default": {
|
|
6827
7128
|
"value": {
|
|
6828
|
-
"
|
|
6829
|
-
"
|
|
6830
|
-
"
|
|
6831
|
-
"configuration_url": "https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42",
|
|
6832
|
-
"allow_downstream_configuration": false
|
|
7129
|
+
"github_owned_allowed": true,
|
|
7130
|
+
"verified_allowed": false,
|
|
7131
|
+
"patterns_allowed": ["monalisa/octocat@*", "docker/*"]
|
|
6833
7132
|
}
|
|
6834
7133
|
}
|
|
6835
7134
|
}
|
|
@@ -6837,25 +7136,156 @@
|
|
|
6837
7136
|
}
|
|
6838
7137
|
}
|
|
6839
7138
|
},
|
|
7139
|
+
"x-github": {
|
|
7140
|
+
"enabledForGitHubApps": true,
|
|
7141
|
+
"githubCloudOnly": false,
|
|
7142
|
+
"previews": [],
|
|
7143
|
+
"category": "actions",
|
|
7144
|
+
"subcategory": "permissions"
|
|
7145
|
+
},
|
|
7146
|
+
"x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
|
|
7147
|
+
},
|
|
7148
|
+
"put": {
|
|
7149
|
+
"summary": "Set allowed actions for an organization",
|
|
7150
|
+
"description": "Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nIf the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.\n\nTo use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
|
|
7151
|
+
"operationId": "actions/set-allowed-actions-organization",
|
|
7152
|
+
"tags": ["actions"],
|
|
7153
|
+
"externalDocs": {
|
|
7154
|
+
"description": "API method documentation",
|
|
7155
|
+
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#set-allowed-actions-for-an-organization"
|
|
7156
|
+
},
|
|
7157
|
+
"parameters": [
|
|
7158
|
+
{
|
|
7159
|
+
"name": "org",
|
|
7160
|
+
"in": "path",
|
|
7161
|
+
"required": true,
|
|
7162
|
+
"schema": { "type": "string" }
|
|
7163
|
+
}
|
|
7164
|
+
],
|
|
7165
|
+
"responses": { "204": { "description": "Response" } },
|
|
6840
7166
|
"requestBody": {
|
|
6841
7167
|
"content": {
|
|
6842
7168
|
"application/json": {
|
|
6843
7169
|
"schema": {
|
|
6844
7170
|
"type": "object",
|
|
6845
7171
|
"properties": {
|
|
6846
|
-
"
|
|
6847
|
-
"
|
|
6848
|
-
"
|
|
7172
|
+
"github_owned_allowed": {
|
|
7173
|
+
"type": "boolean",
|
|
7174
|
+
"description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization."
|
|
6849
7175
|
},
|
|
6850
|
-
"
|
|
6851
|
-
"
|
|
6852
|
-
"
|
|
7176
|
+
"patterns_allowed": {
|
|
7177
|
+
"type": "array",
|
|
7178
|
+
"description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
|
|
7179
|
+
"items": { "type": "string" }
|
|
6853
7180
|
}
|
|
6854
|
-
}
|
|
7181
|
+
},
|
|
7182
|
+
"required": ["github_owned_allowed", "patterns_allowed"]
|
|
6855
7183
|
},
|
|
6856
|
-
"
|
|
6857
|
-
"
|
|
6858
|
-
|
|
7184
|
+
"examples": {
|
|
7185
|
+
"selected_actions": {
|
|
7186
|
+
"value": {
|
|
7187
|
+
"github_owned_allowed": true,
|
|
7188
|
+
"verified_allowed": false,
|
|
7189
|
+
"patterns_allowed": ["monalisa/octocat@*", "docker/*"]
|
|
7190
|
+
}
|
|
7191
|
+
}
|
|
7192
|
+
}
|
|
7193
|
+
}
|
|
7194
|
+
}
|
|
7195
|
+
},
|
|
7196
|
+
"x-github": {
|
|
7197
|
+
"enabledForGitHubApps": true,
|
|
7198
|
+
"githubCloudOnly": false,
|
|
7199
|
+
"previews": [],
|
|
7200
|
+
"category": "actions",
|
|
7201
|
+
"subcategory": "permissions"
|
|
7202
|
+
},
|
|
7203
|
+
"x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
|
|
7204
|
+
}
|
|
7205
|
+
},
|
|
7206
|
+
"/orgs/{org}/pre-receive-hooks": {
|
|
7207
|
+
"get": {
|
|
7208
|
+
"summary": "List pre-receive hooks for an organization",
|
|
7209
|
+
"description": "List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.",
|
|
7210
|
+
"operationId": "enterprise-admin/list-pre-receive-hooks-for-org",
|
|
7211
|
+
"tags": ["enterprise-admin"],
|
|
7212
|
+
"externalDocs": {
|
|
7213
|
+
"description": "API method documentation",
|
|
7214
|
+
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#list-pre-receive-hooks-for-an-organization"
|
|
7215
|
+
},
|
|
7216
|
+
"parameters": [
|
|
7217
|
+
{
|
|
7218
|
+
"name": "org",
|
|
7219
|
+
"in": "path",
|
|
7220
|
+
"required": true,
|
|
7221
|
+
"schema": { "type": "string" }
|
|
7222
|
+
},
|
|
7223
|
+
{
|
|
7224
|
+
"name": "per_page",
|
|
7225
|
+
"description": "Results per page (max 100)",
|
|
7226
|
+
"in": "query",
|
|
7227
|
+
"schema": { "type": "integer", "default": 30 }
|
|
7228
|
+
},
|
|
7229
|
+
{
|
|
7230
|
+
"name": "page",
|
|
7231
|
+
"description": "Page number of the results to fetch.",
|
|
7232
|
+
"in": "query",
|
|
7233
|
+
"schema": { "type": "integer", "default": 1 }
|
|
7234
|
+
},
|
|
7235
|
+
{
|
|
7236
|
+
"name": "direction",
|
|
7237
|
+
"description": "One of `asc` (ascending) or `desc` (descending).",
|
|
7238
|
+
"in": "query",
|
|
7239
|
+
"required": false,
|
|
7240
|
+
"schema": {
|
|
7241
|
+
"type": "string",
|
|
7242
|
+
"enum": ["asc", "desc"],
|
|
7243
|
+
"default": "desc"
|
|
7244
|
+
}
|
|
7245
|
+
},
|
|
7246
|
+
{
|
|
7247
|
+
"name": "sort",
|
|
7248
|
+
"description": "The sort order for the response collection.",
|
|
7249
|
+
"in": "query",
|
|
7250
|
+
"required": false,
|
|
7251
|
+
"schema": {
|
|
7252
|
+
"type": "string",
|
|
7253
|
+
"enum": ["created", "updated", "name"],
|
|
7254
|
+
"default": "created"
|
|
7255
|
+
}
|
|
7256
|
+
}
|
|
7257
|
+
],
|
|
7258
|
+
"responses": {
|
|
7259
|
+
"200": {
|
|
7260
|
+
"description": "Response",
|
|
7261
|
+
"content": {
|
|
7262
|
+
"application/json": {
|
|
7263
|
+
"schema": {
|
|
7264
|
+
"type": "array",
|
|
7265
|
+
"items": {
|
|
7266
|
+
"type": "object",
|
|
7267
|
+
"properties": {
|
|
7268
|
+
"id": { "type": "integer" },
|
|
7269
|
+
"name": { "type": "string" },
|
|
7270
|
+
"enforcement": { "type": "string" },
|
|
7271
|
+
"configuration_url": { "type": "string" },
|
|
7272
|
+
"allow_downstream_configuration": { "type": "boolean" }
|
|
7273
|
+
}
|
|
7274
|
+
}
|
|
7275
|
+
},
|
|
7276
|
+
"examples": {
|
|
7277
|
+
"default": {
|
|
7278
|
+
"value": [
|
|
7279
|
+
{
|
|
7280
|
+
"id": 42,
|
|
7281
|
+
"name": "Check Commits",
|
|
7282
|
+
"enforcement": "disabled",
|
|
7283
|
+
"configuration_url": "https://github.example.com/api/v3/admin/pre-receive-hooks/42",
|
|
7284
|
+
"allow_downstream_configuration": true
|
|
7285
|
+
}
|
|
7286
|
+
]
|
|
7287
|
+
}
|
|
7288
|
+
}
|
|
6859
7289
|
}
|
|
6860
7290
|
}
|
|
6861
7291
|
}
|
|
@@ -6874,15 +7304,17 @@
|
|
|
6874
7304
|
"subcategory": "org-pre-receive-hooks"
|
|
6875
7305
|
},
|
|
6876
7306
|
"x-octokit": { "diff": { "api.github.com": { "type": "added" } } }
|
|
6877
|
-
}
|
|
6878
|
-
|
|
6879
|
-
|
|
6880
|
-
|
|
6881
|
-
"
|
|
7307
|
+
}
|
|
7308
|
+
},
|
|
7309
|
+
"/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}": {
|
|
7310
|
+
"get": {
|
|
7311
|
+
"summary": "Get a pre-receive hook for an organization",
|
|
7312
|
+
"description": "",
|
|
7313
|
+
"operationId": "enterprise-admin/get-pre-receive-hook-for-org",
|
|
6882
7314
|
"tags": ["enterprise-admin"],
|
|
6883
7315
|
"externalDocs": {
|
|
6884
7316
|
"description": "API method documentation",
|
|
6885
|
-
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#
|
|
7317
|
+
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-an-organization"
|
|
6886
7318
|
},
|
|
6887
7319
|
"parameters": [
|
|
6888
7320
|
{
|
|
@@ -6943,34 +7375,26 @@
|
|
|
6943
7375
|
"subcategory": "org-pre-receive-hooks"
|
|
6944
7376
|
},
|
|
6945
7377
|
"x-octokit": { "diff": { "api.github.com": { "type": "added" } } }
|
|
6946
|
-
}
|
|
6947
|
-
|
|
6948
|
-
|
|
6949
|
-
|
|
6950
|
-
"
|
|
6951
|
-
"
|
|
6952
|
-
"tags": ["actions"],
|
|
6953
|
-
"operationId": "actions/get-job-for-workflow-run",
|
|
7378
|
+
},
|
|
7379
|
+
"patch": {
|
|
7380
|
+
"summary": "Update pre-receive hook enforcement for an organization",
|
|
7381
|
+
"description": "For pre-receive hooks which are allowed to be configured at the org level, you can set `enforcement` and `allow_downstream_configuration`",
|
|
7382
|
+
"operationId": "enterprise-admin/update-pre-receive-hook-enforcement-for-org",
|
|
7383
|
+
"tags": ["enterprise-admin"],
|
|
6954
7384
|
"externalDocs": {
|
|
6955
7385
|
"description": "API method documentation",
|
|
6956
|
-
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/
|
|
7386
|
+
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#update-pre-receive-hook-enforcement-for-an-organization"
|
|
6957
7387
|
},
|
|
6958
7388
|
"parameters": [
|
|
6959
7389
|
{
|
|
6960
|
-
"name": "
|
|
6961
|
-
"in": "path",
|
|
6962
|
-
"required": true,
|
|
6963
|
-
"schema": { "type": "string" }
|
|
6964
|
-
},
|
|
6965
|
-
{
|
|
6966
|
-
"name": "repo",
|
|
7390
|
+
"name": "org",
|
|
6967
7391
|
"in": "path",
|
|
6968
7392
|
"required": true,
|
|
6969
7393
|
"schema": { "type": "string" }
|
|
6970
7394
|
},
|
|
6971
7395
|
{
|
|
6972
|
-
"name": "
|
|
6973
|
-
"description": "
|
|
7396
|
+
"name": "pre_receive_hook_id",
|
|
7397
|
+
"description": "pre_receive_hook_id parameter",
|
|
6974
7398
|
"in": "path",
|
|
6975
7399
|
"required": true,
|
|
6976
7400
|
"schema": { "type": "integer" }
|
|
@@ -6982,37 +7406,206 @@
|
|
|
6982
7406
|
"content": {
|
|
6983
7407
|
"application/json": {
|
|
6984
7408
|
"schema": {
|
|
6985
|
-
"title": "Job",
|
|
6986
|
-
"description": "Information of a job execution in a workflow run",
|
|
6987
7409
|
"type": "object",
|
|
6988
7410
|
"properties": {
|
|
6989
|
-
"id": {
|
|
6990
|
-
|
|
6991
|
-
|
|
6992
|
-
|
|
6993
|
-
}
|
|
6994
|
-
|
|
6995
|
-
|
|
6996
|
-
|
|
6997
|
-
|
|
6998
|
-
|
|
6999
|
-
|
|
7000
|
-
"
|
|
7001
|
-
"
|
|
7002
|
-
|
|
7003
|
-
|
|
7004
|
-
|
|
7005
|
-
|
|
7006
|
-
|
|
7007
|
-
|
|
7008
|
-
|
|
7009
|
-
|
|
7010
|
-
|
|
7011
|
-
|
|
7012
|
-
|
|
7013
|
-
|
|
7014
|
-
|
|
7015
|
-
|
|
7411
|
+
"id": { "type": "integer" },
|
|
7412
|
+
"name": { "type": "string" },
|
|
7413
|
+
"enforcement": { "type": "string" },
|
|
7414
|
+
"configuration_url": { "type": "string" },
|
|
7415
|
+
"allow_downstream_configuration": { "type": "boolean" }
|
|
7416
|
+
}
|
|
7417
|
+
},
|
|
7418
|
+
"examples": {
|
|
7419
|
+
"default": {
|
|
7420
|
+
"value": {
|
|
7421
|
+
"id": 42,
|
|
7422
|
+
"name": "Check Commits",
|
|
7423
|
+
"enforcement": "enabled",
|
|
7424
|
+
"configuration_url": "https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42",
|
|
7425
|
+
"allow_downstream_configuration": false
|
|
7426
|
+
}
|
|
7427
|
+
}
|
|
7428
|
+
}
|
|
7429
|
+
}
|
|
7430
|
+
}
|
|
7431
|
+
}
|
|
7432
|
+
},
|
|
7433
|
+
"requestBody": {
|
|
7434
|
+
"content": {
|
|
7435
|
+
"application/json": {
|
|
7436
|
+
"schema": {
|
|
7437
|
+
"type": "object",
|
|
7438
|
+
"properties": {
|
|
7439
|
+
"enforcement": {
|
|
7440
|
+
"description": "The state of enforcement for the hook on this repository.",
|
|
7441
|
+
"type": "string"
|
|
7442
|
+
},
|
|
7443
|
+
"allow_downstream_configuration": {
|
|
7444
|
+
"description": "Whether repositories can override enforcement.",
|
|
7445
|
+
"type": "boolean"
|
|
7446
|
+
}
|
|
7447
|
+
}
|
|
7448
|
+
},
|
|
7449
|
+
"example": {
|
|
7450
|
+
"enforcement": "enabled",
|
|
7451
|
+
"allow_downstream_configuration": false
|
|
7452
|
+
}
|
|
7453
|
+
}
|
|
7454
|
+
}
|
|
7455
|
+
},
|
|
7456
|
+
"x-github": {
|
|
7457
|
+
"githubCloudOnly": false,
|
|
7458
|
+
"enabledForGitHubApps": true,
|
|
7459
|
+
"previews": [
|
|
7460
|
+
{
|
|
7461
|
+
"required": true,
|
|
7462
|
+
"name": "eye-scream",
|
|
7463
|
+
"note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
|
|
7464
|
+
}
|
|
7465
|
+
],
|
|
7466
|
+
"category": "enterprise-admin",
|
|
7467
|
+
"subcategory": "org-pre-receive-hooks"
|
|
7468
|
+
},
|
|
7469
|
+
"x-octokit": { "diff": { "api.github.com": { "type": "added" } } }
|
|
7470
|
+
},
|
|
7471
|
+
"delete": {
|
|
7472
|
+
"summary": "Remove pre-receive hook enforcement for an organization",
|
|
7473
|
+
"description": "Removes any overrides for this hook at the org level for this org.",
|
|
7474
|
+
"operationId": "enterprise-admin/remove-pre-receive-hook-enforcement-for-org",
|
|
7475
|
+
"tags": ["enterprise-admin"],
|
|
7476
|
+
"externalDocs": {
|
|
7477
|
+
"description": "API method documentation",
|
|
7478
|
+
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-an-organization"
|
|
7479
|
+
},
|
|
7480
|
+
"parameters": [
|
|
7481
|
+
{
|
|
7482
|
+
"name": "org",
|
|
7483
|
+
"in": "path",
|
|
7484
|
+
"required": true,
|
|
7485
|
+
"schema": { "type": "string" }
|
|
7486
|
+
},
|
|
7487
|
+
{
|
|
7488
|
+
"name": "pre_receive_hook_id",
|
|
7489
|
+
"description": "pre_receive_hook_id parameter",
|
|
7490
|
+
"in": "path",
|
|
7491
|
+
"required": true,
|
|
7492
|
+
"schema": { "type": "integer" }
|
|
7493
|
+
}
|
|
7494
|
+
],
|
|
7495
|
+
"responses": {
|
|
7496
|
+
"200": {
|
|
7497
|
+
"description": "Response",
|
|
7498
|
+
"content": {
|
|
7499
|
+
"application/json": {
|
|
7500
|
+
"schema": {
|
|
7501
|
+
"type": "object",
|
|
7502
|
+
"properties": {
|
|
7503
|
+
"id": { "type": "integer" },
|
|
7504
|
+
"name": { "type": "string" },
|
|
7505
|
+
"enforcement": { "type": "string" },
|
|
7506
|
+
"configuration_url": { "type": "string" },
|
|
7507
|
+
"allow_downstream_configuration": { "type": "boolean" }
|
|
7508
|
+
}
|
|
7509
|
+
},
|
|
7510
|
+
"examples": {
|
|
7511
|
+
"default": {
|
|
7512
|
+
"value": {
|
|
7513
|
+
"id": 42,
|
|
7514
|
+
"name": "Check Commits",
|
|
7515
|
+
"enforcement": "disabled",
|
|
7516
|
+
"configuration_url": "https://github.example.com/api/v3/admin/pre-receive-hooks/42",
|
|
7517
|
+
"allow_downstream_configuration": true
|
|
7518
|
+
}
|
|
7519
|
+
}
|
|
7520
|
+
}
|
|
7521
|
+
}
|
|
7522
|
+
}
|
|
7523
|
+
}
|
|
7524
|
+
},
|
|
7525
|
+
"x-github": {
|
|
7526
|
+
"githubCloudOnly": false,
|
|
7527
|
+
"enabledForGitHubApps": true,
|
|
7528
|
+
"previews": [
|
|
7529
|
+
{
|
|
7530
|
+
"required": true,
|
|
7531
|
+
"name": "eye-scream",
|
|
7532
|
+
"note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
|
|
7533
|
+
}
|
|
7534
|
+
],
|
|
7535
|
+
"category": "enterprise-admin",
|
|
7536
|
+
"subcategory": "org-pre-receive-hooks"
|
|
7537
|
+
},
|
|
7538
|
+
"x-octokit": { "diff": { "api.github.com": { "type": "added" } } }
|
|
7539
|
+
}
|
|
7540
|
+
},
|
|
7541
|
+
"/repos/{owner}/{repo}/actions/jobs/{job_id}": {
|
|
7542
|
+
"get": {
|
|
7543
|
+
"summary": "Get a job for a workflow run",
|
|
7544
|
+
"description": "Gets a specific job in a workflow run. 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.",
|
|
7545
|
+
"tags": ["actions"],
|
|
7546
|
+
"operationId": "actions/get-job-for-workflow-run",
|
|
7547
|
+
"externalDocs": {
|
|
7548
|
+
"description": "API method documentation",
|
|
7549
|
+
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-a-job-for-a-workflow-run"
|
|
7550
|
+
},
|
|
7551
|
+
"parameters": [
|
|
7552
|
+
{
|
|
7553
|
+
"name": "owner",
|
|
7554
|
+
"in": "path",
|
|
7555
|
+
"required": true,
|
|
7556
|
+
"schema": { "type": "string" }
|
|
7557
|
+
},
|
|
7558
|
+
{
|
|
7559
|
+
"name": "repo",
|
|
7560
|
+
"in": "path",
|
|
7561
|
+
"required": true,
|
|
7562
|
+
"schema": { "type": "string" }
|
|
7563
|
+
},
|
|
7564
|
+
{
|
|
7565
|
+
"name": "job_id",
|
|
7566
|
+
"description": "job_id parameter",
|
|
7567
|
+
"in": "path",
|
|
7568
|
+
"required": true,
|
|
7569
|
+
"schema": { "type": "integer" }
|
|
7570
|
+
}
|
|
7571
|
+
],
|
|
7572
|
+
"responses": {
|
|
7573
|
+
"200": {
|
|
7574
|
+
"description": "Response",
|
|
7575
|
+
"content": {
|
|
7576
|
+
"application/json": {
|
|
7577
|
+
"schema": {
|
|
7578
|
+
"title": "Job",
|
|
7579
|
+
"description": "Information of a job execution in a workflow run",
|
|
7580
|
+
"type": "object",
|
|
7581
|
+
"properties": {
|
|
7582
|
+
"id": {
|
|
7583
|
+
"description": "The id of the job.",
|
|
7584
|
+
"example": 21,
|
|
7585
|
+
"type": "integer"
|
|
7586
|
+
},
|
|
7587
|
+
"run_id": {
|
|
7588
|
+
"description": "The id of the associated workflow run.",
|
|
7589
|
+
"example": 5,
|
|
7590
|
+
"type": "integer"
|
|
7591
|
+
},
|
|
7592
|
+
"run_url": {
|
|
7593
|
+
"type": "string",
|
|
7594
|
+
"example": "https://api.github.com/repos/github/hello-world/actions/runs/5"
|
|
7595
|
+
},
|
|
7596
|
+
"run_attempt": {
|
|
7597
|
+
"type": "integer",
|
|
7598
|
+
"description": "Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.",
|
|
7599
|
+
"example": 1
|
|
7600
|
+
},
|
|
7601
|
+
"node_id": {
|
|
7602
|
+
"type": "string",
|
|
7603
|
+
"example": "MDg6Q2hlY2tSdW40"
|
|
7604
|
+
},
|
|
7605
|
+
"head_sha": {
|
|
7606
|
+
"description": "The SHA of the commit that is being run.",
|
|
7607
|
+
"example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d",
|
|
7608
|
+
"type": "string"
|
|
7016
7609
|
},
|
|
7017
7610
|
"url": {
|
|
7018
7611
|
"type": "string",
|
|
@@ -7296,6 +7889,69 @@
|
|
|
7296
7889
|
"subcategory": "permissions"
|
|
7297
7890
|
},
|
|
7298
7891
|
"x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
|
|
7892
|
+
},
|
|
7893
|
+
"put": {
|
|
7894
|
+
"summary": "Set allowed actions for a repository",
|
|
7895
|
+
"description": "Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nIf the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.\n\nTo use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.",
|
|
7896
|
+
"operationId": "actions/set-allowed-actions-repository",
|
|
7897
|
+
"tags": ["actions"],
|
|
7898
|
+
"externalDocs": {
|
|
7899
|
+
"description": "API method documentation",
|
|
7900
|
+
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#set-allowed-actions-for-a-repository"
|
|
7901
|
+
},
|
|
7902
|
+
"parameters": [
|
|
7903
|
+
{
|
|
7904
|
+
"name": "owner",
|
|
7905
|
+
"in": "path",
|
|
7906
|
+
"required": true,
|
|
7907
|
+
"schema": { "type": "string" }
|
|
7908
|
+
},
|
|
7909
|
+
{
|
|
7910
|
+
"name": "repo",
|
|
7911
|
+
"in": "path",
|
|
7912
|
+
"required": true,
|
|
7913
|
+
"schema": { "type": "string" }
|
|
7914
|
+
}
|
|
7915
|
+
],
|
|
7916
|
+
"responses": { "204": { "description": "Response" } },
|
|
7917
|
+
"requestBody": {
|
|
7918
|
+
"content": {
|
|
7919
|
+
"application/json": {
|
|
7920
|
+
"schema": {
|
|
7921
|
+
"type": "object",
|
|
7922
|
+
"properties": {
|
|
7923
|
+
"github_owned_allowed": {
|
|
7924
|
+
"type": "boolean",
|
|
7925
|
+
"description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization."
|
|
7926
|
+
},
|
|
7927
|
+
"patterns_allowed": {
|
|
7928
|
+
"type": "array",
|
|
7929
|
+
"description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
|
|
7930
|
+
"items": { "type": "string" }
|
|
7931
|
+
}
|
|
7932
|
+
},
|
|
7933
|
+
"required": ["github_owned_allowed", "patterns_allowed"]
|
|
7934
|
+
},
|
|
7935
|
+
"examples": {
|
|
7936
|
+
"selected_actions": {
|
|
7937
|
+
"value": {
|
|
7938
|
+
"github_owned_allowed": true,
|
|
7939
|
+
"verified_allowed": false,
|
|
7940
|
+
"patterns_allowed": ["monalisa/octocat@*", "docker/*"]
|
|
7941
|
+
}
|
|
7942
|
+
}
|
|
7943
|
+
}
|
|
7944
|
+
}
|
|
7945
|
+
}
|
|
7946
|
+
},
|
|
7947
|
+
"x-github": {
|
|
7948
|
+
"enabledForGitHubApps": true,
|
|
7949
|
+
"githubCloudOnly": false,
|
|
7950
|
+
"previews": [],
|
|
7951
|
+
"category": "actions",
|
|
7952
|
+
"subcategory": "permissions"
|
|
7953
|
+
},
|
|
7954
|
+
"x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
|
|
7299
7955
|
}
|
|
7300
7956
|
},
|
|
7301
7957
|
"/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": {
|
|
@@ -8111,17 +8767,15 @@
|
|
|
8111
8767
|
],
|
|
8112
8768
|
"diff": { "api.github.com": { "type": "changed" } }
|
|
8113
8769
|
}
|
|
8114
|
-
}
|
|
8115
|
-
|
|
8116
|
-
|
|
8117
|
-
|
|
8118
|
-
"
|
|
8119
|
-
"description": "Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the `page` and `per_page` parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.\n\nThe `rules_count` field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.",
|
|
8120
|
-
"operationId": "code-scanning/list-recent-analyses",
|
|
8770
|
+
},
|
|
8771
|
+
"patch": {
|
|
8772
|
+
"summary": "Update a code scanning alert",
|
|
8773
|
+
"description": "Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.",
|
|
8774
|
+
"operationId": "code-scanning/update-alert",
|
|
8121
8775
|
"tags": ["code-scanning"],
|
|
8122
8776
|
"externalDocs": {
|
|
8123
8777
|
"description": "API method documentation",
|
|
8124
|
-
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/code-scanning#
|
|
8778
|
+
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/code-scanning#update-a-code-scanning-alert"
|
|
8125
8779
|
},
|
|
8126
8780
|
"parameters": [
|
|
8127
8781
|
{
|
|
@@ -8137,453 +8791,417 @@
|
|
|
8137
8791
|
"schema": { "type": "string" }
|
|
8138
8792
|
},
|
|
8139
8793
|
{
|
|
8140
|
-
"name": "
|
|
8141
|
-
"
|
|
8142
|
-
"
|
|
8143
|
-
"required":
|
|
8144
|
-
"schema": {
|
|
8145
|
-
"type": "string",
|
|
8146
|
-
"description": "The name of the tool used to generate the code scanning analysis."
|
|
8147
|
-
}
|
|
8148
|
-
},
|
|
8149
|
-
{
|
|
8150
|
-
"name": "tool_guid",
|
|
8151
|
-
"description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.",
|
|
8152
|
-
"in": "query",
|
|
8153
|
-
"required": false,
|
|
8154
|
-
"schema": {
|
|
8155
|
-
"nullable": true,
|
|
8156
|
-
"type": "string",
|
|
8157
|
-
"description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data."
|
|
8158
|
-
}
|
|
8159
|
-
},
|
|
8160
|
-
{
|
|
8161
|
-
"name": "page",
|
|
8162
|
-
"description": "Page number of the results to fetch.",
|
|
8163
|
-
"in": "query",
|
|
8164
|
-
"schema": { "type": "integer", "default": 1 }
|
|
8165
|
-
},
|
|
8166
|
-
{
|
|
8167
|
-
"name": "per_page",
|
|
8168
|
-
"description": "Results per page (max 100)",
|
|
8169
|
-
"in": "query",
|
|
8170
|
-
"schema": { "type": "integer", "default": 30 }
|
|
8171
|
-
},
|
|
8172
|
-
{
|
|
8173
|
-
"name": "ref",
|
|
8174
|
-
"in": "query",
|
|
8175
|
-
"description": "The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/<branch name>` or simply `<branch name>`. To reference a pull request use `refs/pull/<number>/merge`.",
|
|
8176
|
-
"required": false,
|
|
8177
|
-
"schema": {
|
|
8178
|
-
"type": "string",
|
|
8179
|
-
"description": "The full Git reference, formatted as `refs/heads/<branch name>`,\n`refs/pull/<number>/merge`, or `refs/pull/<number>/head`."
|
|
8180
|
-
}
|
|
8181
|
-
},
|
|
8182
|
-
{
|
|
8183
|
-
"name": "sarif_id",
|
|
8184
|
-
"in": "query",
|
|
8185
|
-
"description": "Filter analyses belonging to the same SARIF upload.",
|
|
8186
|
-
"required": false,
|
|
8794
|
+
"name": "alert_number",
|
|
8795
|
+
"in": "path",
|
|
8796
|
+
"description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.",
|
|
8797
|
+
"required": true,
|
|
8187
8798
|
"schema": {
|
|
8188
|
-
"type": "
|
|
8189
|
-
"description": "
|
|
8190
|
-
"
|
|
8799
|
+
"type": "integer",
|
|
8800
|
+
"description": "The security alert number.",
|
|
8801
|
+
"readOnly": true,
|
|
8191
8802
|
"nullable": false
|
|
8192
8803
|
}
|
|
8193
8804
|
}
|
|
8194
8805
|
],
|
|
8195
|
-
"
|
|
8196
|
-
"
|
|
8197
|
-
|
|
8198
|
-
"
|
|
8199
|
-
"
|
|
8200
|
-
"
|
|
8201
|
-
|
|
8202
|
-
"
|
|
8203
|
-
"
|
|
8204
|
-
"
|
|
8205
|
-
|
|
8206
|
-
|
|
8207
|
-
|
|
8208
|
-
|
|
8209
|
-
|
|
8210
|
-
|
|
8211
|
-
|
|
8212
|
-
|
|
8213
|
-
|
|
8214
|
-
|
|
8215
|
-
|
|
8216
|
-
"analysis_key": {
|
|
8217
|
-
"type": "string",
|
|
8218
|
-
"description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name."
|
|
8219
|
-
},
|
|
8220
|
-
"environment": {
|
|
8221
|
-
"type": "string",
|
|
8222
|
-
"description": "Identifies the variable values associated with the environment in which this analysis was performed."
|
|
8223
|
-
},
|
|
8224
|
-
"category": {
|
|
8225
|
-
"type": "string",
|
|
8226
|
-
"description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code."
|
|
8227
|
-
},
|
|
8228
|
-
"error": {
|
|
8229
|
-
"type": "string",
|
|
8230
|
-
"example": "error reading field xyz"
|
|
8231
|
-
},
|
|
8232
|
-
"created_at": {
|
|
8233
|
-
"type": "string",
|
|
8234
|
-
"description": "The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
|
|
8235
|
-
"format": "date-time",
|
|
8236
|
-
"readOnly": true,
|
|
8237
|
-
"nullable": false
|
|
8238
|
-
},
|
|
8239
|
-
"results_count": {
|
|
8240
|
-
"type": "integer",
|
|
8241
|
-
"description": "The total number of results in the analysis."
|
|
8242
|
-
},
|
|
8243
|
-
"rules_count": {
|
|
8244
|
-
"type": "integer",
|
|
8245
|
-
"description": "The total number of rules used in the analysis."
|
|
8246
|
-
},
|
|
8247
|
-
"id": {
|
|
8248
|
-
"type": "integer",
|
|
8249
|
-
"description": "Unique identifier for this analysis."
|
|
8250
|
-
},
|
|
8251
|
-
"url": {
|
|
8252
|
-
"type": "string",
|
|
8253
|
-
"description": "The REST API URL of the analysis resource.",
|
|
8254
|
-
"format": "uri",
|
|
8255
|
-
"readOnly": true,
|
|
8256
|
-
"nullable": false
|
|
8257
|
-
},
|
|
8258
|
-
"sarif_id": {
|
|
8259
|
-
"type": "string",
|
|
8260
|
-
"description": "An identifier for the upload.",
|
|
8261
|
-
"example": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53",
|
|
8262
|
-
"nullable": false
|
|
8263
|
-
},
|
|
8264
|
-
"tool": {
|
|
8265
|
-
"type": "object",
|
|
8266
|
-
"properties": {
|
|
8267
|
-
"name": {
|
|
8268
|
-
"type": "string",
|
|
8269
|
-
"description": "The name of the tool used to generate the code scanning analysis."
|
|
8270
|
-
},
|
|
8271
|
-
"version": {
|
|
8272
|
-
"nullable": true,
|
|
8273
|
-
"type": "string",
|
|
8274
|
-
"description": "The version of the tool used to generate the code scanning analysis."
|
|
8275
|
-
},
|
|
8276
|
-
"guid": {
|
|
8277
|
-
"nullable": true,
|
|
8278
|
-
"type": "string",
|
|
8279
|
-
"description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data."
|
|
8280
|
-
}
|
|
8281
|
-
}
|
|
8282
|
-
},
|
|
8283
|
-
"deletable": { "type": "boolean" },
|
|
8284
|
-
"warning": {
|
|
8285
|
-
"type": "string",
|
|
8286
|
-
"description": "Warning generated when processing the analysis",
|
|
8287
|
-
"example": "123 results were ignored"
|
|
8288
|
-
},
|
|
8289
|
-
"tool_name": { "type": "string" }
|
|
8290
|
-
},
|
|
8291
|
-
"required": [
|
|
8292
|
-
"ref",
|
|
8293
|
-
"commit_sha",
|
|
8294
|
-
"analysis_key",
|
|
8295
|
-
"environment",
|
|
8296
|
-
"error",
|
|
8297
|
-
"created_at",
|
|
8298
|
-
"results_count",
|
|
8299
|
-
"rules_count",
|
|
8300
|
-
"id",
|
|
8301
|
-
"url",
|
|
8302
|
-
"sarif_id",
|
|
8303
|
-
"tool",
|
|
8304
|
-
"deletable",
|
|
8305
|
-
"warning"
|
|
8806
|
+
"requestBody": {
|
|
8807
|
+
"required": true,
|
|
8808
|
+
"content": {
|
|
8809
|
+
"application/json": {
|
|
8810
|
+
"schema": {
|
|
8811
|
+
"type": "object",
|
|
8812
|
+
"properties": {
|
|
8813
|
+
"state": {
|
|
8814
|
+
"description": "Sets the state of the code scanning alert. Can be one of `open` or `dismissed`. You must provide `dismissed_reason` when you set the state to `dismissed`.",
|
|
8815
|
+
"type": "string",
|
|
8816
|
+
"enum": ["open", "dismissed"]
|
|
8817
|
+
},
|
|
8818
|
+
"dismissed_reason": {
|
|
8819
|
+
"type": "string",
|
|
8820
|
+
"description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.",
|
|
8821
|
+
"nullable": true,
|
|
8822
|
+
"enum": [
|
|
8823
|
+
null,
|
|
8824
|
+
"false positive",
|
|
8825
|
+
"won't fix",
|
|
8826
|
+
"used in tests"
|
|
8306
8827
|
]
|
|
8307
8828
|
}
|
|
8308
8829
|
},
|
|
8309
|
-
"
|
|
8310
|
-
|
|
8311
|
-
|
|
8312
|
-
|
|
8313
|
-
|
|
8314
|
-
"commit_sha": "d99612c3e1f2970085cfbaeadf8f010ef69bad83",
|
|
8315
|
-
"analysis_key": ".github/workflows/codeql-analysis.yml:analyze",
|
|
8316
|
-
"environment": "{\"language\":\"python\"}",
|
|
8317
|
-
"error": "",
|
|
8318
|
-
"category": ".github/workflows/codeql-analysis.yml:analyze/language:python",
|
|
8319
|
-
"created_at": "2020-08-27T15:05:21Z",
|
|
8320
|
-
"results_count": 17,
|
|
8321
|
-
"rules_count": 49,
|
|
8322
|
-
"id": 201,
|
|
8323
|
-
"url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201",
|
|
8324
|
-
"sarif_id": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53",
|
|
8325
|
-
"tool": {
|
|
8326
|
-
"name": "CodeQL",
|
|
8327
|
-
"guid": null,
|
|
8328
|
-
"version": "2.4.0"
|
|
8329
|
-
},
|
|
8330
|
-
"deletable": true,
|
|
8331
|
-
"warning": ""
|
|
8332
|
-
},
|
|
8333
|
-
{
|
|
8334
|
-
"ref": "refs/heads/my-branch",
|
|
8335
|
-
"commit_sha": "c8cff6510d4d084fb1b4aa13b64b97ca12b07321",
|
|
8336
|
-
"analysis_key": ".github/workflows/shiftleft.yml:build",
|
|
8337
|
-
"environment": "{}",
|
|
8338
|
-
"error": "",
|
|
8339
|
-
"category": ".github/workflows/shiftleft.yml:build/",
|
|
8340
|
-
"created_at": "2020-08-31T22:46:44Z",
|
|
8341
|
-
"results_count": 17,
|
|
8342
|
-
"rules_count": 32,
|
|
8343
|
-
"id": 200,
|
|
8344
|
-
"url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200",
|
|
8345
|
-
"sarif_id": "8981cd8e-b078-4ac3-a3be-1dad7dbd0b582",
|
|
8346
|
-
"tool": {
|
|
8347
|
-
"name": "Python Security Analysis",
|
|
8348
|
-
"guid": null,
|
|
8349
|
-
"version": "1.2.0"
|
|
8350
|
-
},
|
|
8351
|
-
"deletable": true,
|
|
8352
|
-
"warning": ""
|
|
8353
|
-
}
|
|
8354
|
-
]
|
|
8355
|
-
}
|
|
8356
|
-
}
|
|
8357
|
-
}
|
|
8358
|
-
}
|
|
8359
|
-
},
|
|
8360
|
-
"403": {
|
|
8361
|
-
"description": "Response if GitHub Advanced Security is not enabled for this repository",
|
|
8362
|
-
"content": {
|
|
8363
|
-
"application/json": {
|
|
8364
|
-
"schema": {
|
|
8365
|
-
"title": "Basic Error",
|
|
8366
|
-
"description": "Basic Error",
|
|
8367
|
-
"type": "object",
|
|
8368
|
-
"properties": {
|
|
8369
|
-
"message": { "type": "string" },
|
|
8370
|
-
"documentation_url": { "type": "string" },
|
|
8371
|
-
"url": { "type": "string" },
|
|
8372
|
-
"status": { "type": "string" }
|
|
8373
|
-
}
|
|
8374
|
-
}
|
|
8830
|
+
"required": ["state"]
|
|
8831
|
+
},
|
|
8832
|
+
"example": {
|
|
8833
|
+
"state": "dismissed",
|
|
8834
|
+
"dismissed_reason": "false positive"
|
|
8375
8835
|
}
|
|
8376
8836
|
}
|
|
8377
|
-
}
|
|
8378
|
-
|
|
8379
|
-
|
|
8837
|
+
}
|
|
8838
|
+
},
|
|
8839
|
+
"responses": {
|
|
8840
|
+
"200": {
|
|
8841
|
+
"description": "Response",
|
|
8380
8842
|
"content": {
|
|
8381
8843
|
"application/json": {
|
|
8382
8844
|
"schema": {
|
|
8383
|
-
"title": "Basic Error",
|
|
8384
|
-
"description": "Basic Error",
|
|
8385
8845
|
"type": "object",
|
|
8386
8846
|
"properties": {
|
|
8387
|
-
"
|
|
8388
|
-
|
|
8389
|
-
|
|
8390
|
-
|
|
8391
|
-
|
|
8392
|
-
}
|
|
8393
|
-
}
|
|
8394
|
-
}
|
|
8395
|
-
},
|
|
8396
|
-
"503": {
|
|
8397
|
-
"description": "Service unavailable",
|
|
8398
|
-
"content": {
|
|
8399
|
-
"application/json": {
|
|
8400
|
-
"schema": {
|
|
8401
|
-
"type": "object",
|
|
8402
|
-
"properties": {
|
|
8403
|
-
"code": { "type": "string" },
|
|
8404
|
-
"message": { "type": "string" },
|
|
8405
|
-
"documentation_url": { "type": "string" }
|
|
8406
|
-
}
|
|
8407
|
-
}
|
|
8408
|
-
}
|
|
8409
|
-
}
|
|
8410
|
-
}
|
|
8411
|
-
},
|
|
8412
|
-
"x-github": {
|
|
8413
|
-
"enabledForGitHubApps": true,
|
|
8414
|
-
"githubCloudOnly": false,
|
|
8415
|
-
"previews": [],
|
|
8416
|
-
"category": "code-scanning"
|
|
8417
|
-
},
|
|
8418
|
-
"x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
|
|
8419
|
-
}
|
|
8420
|
-
},
|
|
8421
|
-
"/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": {
|
|
8422
|
-
"get": {
|
|
8423
|
-
"summary": "Get a code scanning analysis for a repository",
|
|
8424
|
-
"description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.",
|
|
8425
|
-
"operationId": "code-scanning/get-analysis",
|
|
8426
|
-
"tags": ["code-scanning"],
|
|
8427
|
-
"externalDocs": {
|
|
8428
|
-
"description": "API method documentation",
|
|
8429
|
-
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository"
|
|
8430
|
-
},
|
|
8431
|
-
"parameters": [
|
|
8432
|
-
{
|
|
8433
|
-
"name": "owner",
|
|
8434
|
-
"in": "path",
|
|
8435
|
-
"required": true,
|
|
8436
|
-
"schema": { "type": "string" }
|
|
8437
|
-
},
|
|
8438
|
-
{
|
|
8439
|
-
"name": "repo",
|
|
8440
|
-
"in": "path",
|
|
8441
|
-
"required": true,
|
|
8442
|
-
"schema": { "type": "string" }
|
|
8443
|
-
},
|
|
8444
|
-
{
|
|
8445
|
-
"name": "analysis_id",
|
|
8446
|
-
"in": "path",
|
|
8447
|
-
"description": "The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation.",
|
|
8448
|
-
"required": true,
|
|
8449
|
-
"schema": { "type": "integer" }
|
|
8450
|
-
}
|
|
8451
|
-
],
|
|
8452
|
-
"responses": {
|
|
8453
|
-
"200": {
|
|
8454
|
-
"description": "Response",
|
|
8455
|
-
"content": {
|
|
8456
|
-
"application/json+sarif": { "schema": { "type": "string" } },
|
|
8457
|
-
"application/json": {
|
|
8458
|
-
"schema": {
|
|
8459
|
-
"type": "object",
|
|
8460
|
-
"properties": {
|
|
8461
|
-
"ref": {
|
|
8462
|
-
"type": "string",
|
|
8463
|
-
"description": "The full Git reference, formatted as `refs/heads/<branch name>`,\n`refs/pull/<number>/merge`, or `refs/pull/<number>/head`."
|
|
8464
|
-
},
|
|
8465
|
-
"commit_sha": {
|
|
8466
|
-
"description": "The SHA of the commit to which the analysis you are uploading relates.",
|
|
8467
|
-
"type": "string",
|
|
8468
|
-
"minLength": 40,
|
|
8469
|
-
"maxLength": 40,
|
|
8470
|
-
"pattern": "^[0-9a-fA-F]+$"
|
|
8471
|
-
},
|
|
8472
|
-
"analysis_key": {
|
|
8473
|
-
"type": "string",
|
|
8474
|
-
"description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name."
|
|
8475
|
-
},
|
|
8476
|
-
"environment": {
|
|
8477
|
-
"type": "string",
|
|
8478
|
-
"description": "Identifies the variable values associated with the environment in which this analysis was performed."
|
|
8479
|
-
},
|
|
8480
|
-
"category": {
|
|
8481
|
-
"type": "string",
|
|
8482
|
-
"description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code."
|
|
8483
|
-
},
|
|
8484
|
-
"error": {
|
|
8485
|
-
"type": "string",
|
|
8486
|
-
"example": "error reading field xyz"
|
|
8847
|
+
"number": {
|
|
8848
|
+
"type": "integer",
|
|
8849
|
+
"description": "The security alert number.",
|
|
8850
|
+
"readOnly": true,
|
|
8851
|
+
"nullable": false
|
|
8487
8852
|
},
|
|
8488
8853
|
"created_at": {
|
|
8489
8854
|
"type": "string",
|
|
8490
|
-
"description": "The time that the
|
|
8855
|
+
"description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
|
|
8491
8856
|
"format": "date-time",
|
|
8492
8857
|
"readOnly": true,
|
|
8493
8858
|
"nullable": false
|
|
8494
8859
|
},
|
|
8495
|
-
"results_count": {
|
|
8496
|
-
"type": "integer",
|
|
8497
|
-
"description": "The total number of results in the analysis."
|
|
8498
|
-
},
|
|
8499
|
-
"rules_count": {
|
|
8500
|
-
"type": "integer",
|
|
8501
|
-
"description": "The total number of rules used in the analysis."
|
|
8502
|
-
},
|
|
8503
|
-
"id": {
|
|
8504
|
-
"type": "integer",
|
|
8505
|
-
"description": "Unique identifier for this analysis."
|
|
8506
|
-
},
|
|
8507
8860
|
"url": {
|
|
8508
8861
|
"type": "string",
|
|
8509
|
-
"description": "The REST API URL of the
|
|
8862
|
+
"description": "The REST API URL of the alert resource.",
|
|
8510
8863
|
"format": "uri",
|
|
8511
8864
|
"readOnly": true,
|
|
8512
8865
|
"nullable": false
|
|
8513
8866
|
},
|
|
8514
|
-
"
|
|
8867
|
+
"html_url": {
|
|
8515
8868
|
"type": "string",
|
|
8516
|
-
"description": "
|
|
8517
|
-
"
|
|
8869
|
+
"description": "The GitHub URL of the alert resource.",
|
|
8870
|
+
"format": "uri",
|
|
8871
|
+
"readOnly": true,
|
|
8518
8872
|
"nullable": false
|
|
8519
8873
|
},
|
|
8520
|
-
"
|
|
8874
|
+
"instances_url": {
|
|
8875
|
+
"type": "string",
|
|
8876
|
+
"description": "The REST API URL for fetching the list of instances for an alert.",
|
|
8877
|
+
"format": "uri",
|
|
8878
|
+
"readOnly": true,
|
|
8879
|
+
"nullable": false
|
|
8880
|
+
},
|
|
8881
|
+
"state": {
|
|
8882
|
+
"type": "string",
|
|
8883
|
+
"description": "State of a code scanning alert.",
|
|
8884
|
+
"enum": ["open", "closed", "dismissed", "fixed"]
|
|
8885
|
+
},
|
|
8886
|
+
"dismissed_by": {
|
|
8887
|
+
"title": "Simple User",
|
|
8888
|
+
"description": "Simple User",
|
|
8521
8889
|
"type": "object",
|
|
8522
8890
|
"properties": {
|
|
8523
|
-
"name": {
|
|
8891
|
+
"name": { "nullable": true, "type": "string" },
|
|
8892
|
+
"email": { "nullable": true, "type": "string" },
|
|
8893
|
+
"login": { "type": "string", "example": "octocat" },
|
|
8894
|
+
"id": { "type": "integer", "example": 1 },
|
|
8895
|
+
"node_id": {
|
|
8524
8896
|
"type": "string",
|
|
8525
|
-
"
|
|
8897
|
+
"example": "MDQ6VXNlcjE="
|
|
8526
8898
|
},
|
|
8527
|
-
"
|
|
8528
|
-
"nullable": true,
|
|
8899
|
+
"avatar_url": {
|
|
8529
8900
|
"type": "string",
|
|
8530
|
-
"
|
|
8901
|
+
"format": "uri",
|
|
8902
|
+
"example": "https://github.com/images/error/octocat_happy.gif"
|
|
8531
8903
|
},
|
|
8532
|
-
"
|
|
8533
|
-
"nullable": true,
|
|
8904
|
+
"gravatar_id": {
|
|
8534
8905
|
"type": "string",
|
|
8535
|
-
"
|
|
8906
|
+
"example": "41d064eb2195891e12d0413f63227ea7",
|
|
8907
|
+
"nullable": true
|
|
8908
|
+
},
|
|
8909
|
+
"url": {
|
|
8910
|
+
"type": "string",
|
|
8911
|
+
"format": "uri",
|
|
8912
|
+
"example": "https://api.github.com/users/octocat"
|
|
8913
|
+
},
|
|
8914
|
+
"html_url": {
|
|
8915
|
+
"type": "string",
|
|
8916
|
+
"format": "uri",
|
|
8917
|
+
"example": "https://github.com/octocat"
|
|
8918
|
+
},
|
|
8919
|
+
"followers_url": {
|
|
8920
|
+
"type": "string",
|
|
8921
|
+
"format": "uri",
|
|
8922
|
+
"example": "https://api.github.com/users/octocat/followers"
|
|
8923
|
+
},
|
|
8924
|
+
"following_url": {
|
|
8925
|
+
"type": "string",
|
|
8926
|
+
"example": "https://api.github.com/users/octocat/following{/other_user}"
|
|
8927
|
+
},
|
|
8928
|
+
"gists_url": {
|
|
8929
|
+
"type": "string",
|
|
8930
|
+
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
|
|
8931
|
+
},
|
|
8932
|
+
"starred_url": {
|
|
8933
|
+
"type": "string",
|
|
8934
|
+
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
|
|
8935
|
+
},
|
|
8936
|
+
"subscriptions_url": {
|
|
8937
|
+
"type": "string",
|
|
8938
|
+
"format": "uri",
|
|
8939
|
+
"example": "https://api.github.com/users/octocat/subscriptions"
|
|
8940
|
+
},
|
|
8941
|
+
"organizations_url": {
|
|
8942
|
+
"type": "string",
|
|
8943
|
+
"format": "uri",
|
|
8944
|
+
"example": "https://api.github.com/users/octocat/orgs"
|
|
8945
|
+
},
|
|
8946
|
+
"repos_url": {
|
|
8947
|
+
"type": "string",
|
|
8948
|
+
"format": "uri",
|
|
8949
|
+
"example": "https://api.github.com/users/octocat/repos"
|
|
8950
|
+
},
|
|
8951
|
+
"events_url": {
|
|
8952
|
+
"type": "string",
|
|
8953
|
+
"example": "https://api.github.com/users/octocat/events{/privacy}"
|
|
8954
|
+
},
|
|
8955
|
+
"received_events_url": {
|
|
8956
|
+
"type": "string",
|
|
8957
|
+
"format": "uri",
|
|
8958
|
+
"example": "https://api.github.com/users/octocat/received_events"
|
|
8959
|
+
},
|
|
8960
|
+
"type": { "type": "string", "example": "User" },
|
|
8961
|
+
"site_admin": { "type": "boolean" },
|
|
8962
|
+
"starred_at": {
|
|
8963
|
+
"type": "string",
|
|
8964
|
+
"example": "\"2020-07-09T00:17:55Z\""
|
|
8536
8965
|
}
|
|
8537
|
-
}
|
|
8966
|
+
},
|
|
8967
|
+
"required": [
|
|
8968
|
+
"avatar_url",
|
|
8969
|
+
"events_url",
|
|
8970
|
+
"followers_url",
|
|
8971
|
+
"following_url",
|
|
8972
|
+
"gists_url",
|
|
8973
|
+
"gravatar_id",
|
|
8974
|
+
"html_url",
|
|
8975
|
+
"id",
|
|
8976
|
+
"node_id",
|
|
8977
|
+
"login",
|
|
8978
|
+
"organizations_url",
|
|
8979
|
+
"received_events_url",
|
|
8980
|
+
"repos_url",
|
|
8981
|
+
"site_admin",
|
|
8982
|
+
"starred_url",
|
|
8983
|
+
"subscriptions_url",
|
|
8984
|
+
"type",
|
|
8985
|
+
"url"
|
|
8986
|
+
],
|
|
8987
|
+
"nullable": true
|
|
8538
8988
|
},
|
|
8539
|
-
"
|
|
8540
|
-
"warning": {
|
|
8989
|
+
"dismissed_at": {
|
|
8541
8990
|
"type": "string",
|
|
8542
|
-
"description": "
|
|
8543
|
-
"
|
|
8991
|
+
"description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
|
|
8992
|
+
"format": "date-time",
|
|
8993
|
+
"readOnly": true,
|
|
8994
|
+
"nullable": true
|
|
8544
8995
|
},
|
|
8545
|
-
"
|
|
8546
|
-
|
|
8547
|
-
|
|
8548
|
-
|
|
8549
|
-
|
|
8550
|
-
|
|
8551
|
-
|
|
8552
|
-
|
|
8996
|
+
"dismissed_reason": {
|
|
8997
|
+
"type": "string",
|
|
8998
|
+
"description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.",
|
|
8999
|
+
"nullable": true,
|
|
9000
|
+
"enum": [
|
|
9001
|
+
null,
|
|
9002
|
+
"false positive",
|
|
9003
|
+
"won't fix",
|
|
9004
|
+
"used in tests"
|
|
9005
|
+
]
|
|
9006
|
+
},
|
|
9007
|
+
"rule": {
|
|
9008
|
+
"type": "object",
|
|
9009
|
+
"properties": {
|
|
9010
|
+
"id": {
|
|
9011
|
+
"nullable": true,
|
|
9012
|
+
"type": "string",
|
|
9013
|
+
"description": "A unique identifier for the rule used to detect the alert."
|
|
9014
|
+
},
|
|
9015
|
+
"name": {
|
|
9016
|
+
"type": "string",
|
|
9017
|
+
"description": "The name of the rule used to detect the alert."
|
|
9018
|
+
},
|
|
9019
|
+
"severity": {
|
|
9020
|
+
"nullable": true,
|
|
9021
|
+
"type": "string",
|
|
9022
|
+
"description": "The severity of the alert.",
|
|
9023
|
+
"enum": ["none", "note", "warning", "error"]
|
|
9024
|
+
},
|
|
9025
|
+
"security_severity_level": {
|
|
9026
|
+
"nullable": true,
|
|
9027
|
+
"type": "string",
|
|
9028
|
+
"description": "The security severity of the alert.",
|
|
9029
|
+
"enum": ["low", "medium", "high", "critical"]
|
|
9030
|
+
},
|
|
9031
|
+
"description": {
|
|
9032
|
+
"type": "string",
|
|
9033
|
+
"description": "A short description of the rule used to detect the alert."
|
|
9034
|
+
},
|
|
9035
|
+
"full_description": {
|
|
9036
|
+
"type": "string",
|
|
9037
|
+
"description": "description of the rule used to detect the alert."
|
|
9038
|
+
},
|
|
9039
|
+
"tags": {
|
|
9040
|
+
"nullable": true,
|
|
9041
|
+
"type": "array",
|
|
9042
|
+
"description": "A set of tags applicable for the rule.",
|
|
9043
|
+
"items": { "type": "string" }
|
|
9044
|
+
},
|
|
9045
|
+
"help": {
|
|
9046
|
+
"nullable": true,
|
|
9047
|
+
"type": "string",
|
|
9048
|
+
"description": "Detailed documentation for the rule as GitHub Flavored Markdown."
|
|
9049
|
+
}
|
|
9050
|
+
}
|
|
9051
|
+
},
|
|
9052
|
+
"tool": {
|
|
9053
|
+
"type": "object",
|
|
9054
|
+
"properties": {
|
|
9055
|
+
"name": {
|
|
9056
|
+
"type": "string",
|
|
9057
|
+
"description": "The name of the tool used to generate the code scanning analysis."
|
|
9058
|
+
},
|
|
9059
|
+
"version": {
|
|
9060
|
+
"nullable": true,
|
|
9061
|
+
"type": "string",
|
|
9062
|
+
"description": "The version of the tool used to generate the code scanning analysis."
|
|
9063
|
+
},
|
|
9064
|
+
"guid": {
|
|
9065
|
+
"nullable": true,
|
|
9066
|
+
"type": "string",
|
|
9067
|
+
"description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data."
|
|
9068
|
+
}
|
|
9069
|
+
}
|
|
9070
|
+
},
|
|
9071
|
+
"most_recent_instance": {
|
|
9072
|
+
"type": "object",
|
|
9073
|
+
"properties": {
|
|
9074
|
+
"ref": {
|
|
9075
|
+
"type": "string",
|
|
9076
|
+
"description": "The full Git reference, formatted as `refs/heads/<branch name>`,\n`refs/pull/<number>/merge`, or `refs/pull/<number>/head`."
|
|
9077
|
+
},
|
|
9078
|
+
"analysis_key": {
|
|
9079
|
+
"type": "string",
|
|
9080
|
+
"description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name."
|
|
9081
|
+
},
|
|
9082
|
+
"environment": {
|
|
9083
|
+
"type": "string",
|
|
9084
|
+
"description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed."
|
|
9085
|
+
},
|
|
9086
|
+
"category": {
|
|
9087
|
+
"type": "string",
|
|
9088
|
+
"description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code."
|
|
9089
|
+
},
|
|
9090
|
+
"state": {
|
|
9091
|
+
"type": "string",
|
|
9092
|
+
"description": "State of a code scanning alert.",
|
|
9093
|
+
"enum": ["open", "closed", "dismissed", "fixed"]
|
|
9094
|
+
},
|
|
9095
|
+
"commit_sha": { "type": "string" },
|
|
9096
|
+
"message": {
|
|
9097
|
+
"type": "object",
|
|
9098
|
+
"properties": { "text": { "type": "string" } }
|
|
9099
|
+
},
|
|
9100
|
+
"location": {
|
|
9101
|
+
"type": "object",
|
|
9102
|
+
"description": "Describe a region within a file for the alert.",
|
|
9103
|
+
"properties": {
|
|
9104
|
+
"path": { "type": "string" },
|
|
9105
|
+
"start_line": { "type": "integer" },
|
|
9106
|
+
"end_line": { "type": "integer" },
|
|
9107
|
+
"start_column": { "type": "integer" },
|
|
9108
|
+
"end_column": { "type": "integer" }
|
|
9109
|
+
}
|
|
9110
|
+
},
|
|
9111
|
+
"html_url": { "type": "string" },
|
|
9112
|
+
"classifications": {
|
|
9113
|
+
"type": "array",
|
|
9114
|
+
"description": "Classifications that have been applied to the file that triggered the alert.\nFor example identifying it as documentation, or a generated file.",
|
|
9115
|
+
"items": {
|
|
9116
|
+
"type": "string",
|
|
9117
|
+
"description": "A classification of the file. For example to identify it as generated.",
|
|
9118
|
+
"nullable": true,
|
|
9119
|
+
"enum": ["source", "generated", "test", "library"]
|
|
9120
|
+
}
|
|
9121
|
+
}
|
|
9122
|
+
}
|
|
9123
|
+
},
|
|
9124
|
+
"instances": { "deprecated": true }
|
|
9125
|
+
},
|
|
9126
|
+
"required": [
|
|
9127
|
+
"number",
|
|
8553
9128
|
"created_at",
|
|
8554
|
-
"results_count",
|
|
8555
|
-
"rules_count",
|
|
8556
|
-
"id",
|
|
8557
9129
|
"url",
|
|
8558
|
-
"
|
|
9130
|
+
"html_url",
|
|
9131
|
+
"instances_url",
|
|
9132
|
+
"state",
|
|
9133
|
+
"dismissed_by",
|
|
9134
|
+
"dismissed_at",
|
|
9135
|
+
"dismissed_reason",
|
|
9136
|
+
"rule",
|
|
8559
9137
|
"tool",
|
|
8560
|
-
"
|
|
8561
|
-
"warning"
|
|
9138
|
+
"most_recent_instance"
|
|
8562
9139
|
]
|
|
8563
9140
|
},
|
|
8564
9141
|
"examples": {
|
|
8565
|
-
"
|
|
8566
|
-
"summary": "Default response",
|
|
9142
|
+
"default": {
|
|
8567
9143
|
"value": {
|
|
8568
|
-
"
|
|
8569
|
-
"
|
|
8570
|
-
"
|
|
8571
|
-
"
|
|
8572
|
-
"
|
|
8573
|
-
"
|
|
8574
|
-
|
|
8575
|
-
|
|
8576
|
-
|
|
8577
|
-
|
|
8578
|
-
|
|
8579
|
-
|
|
9144
|
+
"number": 42,
|
|
9145
|
+
"created_at": "2020-08-25T21:28:36Z",
|
|
9146
|
+
"url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42",
|
|
9147
|
+
"html_url": "https://github.com/octocat/hello-world/code-scanning/42",
|
|
9148
|
+
"state": "dismissed",
|
|
9149
|
+
"dismissed_by": {
|
|
9150
|
+
"login": "octocat",
|
|
9151
|
+
"id": 1,
|
|
9152
|
+
"node_id": "MDQ6VXNlcjE=",
|
|
9153
|
+
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
|
|
9154
|
+
"gravatar_id": "",
|
|
9155
|
+
"url": "https://api.github.com/users/octocat",
|
|
9156
|
+
"html_url": "https://github.com/octocat",
|
|
9157
|
+
"followers_url": "https://api.github.com/users/octocat/followers",
|
|
9158
|
+
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
|
|
9159
|
+
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
|
|
9160
|
+
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
|
|
9161
|
+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
|
|
9162
|
+
"organizations_url": "https://api.github.com/users/octocat/orgs",
|
|
9163
|
+
"repos_url": "https://api.github.com/users/octocat/repos",
|
|
9164
|
+
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
|
|
9165
|
+
"received_events_url": "https://api.github.com/users/octocat/received_events",
|
|
9166
|
+
"type": "User",
|
|
9167
|
+
"site_admin": false
|
|
9168
|
+
},
|
|
9169
|
+
"dismissed_at": "2020-09-02T22:34:56Z",
|
|
9170
|
+
"dismissed_reason": "false positive",
|
|
9171
|
+
"rule": {
|
|
9172
|
+
"id": "js/zipslip",
|
|
9173
|
+
"severity": "error",
|
|
9174
|
+
"security_severity_level": "high",
|
|
9175
|
+
"description": "Arbitrary file write during zip extraction (\"Zip Slip\")",
|
|
9176
|
+
"name": "js/zipslip",
|
|
9177
|
+
"full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.",
|
|
9178
|
+
"tags": ["security", "external/cwe/cwe-022"],
|
|
9179
|
+
"help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..."
|
|
9180
|
+
},
|
|
8580
9181
|
"tool": {
|
|
8581
9182
|
"name": "CodeQL",
|
|
8582
9183
|
"guid": null,
|
|
8583
9184
|
"version": "2.4.0"
|
|
8584
9185
|
},
|
|
8585
|
-
"
|
|
8586
|
-
|
|
9186
|
+
"most_recent_instance": {
|
|
9187
|
+
"ref": "refs/heads/main",
|
|
9188
|
+
"analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
|
|
9189
|
+
"environment": "{}",
|
|
9190
|
+
"state": "dismissed",
|
|
9191
|
+
"commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930",
|
|
9192
|
+
"message": {
|
|
9193
|
+
"text": "This path depends on a user-provided value."
|
|
9194
|
+
},
|
|
9195
|
+
"location": {
|
|
9196
|
+
"path": "spec-main/api-session-spec.ts",
|
|
9197
|
+
"start_line": 917,
|
|
9198
|
+
"end_line": 917,
|
|
9199
|
+
"start_column": 7,
|
|
9200
|
+
"end_column": 18
|
|
9201
|
+
},
|
|
9202
|
+
"classifications": ["test"]
|
|
9203
|
+
},
|
|
9204
|
+
"instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances"
|
|
8587
9205
|
}
|
|
8588
9206
|
}
|
|
8589
9207
|
}
|
|
@@ -8591,7 +9209,7 @@
|
|
|
8591
9209
|
}
|
|
8592
9210
|
},
|
|
8593
9211
|
"403": {
|
|
8594
|
-
"description": "Response if
|
|
9212
|
+
"description": "Response if the repository is archived or if github advanced security is not enabled for this repository",
|
|
8595
9213
|
"content": {
|
|
8596
9214
|
"application/json": {
|
|
8597
9215
|
"schema": {
|
|
@@ -8651,15 +9269,15 @@
|
|
|
8651
9269
|
"x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
|
|
8652
9270
|
}
|
|
8653
9271
|
},
|
|
8654
|
-
"/repos/{owner}/{repo}/
|
|
9272
|
+
"/repos/{owner}/{repo}/code-scanning/analyses": {
|
|
8655
9273
|
"get": {
|
|
8656
|
-
"summary": "List
|
|
8657
|
-
"description": "
|
|
8658
|
-
"operationId": "
|
|
8659
|
-
"tags": ["
|
|
9274
|
+
"summary": "List code scanning analyses for a repository",
|
|
9275
|
+
"description": "Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the `page` and `per_page` parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.\n\nThe `rules_count` field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.",
|
|
9276
|
+
"operationId": "code-scanning/list-recent-analyses",
|
|
9277
|
+
"tags": ["code-scanning"],
|
|
8660
9278
|
"externalDocs": {
|
|
8661
9279
|
"description": "API method documentation",
|
|
8662
|
-
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/
|
|
9280
|
+
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/code-scanning#list-code-scanning-analyses-for-a-repository"
|
|
8663
9281
|
},
|
|
8664
9282
|
"parameters": [
|
|
8665
9283
|
{
|
|
@@ -8675,10 +9293,25 @@
|
|
|
8675
9293
|
"schema": { "type": "string" }
|
|
8676
9294
|
},
|
|
8677
9295
|
{
|
|
8678
|
-
"name": "
|
|
8679
|
-
"description": "
|
|
9296
|
+
"name": "tool_name",
|
|
9297
|
+
"description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.",
|
|
8680
9298
|
"in": "query",
|
|
8681
|
-
"
|
|
9299
|
+
"required": false,
|
|
9300
|
+
"schema": {
|
|
9301
|
+
"type": "string",
|
|
9302
|
+
"description": "The name of the tool used to generate the code scanning analysis."
|
|
9303
|
+
}
|
|
9304
|
+
},
|
|
9305
|
+
{
|
|
9306
|
+
"name": "tool_guid",
|
|
9307
|
+
"description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.",
|
|
9308
|
+
"in": "query",
|
|
9309
|
+
"required": false,
|
|
9310
|
+
"schema": {
|
|
9311
|
+
"nullable": true,
|
|
9312
|
+
"type": "string",
|
|
9313
|
+
"description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data."
|
|
9314
|
+
}
|
|
8682
9315
|
},
|
|
8683
9316
|
{
|
|
8684
9317
|
"name": "page",
|
|
@@ -8687,24 +9320,31 @@
|
|
|
8687
9320
|
"schema": { "type": "integer", "default": 1 }
|
|
8688
9321
|
},
|
|
8689
9322
|
{
|
|
8690
|
-
"name": "
|
|
8691
|
-
"description": "
|
|
9323
|
+
"name": "per_page",
|
|
9324
|
+
"description": "Results per page (max 100)",
|
|
9325
|
+
"in": "query",
|
|
9326
|
+
"schema": { "type": "integer", "default": 30 }
|
|
9327
|
+
},
|
|
9328
|
+
{
|
|
9329
|
+
"name": "ref",
|
|
8692
9330
|
"in": "query",
|
|
9331
|
+
"description": "The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/<branch name>` or simply `<branch name>`. To reference a pull request use `refs/pull/<number>/merge`.",
|
|
8693
9332
|
"required": false,
|
|
8694
9333
|
"schema": {
|
|
8695
9334
|
"type": "string",
|
|
8696
|
-
"
|
|
8697
|
-
"default": "desc"
|
|
9335
|
+
"description": "The full Git reference, formatted as `refs/heads/<branch name>`,\n`refs/pull/<number>/merge`, or `refs/pull/<number>/head`."
|
|
8698
9336
|
}
|
|
8699
9337
|
},
|
|
8700
9338
|
{
|
|
8701
|
-
"name": "
|
|
9339
|
+
"name": "sarif_id",
|
|
8702
9340
|
"in": "query",
|
|
9341
|
+
"description": "Filter analyses belonging to the same SARIF upload.",
|
|
8703
9342
|
"required": false,
|
|
8704
9343
|
"schema": {
|
|
8705
9344
|
"type": "string",
|
|
8706
|
-
"
|
|
8707
|
-
"
|
|
9345
|
+
"description": "An identifier for the upload.",
|
|
9346
|
+
"example": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53",
|
|
9347
|
+
"nullable": false
|
|
8708
9348
|
}
|
|
8709
9349
|
}
|
|
8710
9350
|
],
|
|
@@ -8718,54 +9358,231 @@
|
|
|
8718
9358
|
"items": {
|
|
8719
9359
|
"type": "object",
|
|
8720
9360
|
"properties": {
|
|
8721
|
-
"
|
|
8722
|
-
|
|
8723
|
-
|
|
8724
|
-
|
|
8725
|
-
|
|
9361
|
+
"ref": {
|
|
9362
|
+
"type": "string",
|
|
9363
|
+
"description": "The full Git reference, formatted as `refs/heads/<branch name>`,\n`refs/pull/<number>/merge`, or `refs/pull/<number>/head`."
|
|
9364
|
+
},
|
|
9365
|
+
"commit_sha": {
|
|
9366
|
+
"description": "The SHA of the commit to which the analysis you are uploading relates.",
|
|
9367
|
+
"type": "string",
|
|
9368
|
+
"minLength": 40,
|
|
9369
|
+
"maxLength": 40,
|
|
9370
|
+
"pattern": "^[0-9a-fA-F]+$"
|
|
9371
|
+
},
|
|
9372
|
+
"analysis_key": {
|
|
9373
|
+
"type": "string",
|
|
9374
|
+
"description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name."
|
|
9375
|
+
},
|
|
9376
|
+
"environment": {
|
|
9377
|
+
"type": "string",
|
|
9378
|
+
"description": "Identifies the variable values associated with the environment in which this analysis was performed."
|
|
9379
|
+
},
|
|
9380
|
+
"category": {
|
|
9381
|
+
"type": "string",
|
|
9382
|
+
"description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code."
|
|
9383
|
+
},
|
|
9384
|
+
"error": {
|
|
9385
|
+
"type": "string",
|
|
9386
|
+
"example": "error reading field xyz"
|
|
9387
|
+
},
|
|
9388
|
+
"created_at": {
|
|
9389
|
+
"type": "string",
|
|
9390
|
+
"description": "The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
|
|
9391
|
+
"format": "date-time",
|
|
9392
|
+
"readOnly": true,
|
|
9393
|
+
"nullable": false
|
|
9394
|
+
},
|
|
9395
|
+
"results_count": {
|
|
9396
|
+
"type": "integer",
|
|
9397
|
+
"description": "The total number of results in the analysis."
|
|
9398
|
+
},
|
|
9399
|
+
"rules_count": {
|
|
9400
|
+
"type": "integer",
|
|
9401
|
+
"description": "The total number of rules used in the analysis."
|
|
9402
|
+
},
|
|
9403
|
+
"id": {
|
|
9404
|
+
"type": "integer",
|
|
9405
|
+
"description": "Unique identifier for this analysis."
|
|
9406
|
+
},
|
|
9407
|
+
"url": {
|
|
9408
|
+
"type": "string",
|
|
9409
|
+
"description": "The REST API URL of the analysis resource.",
|
|
9410
|
+
"format": "uri",
|
|
9411
|
+
"readOnly": true,
|
|
9412
|
+
"nullable": false
|
|
9413
|
+
},
|
|
9414
|
+
"sarif_id": {
|
|
9415
|
+
"type": "string",
|
|
9416
|
+
"description": "An identifier for the upload.",
|
|
9417
|
+
"example": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53",
|
|
9418
|
+
"nullable": false
|
|
9419
|
+
},
|
|
9420
|
+
"tool": {
|
|
9421
|
+
"type": "object",
|
|
9422
|
+
"properties": {
|
|
9423
|
+
"name": {
|
|
9424
|
+
"type": "string",
|
|
9425
|
+
"description": "The name of the tool used to generate the code scanning analysis."
|
|
9426
|
+
},
|
|
9427
|
+
"version": {
|
|
9428
|
+
"nullable": true,
|
|
9429
|
+
"type": "string",
|
|
9430
|
+
"description": "The version of the tool used to generate the code scanning analysis."
|
|
9431
|
+
},
|
|
9432
|
+
"guid": {
|
|
9433
|
+
"nullable": true,
|
|
9434
|
+
"type": "string",
|
|
9435
|
+
"description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data."
|
|
9436
|
+
}
|
|
9437
|
+
}
|
|
9438
|
+
},
|
|
9439
|
+
"deletable": { "type": "boolean" },
|
|
9440
|
+
"warning": {
|
|
9441
|
+
"type": "string",
|
|
9442
|
+
"description": "Warning generated when processing the analysis",
|
|
9443
|
+
"example": "123 results were ignored"
|
|
9444
|
+
},
|
|
9445
|
+
"tool_name": { "type": "string" }
|
|
9446
|
+
},
|
|
9447
|
+
"required": [
|
|
9448
|
+
"ref",
|
|
9449
|
+
"commit_sha",
|
|
9450
|
+
"analysis_key",
|
|
9451
|
+
"environment",
|
|
9452
|
+
"error",
|
|
9453
|
+
"created_at",
|
|
9454
|
+
"results_count",
|
|
9455
|
+
"rules_count",
|
|
9456
|
+
"id",
|
|
9457
|
+
"url",
|
|
9458
|
+
"sarif_id",
|
|
9459
|
+
"tool",
|
|
9460
|
+
"deletable",
|
|
9461
|
+
"warning"
|
|
9462
|
+
]
|
|
8726
9463
|
}
|
|
8727
9464
|
},
|
|
8728
9465
|
"examples": {
|
|
8729
9466
|
"default": {
|
|
8730
9467
|
"value": [
|
|
8731
9468
|
{
|
|
8732
|
-
"
|
|
8733
|
-
"
|
|
8734
|
-
"
|
|
8735
|
-
"
|
|
9469
|
+
"ref": "refs/heads/main",
|
|
9470
|
+
"commit_sha": "d99612c3e1f2970085cfbaeadf8f010ef69bad83",
|
|
9471
|
+
"analysis_key": ".github/workflows/codeql-analysis.yml:analyze",
|
|
9472
|
+
"environment": "{\"language\":\"python\"}",
|
|
9473
|
+
"error": "",
|
|
9474
|
+
"category": ".github/workflows/codeql-analysis.yml:analyze/language:python",
|
|
9475
|
+
"created_at": "2020-08-27T15:05:21Z",
|
|
9476
|
+
"results_count": 17,
|
|
9477
|
+
"rules_count": 49,
|
|
9478
|
+
"id": 201,
|
|
9479
|
+
"url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201",
|
|
9480
|
+
"sarif_id": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53",
|
|
9481
|
+
"tool": {
|
|
9482
|
+
"name": "CodeQL",
|
|
9483
|
+
"guid": null,
|
|
9484
|
+
"version": "2.4.0"
|
|
9485
|
+
},
|
|
9486
|
+
"deletable": true,
|
|
9487
|
+
"warning": ""
|
|
9488
|
+
},
|
|
9489
|
+
{
|
|
9490
|
+
"ref": "refs/heads/my-branch",
|
|
9491
|
+
"commit_sha": "c8cff6510d4d084fb1b4aa13b64b97ca12b07321",
|
|
9492
|
+
"analysis_key": ".github/workflows/shiftleft.yml:build",
|
|
9493
|
+
"environment": "{}",
|
|
9494
|
+
"error": "",
|
|
9495
|
+
"category": ".github/workflows/shiftleft.yml:build/",
|
|
9496
|
+
"created_at": "2020-08-31T22:46:44Z",
|
|
9497
|
+
"results_count": 17,
|
|
9498
|
+
"rules_count": 32,
|
|
9499
|
+
"id": 200,
|
|
9500
|
+
"url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200",
|
|
9501
|
+
"sarif_id": "8981cd8e-b078-4ac3-a3be-1dad7dbd0b582",
|
|
9502
|
+
"tool": {
|
|
9503
|
+
"name": "Python Security Analysis",
|
|
9504
|
+
"guid": null,
|
|
9505
|
+
"version": "1.2.0"
|
|
9506
|
+
},
|
|
9507
|
+
"deletable": true,
|
|
9508
|
+
"warning": ""
|
|
8736
9509
|
}
|
|
8737
9510
|
]
|
|
8738
9511
|
}
|
|
8739
9512
|
}
|
|
8740
9513
|
}
|
|
8741
9514
|
}
|
|
9515
|
+
},
|
|
9516
|
+
"403": {
|
|
9517
|
+
"description": "Response if GitHub Advanced Security is not enabled for this repository",
|
|
9518
|
+
"content": {
|
|
9519
|
+
"application/json": {
|
|
9520
|
+
"schema": {
|
|
9521
|
+
"title": "Basic Error",
|
|
9522
|
+
"description": "Basic Error",
|
|
9523
|
+
"type": "object",
|
|
9524
|
+
"properties": {
|
|
9525
|
+
"message": { "type": "string" },
|
|
9526
|
+
"documentation_url": { "type": "string" },
|
|
9527
|
+
"url": { "type": "string" },
|
|
9528
|
+
"status": { "type": "string" }
|
|
9529
|
+
}
|
|
9530
|
+
}
|
|
9531
|
+
}
|
|
9532
|
+
}
|
|
9533
|
+
},
|
|
9534
|
+
"404": {
|
|
9535
|
+
"description": "Resource not found",
|
|
9536
|
+
"content": {
|
|
9537
|
+
"application/json": {
|
|
9538
|
+
"schema": {
|
|
9539
|
+
"title": "Basic Error",
|
|
9540
|
+
"description": "Basic Error",
|
|
9541
|
+
"type": "object",
|
|
9542
|
+
"properties": {
|
|
9543
|
+
"message": { "type": "string" },
|
|
9544
|
+
"documentation_url": { "type": "string" },
|
|
9545
|
+
"url": { "type": "string" },
|
|
9546
|
+
"status": { "type": "string" }
|
|
9547
|
+
}
|
|
9548
|
+
}
|
|
9549
|
+
}
|
|
9550
|
+
}
|
|
9551
|
+
},
|
|
9552
|
+
"503": {
|
|
9553
|
+
"description": "Service unavailable",
|
|
9554
|
+
"content": {
|
|
9555
|
+
"application/json": {
|
|
9556
|
+
"schema": {
|
|
9557
|
+
"type": "object",
|
|
9558
|
+
"properties": {
|
|
9559
|
+
"code": { "type": "string" },
|
|
9560
|
+
"message": { "type": "string" },
|
|
9561
|
+
"documentation_url": { "type": "string" }
|
|
9562
|
+
}
|
|
9563
|
+
}
|
|
9564
|
+
}
|
|
9565
|
+
}
|
|
8742
9566
|
}
|
|
8743
9567
|
},
|
|
8744
9568
|
"x-github": {
|
|
8745
|
-
"githubCloudOnly": false,
|
|
8746
9569
|
"enabledForGitHubApps": true,
|
|
8747
|
-
"
|
|
8748
|
-
|
|
8749
|
-
|
|
8750
|
-
"name": "eye-scream",
|
|
8751
|
-
"note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
|
|
8752
|
-
}
|
|
8753
|
-
],
|
|
8754
|
-
"category": "enterprise-admin",
|
|
8755
|
-
"subcategory": "repo-pre-receive-hooks"
|
|
9570
|
+
"githubCloudOnly": false,
|
|
9571
|
+
"previews": [],
|
|
9572
|
+
"category": "code-scanning"
|
|
8756
9573
|
},
|
|
8757
|
-
"x-octokit": { "diff": { "api.github.com": { "type": "
|
|
9574
|
+
"x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
|
|
8758
9575
|
}
|
|
8759
9576
|
},
|
|
8760
|
-
"/repos/{owner}/{repo}/
|
|
9577
|
+
"/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": {
|
|
8761
9578
|
"get": {
|
|
8762
|
-
"summary": "Get a
|
|
8763
|
-
"description": "",
|
|
8764
|
-
"operationId": "
|
|
8765
|
-
"tags": ["
|
|
9579
|
+
"summary": "Get a code scanning analysis for a repository",
|
|
9580
|
+
"description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.",
|
|
9581
|
+
"operationId": "code-scanning/get-analysis",
|
|
9582
|
+
"tags": ["code-scanning"],
|
|
8766
9583
|
"externalDocs": {
|
|
8767
9584
|
"description": "API method documentation",
|
|
8768
|
-
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/
|
|
9585
|
+
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository"
|
|
8769
9586
|
},
|
|
8770
9587
|
"parameters": [
|
|
8771
9588
|
{
|
|
@@ -8781,9 +9598,9 @@
|
|
|
8781
9598
|
"schema": { "type": "string" }
|
|
8782
9599
|
},
|
|
8783
9600
|
{
|
|
8784
|
-
"name": "
|
|
8785
|
-
"description": "pre_receive_hook_id parameter",
|
|
9601
|
+
"name": "analysis_id",
|
|
8786
9602
|
"in": "path",
|
|
9603
|
+
"description": "The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation.",
|
|
8787
9604
|
"required": true,
|
|
8788
9605
|
"schema": { "type": "integer" }
|
|
8789
9606
|
}
|
|
@@ -8792,53 +9609,213 @@
|
|
|
8792
9609
|
"200": {
|
|
8793
9610
|
"description": "Response",
|
|
8794
9611
|
"content": {
|
|
9612
|
+
"application/json+sarif": { "schema": { "type": "string" } },
|
|
8795
9613
|
"application/json": {
|
|
8796
9614
|
"schema": {
|
|
8797
9615
|
"type": "object",
|
|
8798
9616
|
"properties": {
|
|
8799
|
-
"
|
|
8800
|
-
|
|
8801
|
-
|
|
8802
|
-
|
|
8803
|
-
|
|
9617
|
+
"ref": {
|
|
9618
|
+
"type": "string",
|
|
9619
|
+
"description": "The full Git reference, formatted as `refs/heads/<branch name>`,\n`refs/pull/<number>/merge`, or `refs/pull/<number>/head`."
|
|
9620
|
+
},
|
|
9621
|
+
"commit_sha": {
|
|
9622
|
+
"description": "The SHA of the commit to which the analysis you are uploading relates.",
|
|
9623
|
+
"type": "string",
|
|
9624
|
+
"minLength": 40,
|
|
9625
|
+
"maxLength": 40,
|
|
9626
|
+
"pattern": "^[0-9a-fA-F]+$"
|
|
9627
|
+
},
|
|
9628
|
+
"analysis_key": {
|
|
9629
|
+
"type": "string",
|
|
9630
|
+
"description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name."
|
|
9631
|
+
},
|
|
9632
|
+
"environment": {
|
|
9633
|
+
"type": "string",
|
|
9634
|
+
"description": "Identifies the variable values associated with the environment in which this analysis was performed."
|
|
9635
|
+
},
|
|
9636
|
+
"category": {
|
|
9637
|
+
"type": "string",
|
|
9638
|
+
"description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code."
|
|
9639
|
+
},
|
|
9640
|
+
"error": {
|
|
9641
|
+
"type": "string",
|
|
9642
|
+
"example": "error reading field xyz"
|
|
9643
|
+
},
|
|
9644
|
+
"created_at": {
|
|
9645
|
+
"type": "string",
|
|
9646
|
+
"description": "The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
|
|
9647
|
+
"format": "date-time",
|
|
9648
|
+
"readOnly": true,
|
|
9649
|
+
"nullable": false
|
|
9650
|
+
},
|
|
9651
|
+
"results_count": {
|
|
9652
|
+
"type": "integer",
|
|
9653
|
+
"description": "The total number of results in the analysis."
|
|
9654
|
+
},
|
|
9655
|
+
"rules_count": {
|
|
9656
|
+
"type": "integer",
|
|
9657
|
+
"description": "The total number of rules used in the analysis."
|
|
9658
|
+
},
|
|
9659
|
+
"id": {
|
|
9660
|
+
"type": "integer",
|
|
9661
|
+
"description": "Unique identifier for this analysis."
|
|
9662
|
+
},
|
|
9663
|
+
"url": {
|
|
9664
|
+
"type": "string",
|
|
9665
|
+
"description": "The REST API URL of the analysis resource.",
|
|
9666
|
+
"format": "uri",
|
|
9667
|
+
"readOnly": true,
|
|
9668
|
+
"nullable": false
|
|
9669
|
+
},
|
|
9670
|
+
"sarif_id": {
|
|
9671
|
+
"type": "string",
|
|
9672
|
+
"description": "An identifier for the upload.",
|
|
9673
|
+
"example": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53",
|
|
9674
|
+
"nullable": false
|
|
9675
|
+
},
|
|
9676
|
+
"tool": {
|
|
9677
|
+
"type": "object",
|
|
9678
|
+
"properties": {
|
|
9679
|
+
"name": {
|
|
9680
|
+
"type": "string",
|
|
9681
|
+
"description": "The name of the tool used to generate the code scanning analysis."
|
|
9682
|
+
},
|
|
9683
|
+
"version": {
|
|
9684
|
+
"nullable": true,
|
|
9685
|
+
"type": "string",
|
|
9686
|
+
"description": "The version of the tool used to generate the code scanning analysis."
|
|
9687
|
+
},
|
|
9688
|
+
"guid": {
|
|
9689
|
+
"nullable": true,
|
|
9690
|
+
"type": "string",
|
|
9691
|
+
"description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data."
|
|
9692
|
+
}
|
|
9693
|
+
}
|
|
9694
|
+
},
|
|
9695
|
+
"deletable": { "type": "boolean" },
|
|
9696
|
+
"warning": {
|
|
9697
|
+
"type": "string",
|
|
9698
|
+
"description": "Warning generated when processing the analysis",
|
|
9699
|
+
"example": "123 results were ignored"
|
|
9700
|
+
},
|
|
9701
|
+
"tool_name": { "type": "string" }
|
|
9702
|
+
},
|
|
9703
|
+
"required": [
|
|
9704
|
+
"ref",
|
|
9705
|
+
"commit_sha",
|
|
9706
|
+
"analysis_key",
|
|
9707
|
+
"environment",
|
|
9708
|
+
"error",
|
|
9709
|
+
"created_at",
|
|
9710
|
+
"results_count",
|
|
9711
|
+
"rules_count",
|
|
9712
|
+
"id",
|
|
9713
|
+
"url",
|
|
9714
|
+
"sarif_id",
|
|
9715
|
+
"tool",
|
|
9716
|
+
"deletable",
|
|
9717
|
+
"warning"
|
|
9718
|
+
]
|
|
8804
9719
|
},
|
|
8805
9720
|
"examples": {
|
|
8806
|
-
"
|
|
9721
|
+
"response": {
|
|
9722
|
+
"summary": "Default response",
|
|
8807
9723
|
"value": {
|
|
8808
|
-
"
|
|
8809
|
-
"
|
|
8810
|
-
"
|
|
8811
|
-
"
|
|
9724
|
+
"ref": "refs/heads/main",
|
|
9725
|
+
"commit_sha": "c18c69115654ff0166991962832dc2bd7756e655",
|
|
9726
|
+
"analysis_key": ".github/workflows/codeql-analysis.yml:analyze",
|
|
9727
|
+
"environment": "{\"language\":\"javascript\"}",
|
|
9728
|
+
"error": "",
|
|
9729
|
+
"category": ".github/workflows/codeql-analysis.yml:analyze/language:javascript",
|
|
9730
|
+
"created_at": "2021-01-13T11:55:49Z",
|
|
9731
|
+
"results_count": 3,
|
|
9732
|
+
"rules_count": 67,
|
|
9733
|
+
"id": 3602840,
|
|
9734
|
+
"url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201",
|
|
9735
|
+
"sarif_id": "47177e22-5596-11eb-80a1-c1e54ef945c6",
|
|
9736
|
+
"tool": {
|
|
9737
|
+
"name": "CodeQL",
|
|
9738
|
+
"guid": null,
|
|
9739
|
+
"version": "2.4.0"
|
|
9740
|
+
},
|
|
9741
|
+
"deletable": true,
|
|
9742
|
+
"warning": ""
|
|
8812
9743
|
}
|
|
8813
9744
|
}
|
|
8814
9745
|
}
|
|
8815
9746
|
}
|
|
8816
9747
|
}
|
|
9748
|
+
},
|
|
9749
|
+
"403": {
|
|
9750
|
+
"description": "Response if GitHub Advanced Security is not enabled for this repository",
|
|
9751
|
+
"content": {
|
|
9752
|
+
"application/json": {
|
|
9753
|
+
"schema": {
|
|
9754
|
+
"title": "Basic Error",
|
|
9755
|
+
"description": "Basic Error",
|
|
9756
|
+
"type": "object",
|
|
9757
|
+
"properties": {
|
|
9758
|
+
"message": { "type": "string" },
|
|
9759
|
+
"documentation_url": { "type": "string" },
|
|
9760
|
+
"url": { "type": "string" },
|
|
9761
|
+
"status": { "type": "string" }
|
|
9762
|
+
}
|
|
9763
|
+
}
|
|
9764
|
+
}
|
|
9765
|
+
}
|
|
9766
|
+
},
|
|
9767
|
+
"404": {
|
|
9768
|
+
"description": "Resource not found",
|
|
9769
|
+
"content": {
|
|
9770
|
+
"application/json": {
|
|
9771
|
+
"schema": {
|
|
9772
|
+
"title": "Basic Error",
|
|
9773
|
+
"description": "Basic Error",
|
|
9774
|
+
"type": "object",
|
|
9775
|
+
"properties": {
|
|
9776
|
+
"message": { "type": "string" },
|
|
9777
|
+
"documentation_url": { "type": "string" },
|
|
9778
|
+
"url": { "type": "string" },
|
|
9779
|
+
"status": { "type": "string" }
|
|
9780
|
+
}
|
|
9781
|
+
}
|
|
9782
|
+
}
|
|
9783
|
+
}
|
|
9784
|
+
},
|
|
9785
|
+
"503": {
|
|
9786
|
+
"description": "Service unavailable",
|
|
9787
|
+
"content": {
|
|
9788
|
+
"application/json": {
|
|
9789
|
+
"schema": {
|
|
9790
|
+
"type": "object",
|
|
9791
|
+
"properties": {
|
|
9792
|
+
"code": { "type": "string" },
|
|
9793
|
+
"message": { "type": "string" },
|
|
9794
|
+
"documentation_url": { "type": "string" }
|
|
9795
|
+
}
|
|
9796
|
+
}
|
|
9797
|
+
}
|
|
9798
|
+
}
|
|
8817
9799
|
}
|
|
8818
9800
|
},
|
|
8819
9801
|
"x-github": {
|
|
8820
|
-
"githubCloudOnly": false,
|
|
8821
9802
|
"enabledForGitHubApps": true,
|
|
8822
|
-
"
|
|
8823
|
-
|
|
8824
|
-
|
|
8825
|
-
"name": "eye-scream",
|
|
8826
|
-
"note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
|
|
8827
|
-
}
|
|
8828
|
-
],
|
|
8829
|
-
"category": "enterprise-admin",
|
|
8830
|
-
"subcategory": "repo-pre-receive-hooks"
|
|
9803
|
+
"githubCloudOnly": false,
|
|
9804
|
+
"previews": [],
|
|
9805
|
+
"category": "code-scanning"
|
|
8831
9806
|
},
|
|
8832
|
-
"x-octokit": { "diff": { "api.github.com": { "type": "
|
|
8833
|
-
}
|
|
8834
|
-
|
|
8835
|
-
|
|
8836
|
-
|
|
8837
|
-
"
|
|
9807
|
+
"x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
|
|
9808
|
+
}
|
|
9809
|
+
},
|
|
9810
|
+
"/repos/{owner}/{repo}/pre-receive-hooks": {
|
|
9811
|
+
"get": {
|
|
9812
|
+
"summary": "List pre-receive hooks for a repository",
|
|
9813
|
+
"description": "List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.",
|
|
9814
|
+
"operationId": "enterprise-admin/list-pre-receive-hooks-for-repo",
|
|
8838
9815
|
"tags": ["enterprise-admin"],
|
|
8839
9816
|
"externalDocs": {
|
|
8840
9817
|
"description": "API method documentation",
|
|
8841
|
-
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#
|
|
9818
|
+
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#list-pre-receive-hooks-for-a-repository"
|
|
8842
9819
|
},
|
|
8843
9820
|
"parameters": [
|
|
8844
9821
|
{
|
|
@@ -8854,11 +9831,37 @@
|
|
|
8854
9831
|
"schema": { "type": "string" }
|
|
8855
9832
|
},
|
|
8856
9833
|
{
|
|
8857
|
-
"name": "
|
|
8858
|
-
"description": "
|
|
8859
|
-
"in": "
|
|
8860
|
-
"
|
|
8861
|
-
|
|
9834
|
+
"name": "per_page",
|
|
9835
|
+
"description": "Results per page (max 100)",
|
|
9836
|
+
"in": "query",
|
|
9837
|
+
"schema": { "type": "integer", "default": 30 }
|
|
9838
|
+
},
|
|
9839
|
+
{
|
|
9840
|
+
"name": "page",
|
|
9841
|
+
"description": "Page number of the results to fetch.",
|
|
9842
|
+
"in": "query",
|
|
9843
|
+
"schema": { "type": "integer", "default": 1 }
|
|
9844
|
+
},
|
|
9845
|
+
{
|
|
9846
|
+
"name": "direction",
|
|
9847
|
+
"description": "One of `asc` (ascending) or `desc` (descending).",
|
|
9848
|
+
"in": "query",
|
|
9849
|
+
"required": false,
|
|
9850
|
+
"schema": {
|
|
9851
|
+
"type": "string",
|
|
9852
|
+
"enum": ["asc", "desc"],
|
|
9853
|
+
"default": "desc"
|
|
9854
|
+
}
|
|
9855
|
+
},
|
|
9856
|
+
{
|
|
9857
|
+
"name": "sort",
|
|
9858
|
+
"in": "query",
|
|
9859
|
+
"required": false,
|
|
9860
|
+
"schema": {
|
|
9861
|
+
"type": "string",
|
|
9862
|
+
"enum": ["created", "updated", "name"],
|
|
9863
|
+
"default": "created"
|
|
9864
|
+
}
|
|
8862
9865
|
}
|
|
8863
9866
|
],
|
|
8864
9867
|
"responses": {
|
|
@@ -8867,14 +9870,167 @@
|
|
|
8867
9870
|
"content": {
|
|
8868
9871
|
"application/json": {
|
|
8869
9872
|
"schema": {
|
|
8870
|
-
"type": "
|
|
8871
|
-
"
|
|
8872
|
-
"
|
|
8873
|
-
"
|
|
8874
|
-
|
|
8875
|
-
|
|
8876
|
-
|
|
8877
|
-
|
|
9873
|
+
"type": "array",
|
|
9874
|
+
"items": {
|
|
9875
|
+
"type": "object",
|
|
9876
|
+
"properties": {
|
|
9877
|
+
"id": { "type": "integer" },
|
|
9878
|
+
"name": { "type": "string" },
|
|
9879
|
+
"enforcement": { "type": "string" },
|
|
9880
|
+
"configuration_url": { "type": "string" }
|
|
9881
|
+
}
|
|
9882
|
+
}
|
|
9883
|
+
},
|
|
9884
|
+
"examples": {
|
|
9885
|
+
"default": {
|
|
9886
|
+
"value": [
|
|
9887
|
+
{
|
|
9888
|
+
"id": 42,
|
|
9889
|
+
"name": "Check Commits",
|
|
9890
|
+
"enforcement": "disabled",
|
|
9891
|
+
"configuration_url": "https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42"
|
|
9892
|
+
}
|
|
9893
|
+
]
|
|
9894
|
+
}
|
|
9895
|
+
}
|
|
9896
|
+
}
|
|
9897
|
+
}
|
|
9898
|
+
}
|
|
9899
|
+
},
|
|
9900
|
+
"x-github": {
|
|
9901
|
+
"githubCloudOnly": false,
|
|
9902
|
+
"enabledForGitHubApps": true,
|
|
9903
|
+
"previews": [
|
|
9904
|
+
{
|
|
9905
|
+
"required": true,
|
|
9906
|
+
"name": "eye-scream",
|
|
9907
|
+
"note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
|
|
9908
|
+
}
|
|
9909
|
+
],
|
|
9910
|
+
"category": "enterprise-admin",
|
|
9911
|
+
"subcategory": "repo-pre-receive-hooks"
|
|
9912
|
+
},
|
|
9913
|
+
"x-octokit": { "diff": { "api.github.com": { "type": "added" } } }
|
|
9914
|
+
}
|
|
9915
|
+
},
|
|
9916
|
+
"/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}": {
|
|
9917
|
+
"get": {
|
|
9918
|
+
"summary": "Get a pre-receive hook for a repository",
|
|
9919
|
+
"description": "",
|
|
9920
|
+
"operationId": "enterprise-admin/get-pre-receive-hook-for-repo",
|
|
9921
|
+
"tags": ["enterprise-admin"],
|
|
9922
|
+
"externalDocs": {
|
|
9923
|
+
"description": "API method documentation",
|
|
9924
|
+
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-a-repository"
|
|
9925
|
+
},
|
|
9926
|
+
"parameters": [
|
|
9927
|
+
{
|
|
9928
|
+
"name": "owner",
|
|
9929
|
+
"in": "path",
|
|
9930
|
+
"required": true,
|
|
9931
|
+
"schema": { "type": "string" }
|
|
9932
|
+
},
|
|
9933
|
+
{
|
|
9934
|
+
"name": "repo",
|
|
9935
|
+
"in": "path",
|
|
9936
|
+
"required": true,
|
|
9937
|
+
"schema": { "type": "string" }
|
|
9938
|
+
},
|
|
9939
|
+
{
|
|
9940
|
+
"name": "pre_receive_hook_id",
|
|
9941
|
+
"description": "pre_receive_hook_id parameter",
|
|
9942
|
+
"in": "path",
|
|
9943
|
+
"required": true,
|
|
9944
|
+
"schema": { "type": "integer" }
|
|
9945
|
+
}
|
|
9946
|
+
],
|
|
9947
|
+
"responses": {
|
|
9948
|
+
"200": {
|
|
9949
|
+
"description": "Response",
|
|
9950
|
+
"content": {
|
|
9951
|
+
"application/json": {
|
|
9952
|
+
"schema": {
|
|
9953
|
+
"type": "object",
|
|
9954
|
+
"properties": {
|
|
9955
|
+
"id": { "type": "integer" },
|
|
9956
|
+
"name": { "type": "string" },
|
|
9957
|
+
"enforcement": { "type": "string" },
|
|
9958
|
+
"configuration_url": { "type": "string" }
|
|
9959
|
+
}
|
|
9960
|
+
},
|
|
9961
|
+
"examples": {
|
|
9962
|
+
"default": {
|
|
9963
|
+
"value": {
|
|
9964
|
+
"id": 42,
|
|
9965
|
+
"name": "Check Commits",
|
|
9966
|
+
"enforcement": "disabled",
|
|
9967
|
+
"configuration_url": "https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42"
|
|
9968
|
+
}
|
|
9969
|
+
}
|
|
9970
|
+
}
|
|
9971
|
+
}
|
|
9972
|
+
}
|
|
9973
|
+
}
|
|
9974
|
+
},
|
|
9975
|
+
"x-github": {
|
|
9976
|
+
"githubCloudOnly": false,
|
|
9977
|
+
"enabledForGitHubApps": true,
|
|
9978
|
+
"previews": [
|
|
9979
|
+
{
|
|
9980
|
+
"required": true,
|
|
9981
|
+
"name": "eye-scream",
|
|
9982
|
+
"note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
|
|
9983
|
+
}
|
|
9984
|
+
],
|
|
9985
|
+
"category": "enterprise-admin",
|
|
9986
|
+
"subcategory": "repo-pre-receive-hooks"
|
|
9987
|
+
},
|
|
9988
|
+
"x-octokit": { "diff": { "api.github.com": { "type": "added" } } }
|
|
9989
|
+
},
|
|
9990
|
+
"patch": {
|
|
9991
|
+
"summary": "Update pre-receive hook enforcement for a repository",
|
|
9992
|
+
"description": "For pre-receive hooks which are allowed to be configured at the repo level, you can set `enforcement`",
|
|
9993
|
+
"operationId": "enterprise-admin/update-pre-receive-hook-enforcement-for-repo",
|
|
9994
|
+
"tags": ["enterprise-admin"],
|
|
9995
|
+
"externalDocs": {
|
|
9996
|
+
"description": "API method documentation",
|
|
9997
|
+
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#update-pre-receive-hook-enforcement-for-a-repository"
|
|
9998
|
+
},
|
|
9999
|
+
"parameters": [
|
|
10000
|
+
{
|
|
10001
|
+
"name": "owner",
|
|
10002
|
+
"in": "path",
|
|
10003
|
+
"required": true,
|
|
10004
|
+
"schema": { "type": "string" }
|
|
10005
|
+
},
|
|
10006
|
+
{
|
|
10007
|
+
"name": "repo",
|
|
10008
|
+
"in": "path",
|
|
10009
|
+
"required": true,
|
|
10010
|
+
"schema": { "type": "string" }
|
|
10011
|
+
},
|
|
10012
|
+
{
|
|
10013
|
+
"name": "pre_receive_hook_id",
|
|
10014
|
+
"description": "pre_receive_hook_id parameter",
|
|
10015
|
+
"in": "path",
|
|
10016
|
+
"required": true,
|
|
10017
|
+
"schema": { "type": "integer" }
|
|
10018
|
+
}
|
|
10019
|
+
],
|
|
10020
|
+
"responses": {
|
|
10021
|
+
"200": {
|
|
10022
|
+
"description": "Response",
|
|
10023
|
+
"content": {
|
|
10024
|
+
"application/json": {
|
|
10025
|
+
"schema": {
|
|
10026
|
+
"type": "object",
|
|
10027
|
+
"properties": {
|
|
10028
|
+
"id": { "type": "integer" },
|
|
10029
|
+
"name": { "type": "string" },
|
|
10030
|
+
"enforcement": { "type": "string" },
|
|
10031
|
+
"configuration_url": { "type": "string" }
|
|
10032
|
+
}
|
|
10033
|
+
},
|
|
8878
10034
|
"examples": {
|
|
8879
10035
|
"default": {
|
|
8880
10036
|
"value": {
|
|
@@ -9413,97 +10569,1161 @@
|
|
|
9413
10569
|
"tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0",
|
|
9414
10570
|
"zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0",
|
|
9415
10571
|
"id": 1,
|
|
9416
|
-
"node_id": "MDc6UmVsZWFzZTE=",
|
|
9417
|
-
"tag_name": "v1.0.0",
|
|
9418
|
-
"target_commitish": "master",
|
|
9419
|
-
"name": "v1.0.0",
|
|
9420
|
-
"body": "Description of the release",
|
|
9421
|
-
"draft": false,
|
|
9422
|
-
"prerelease": false,
|
|
9423
|
-
"created_at": "2013-02-27T19:35:32Z",
|
|
9424
|
-
"published_at": "2013-02-27T19:35:32Z",
|
|
9425
|
-
"author": {
|
|
9426
|
-
"login": "octocat",
|
|
10572
|
+
"node_id": "MDc6UmVsZWFzZTE=",
|
|
10573
|
+
"tag_name": "v1.0.0",
|
|
10574
|
+
"target_commitish": "master",
|
|
10575
|
+
"name": "v1.0.0",
|
|
10576
|
+
"body": "Description of the release",
|
|
10577
|
+
"draft": false,
|
|
10578
|
+
"prerelease": false,
|
|
10579
|
+
"created_at": "2013-02-27T19:35:32Z",
|
|
10580
|
+
"published_at": "2013-02-27T19:35:32Z",
|
|
10581
|
+
"author": {
|
|
10582
|
+
"login": "octocat",
|
|
10583
|
+
"id": 1,
|
|
10584
|
+
"node_id": "MDQ6VXNlcjE=",
|
|
10585
|
+
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
|
|
10586
|
+
"gravatar_id": "",
|
|
10587
|
+
"url": "https://api.github.com/users/octocat",
|
|
10588
|
+
"html_url": "https://github.com/octocat",
|
|
10589
|
+
"followers_url": "https://api.github.com/users/octocat/followers",
|
|
10590
|
+
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
|
|
10591
|
+
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
|
|
10592
|
+
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
|
|
10593
|
+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
|
|
10594
|
+
"organizations_url": "https://api.github.com/users/octocat/orgs",
|
|
10595
|
+
"repos_url": "https://api.github.com/users/octocat/repos",
|
|
10596
|
+
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
|
|
10597
|
+
"received_events_url": "https://api.github.com/users/octocat/received_events",
|
|
10598
|
+
"type": "User",
|
|
10599
|
+
"site_admin": false
|
|
10600
|
+
},
|
|
10601
|
+
"assets": [
|
|
10602
|
+
{
|
|
10603
|
+
"url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1",
|
|
10604
|
+
"browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip",
|
|
10605
|
+
"id": 1,
|
|
10606
|
+
"node_id": "MDEyOlJlbGVhc2VBc3NldDE=",
|
|
10607
|
+
"name": "example.zip",
|
|
10608
|
+
"label": "short description",
|
|
10609
|
+
"state": "uploaded",
|
|
10610
|
+
"content_type": "application/zip",
|
|
10611
|
+
"size": 1024,
|
|
10612
|
+
"download_count": 42,
|
|
10613
|
+
"created_at": "2013-02-27T19:35:32Z",
|
|
10614
|
+
"updated_at": "2013-02-27T19:35:32Z",
|
|
10615
|
+
"uploader": {
|
|
10616
|
+
"login": "octocat",
|
|
10617
|
+
"id": 1,
|
|
10618
|
+
"node_id": "MDQ6VXNlcjE=",
|
|
10619
|
+
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
|
|
10620
|
+
"gravatar_id": "",
|
|
10621
|
+
"url": "https://api.github.com/users/octocat",
|
|
10622
|
+
"html_url": "https://github.com/octocat",
|
|
10623
|
+
"followers_url": "https://api.github.com/users/octocat/followers",
|
|
10624
|
+
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
|
|
10625
|
+
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
|
|
10626
|
+
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
|
|
10627
|
+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
|
|
10628
|
+
"organizations_url": "https://api.github.com/users/octocat/orgs",
|
|
10629
|
+
"repos_url": "https://api.github.com/users/octocat/repos",
|
|
10630
|
+
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
|
|
10631
|
+
"received_events_url": "https://api.github.com/users/octocat/received_events",
|
|
10632
|
+
"type": "User",
|
|
10633
|
+
"site_admin": false
|
|
10634
|
+
}
|
|
10635
|
+
}
|
|
10636
|
+
]
|
|
10637
|
+
}
|
|
10638
|
+
]
|
|
10639
|
+
}
|
|
10640
|
+
}
|
|
10641
|
+
}
|
|
10642
|
+
},
|
|
10643
|
+
"headers": {
|
|
10644
|
+
"Link": {
|
|
10645
|
+
"example": "<https://api.github.com/resource?page=2>; rel=\"next\", <https://api.github.com/resource?page=5>; rel=\"last\"",
|
|
10646
|
+
"schema": { "type": "string" }
|
|
10647
|
+
}
|
|
10648
|
+
}
|
|
10649
|
+
},
|
|
10650
|
+
"404": {
|
|
10651
|
+
"description": "Resource not found",
|
|
10652
|
+
"content": {
|
|
10653
|
+
"application/json": {
|
|
10654
|
+
"schema": {
|
|
10655
|
+
"title": "Basic Error",
|
|
10656
|
+
"description": "Basic Error",
|
|
10657
|
+
"type": "object",
|
|
10658
|
+
"properties": {
|
|
10659
|
+
"message": { "type": "string" },
|
|
10660
|
+
"documentation_url": { "type": "string" },
|
|
10661
|
+
"url": { "type": "string" },
|
|
10662
|
+
"status": { "type": "string" }
|
|
10663
|
+
}
|
|
10664
|
+
}
|
|
10665
|
+
}
|
|
10666
|
+
}
|
|
10667
|
+
}
|
|
10668
|
+
},
|
|
10669
|
+
"x-github": {
|
|
10670
|
+
"githubCloudOnly": false,
|
|
10671
|
+
"enabledForGitHubApps": true,
|
|
10672
|
+
"previews": [],
|
|
10673
|
+
"category": "repos",
|
|
10674
|
+
"subcategory": "releases"
|
|
10675
|
+
},
|
|
10676
|
+
"x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
|
|
10677
|
+
},
|
|
10678
|
+
"post": {
|
|
10679
|
+
"summary": "Create a release",
|
|
10680
|
+
"description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.",
|
|
10681
|
+
"tags": ["repos"],
|
|
10682
|
+
"operationId": "repos/create-release",
|
|
10683
|
+
"externalDocs": {
|
|
10684
|
+
"description": "API method documentation",
|
|
10685
|
+
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#create-a-release"
|
|
10686
|
+
},
|
|
10687
|
+
"parameters": [
|
|
10688
|
+
{
|
|
10689
|
+
"name": "owner",
|
|
10690
|
+
"in": "path",
|
|
10691
|
+
"required": true,
|
|
10692
|
+
"schema": { "type": "string" }
|
|
10693
|
+
},
|
|
10694
|
+
{
|
|
10695
|
+
"name": "repo",
|
|
10696
|
+
"in": "path",
|
|
10697
|
+
"required": true,
|
|
10698
|
+
"schema": { "type": "string" }
|
|
10699
|
+
}
|
|
10700
|
+
],
|
|
10701
|
+
"requestBody": {
|
|
10702
|
+
"required": true,
|
|
10703
|
+
"content": {
|
|
10704
|
+
"application/json": {
|
|
10705
|
+
"schema": {
|
|
10706
|
+
"type": "object",
|
|
10707
|
+
"properties": {
|
|
10708
|
+
"tag_name": {
|
|
10709
|
+
"type": "string",
|
|
10710
|
+
"description": "The name of the tag."
|
|
10711
|
+
},
|
|
10712
|
+
"target_commitish": {
|
|
10713
|
+
"type": "string",
|
|
10714
|
+
"description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`)."
|
|
10715
|
+
},
|
|
10716
|
+
"name": {
|
|
10717
|
+
"type": "string",
|
|
10718
|
+
"description": "The name of the release."
|
|
10719
|
+
},
|
|
10720
|
+
"body": {
|
|
10721
|
+
"type": "string",
|
|
10722
|
+
"description": "Text describing the contents of the tag."
|
|
10723
|
+
},
|
|
10724
|
+
"draft": {
|
|
10725
|
+
"type": "boolean",
|
|
10726
|
+
"description": "`true` to create a draft (unpublished) release, `false` to create a published one.",
|
|
10727
|
+
"default": false
|
|
10728
|
+
},
|
|
10729
|
+
"prerelease": {
|
|
10730
|
+
"type": "boolean",
|
|
10731
|
+
"description": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.",
|
|
10732
|
+
"default": false
|
|
10733
|
+
}
|
|
10734
|
+
},
|
|
10735
|
+
"required": ["tag_name"]
|
|
10736
|
+
},
|
|
10737
|
+
"example": {
|
|
10738
|
+
"tag_name": "v1.0.0",
|
|
10739
|
+
"target_commitish": "master",
|
|
10740
|
+
"name": "v1.0.0",
|
|
10741
|
+
"body": "Description of the release",
|
|
10742
|
+
"draft": false,
|
|
10743
|
+
"prerelease": false
|
|
10744
|
+
}
|
|
10745
|
+
}
|
|
10746
|
+
}
|
|
10747
|
+
},
|
|
10748
|
+
"responses": {
|
|
10749
|
+
"201": {
|
|
10750
|
+
"description": "Response",
|
|
10751
|
+
"content": {
|
|
10752
|
+
"application/json": {
|
|
10753
|
+
"schema": {
|
|
10754
|
+
"title": "Release",
|
|
10755
|
+
"description": "A release.",
|
|
10756
|
+
"type": "object",
|
|
10757
|
+
"properties": {
|
|
10758
|
+
"url": { "type": "string", "format": "uri" },
|
|
10759
|
+
"html_url": { "type": "string", "format": "uri" },
|
|
10760
|
+
"assets_url": { "type": "string", "format": "uri" },
|
|
10761
|
+
"upload_url": { "type": "string" },
|
|
10762
|
+
"tarball_url": {
|
|
10763
|
+
"type": "string",
|
|
10764
|
+
"format": "uri",
|
|
10765
|
+
"nullable": true
|
|
10766
|
+
},
|
|
10767
|
+
"zipball_url": {
|
|
10768
|
+
"type": "string",
|
|
10769
|
+
"format": "uri",
|
|
10770
|
+
"nullable": true
|
|
10771
|
+
},
|
|
10772
|
+
"id": { "type": "integer" },
|
|
10773
|
+
"node_id": { "type": "string" },
|
|
10774
|
+
"tag_name": {
|
|
10775
|
+
"description": "The name of the tag.",
|
|
10776
|
+
"example": "v1.0.0",
|
|
10777
|
+
"type": "string"
|
|
10778
|
+
},
|
|
10779
|
+
"target_commitish": {
|
|
10780
|
+
"description": "Specifies the commitish value that determines where the Git tag is created from.",
|
|
10781
|
+
"example": "master",
|
|
10782
|
+
"type": "string"
|
|
10783
|
+
},
|
|
10784
|
+
"name": { "type": "string", "nullable": true },
|
|
10785
|
+
"body": { "type": "string", "nullable": true },
|
|
10786
|
+
"draft": {
|
|
10787
|
+
"description": "true to create a draft (unpublished) release, false to create a published one.",
|
|
10788
|
+
"example": false,
|
|
10789
|
+
"type": "boolean"
|
|
10790
|
+
},
|
|
10791
|
+
"prerelease": {
|
|
10792
|
+
"description": "Whether to identify the release as a prerelease or a full release.",
|
|
10793
|
+
"example": false,
|
|
10794
|
+
"type": "boolean"
|
|
10795
|
+
},
|
|
10796
|
+
"created_at": { "type": "string", "format": "date-time" },
|
|
10797
|
+
"published_at": {
|
|
10798
|
+
"type": "string",
|
|
10799
|
+
"format": "date-time",
|
|
10800
|
+
"nullable": true
|
|
10801
|
+
},
|
|
10802
|
+
"author": {
|
|
10803
|
+
"title": "Simple User",
|
|
10804
|
+
"description": "Simple User",
|
|
10805
|
+
"type": "object",
|
|
10806
|
+
"properties": {
|
|
10807
|
+
"name": { "nullable": true, "type": "string" },
|
|
10808
|
+
"email": { "nullable": true, "type": "string" },
|
|
10809
|
+
"login": { "type": "string", "example": "octocat" },
|
|
10810
|
+
"id": { "type": "integer", "example": 1 },
|
|
10811
|
+
"node_id": {
|
|
10812
|
+
"type": "string",
|
|
10813
|
+
"example": "MDQ6VXNlcjE="
|
|
10814
|
+
},
|
|
10815
|
+
"avatar_url": {
|
|
10816
|
+
"type": "string",
|
|
10817
|
+
"format": "uri",
|
|
10818
|
+
"example": "https://github.com/images/error/octocat_happy.gif"
|
|
10819
|
+
},
|
|
10820
|
+
"gravatar_id": {
|
|
10821
|
+
"type": "string",
|
|
10822
|
+
"example": "41d064eb2195891e12d0413f63227ea7",
|
|
10823
|
+
"nullable": true
|
|
10824
|
+
},
|
|
10825
|
+
"url": {
|
|
10826
|
+
"type": "string",
|
|
10827
|
+
"format": "uri",
|
|
10828
|
+
"example": "https://api.github.com/users/octocat"
|
|
10829
|
+
},
|
|
10830
|
+
"html_url": {
|
|
10831
|
+
"type": "string",
|
|
10832
|
+
"format": "uri",
|
|
10833
|
+
"example": "https://github.com/octocat"
|
|
10834
|
+
},
|
|
10835
|
+
"followers_url": {
|
|
10836
|
+
"type": "string",
|
|
10837
|
+
"format": "uri",
|
|
10838
|
+
"example": "https://api.github.com/users/octocat/followers"
|
|
10839
|
+
},
|
|
10840
|
+
"following_url": {
|
|
10841
|
+
"type": "string",
|
|
10842
|
+
"example": "https://api.github.com/users/octocat/following{/other_user}"
|
|
10843
|
+
},
|
|
10844
|
+
"gists_url": {
|
|
10845
|
+
"type": "string",
|
|
10846
|
+
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
|
|
10847
|
+
},
|
|
10848
|
+
"starred_url": {
|
|
10849
|
+
"type": "string",
|
|
10850
|
+
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
|
|
10851
|
+
},
|
|
10852
|
+
"subscriptions_url": {
|
|
10853
|
+
"type": "string",
|
|
10854
|
+
"format": "uri",
|
|
10855
|
+
"example": "https://api.github.com/users/octocat/subscriptions"
|
|
10856
|
+
},
|
|
10857
|
+
"organizations_url": {
|
|
10858
|
+
"type": "string",
|
|
10859
|
+
"format": "uri",
|
|
10860
|
+
"example": "https://api.github.com/users/octocat/orgs"
|
|
10861
|
+
},
|
|
10862
|
+
"repos_url": {
|
|
10863
|
+
"type": "string",
|
|
10864
|
+
"format": "uri",
|
|
10865
|
+
"example": "https://api.github.com/users/octocat/repos"
|
|
10866
|
+
},
|
|
10867
|
+
"events_url": {
|
|
10868
|
+
"type": "string",
|
|
10869
|
+
"example": "https://api.github.com/users/octocat/events{/privacy}"
|
|
10870
|
+
},
|
|
10871
|
+
"received_events_url": {
|
|
10872
|
+
"type": "string",
|
|
10873
|
+
"format": "uri",
|
|
10874
|
+
"example": "https://api.github.com/users/octocat/received_events"
|
|
10875
|
+
},
|
|
10876
|
+
"type": { "type": "string", "example": "User" },
|
|
10877
|
+
"site_admin": { "type": "boolean" },
|
|
10878
|
+
"starred_at": {
|
|
10879
|
+
"type": "string",
|
|
10880
|
+
"example": "\"2020-07-09T00:17:55Z\""
|
|
10881
|
+
}
|
|
10882
|
+
},
|
|
10883
|
+
"required": [
|
|
10884
|
+
"avatar_url",
|
|
10885
|
+
"events_url",
|
|
10886
|
+
"followers_url",
|
|
10887
|
+
"following_url",
|
|
10888
|
+
"gists_url",
|
|
10889
|
+
"gravatar_id",
|
|
10890
|
+
"html_url",
|
|
10891
|
+
"id",
|
|
10892
|
+
"node_id",
|
|
10893
|
+
"login",
|
|
10894
|
+
"organizations_url",
|
|
10895
|
+
"received_events_url",
|
|
10896
|
+
"repos_url",
|
|
10897
|
+
"site_admin",
|
|
10898
|
+
"starred_url",
|
|
10899
|
+
"subscriptions_url",
|
|
10900
|
+
"type",
|
|
10901
|
+
"url"
|
|
10902
|
+
]
|
|
10903
|
+
},
|
|
10904
|
+
"assets": {
|
|
10905
|
+
"type": "array",
|
|
10906
|
+
"items": {
|
|
10907
|
+
"title": "Release Asset",
|
|
10908
|
+
"description": "Data related to a release.",
|
|
10909
|
+
"type": "object",
|
|
10910
|
+
"properties": {
|
|
10911
|
+
"url": { "type": "string", "format": "uri" },
|
|
10912
|
+
"browser_download_url": {
|
|
10913
|
+
"type": "string",
|
|
10914
|
+
"format": "uri"
|
|
10915
|
+
},
|
|
10916
|
+
"id": { "type": "integer" },
|
|
10917
|
+
"node_id": { "type": "string" },
|
|
10918
|
+
"name": {
|
|
10919
|
+
"description": "The file name of the asset.",
|
|
10920
|
+
"type": "string",
|
|
10921
|
+
"example": "Team Environment"
|
|
10922
|
+
},
|
|
10923
|
+
"label": { "type": "string", "nullable": true },
|
|
10924
|
+
"state": {
|
|
10925
|
+
"description": "State of the release asset.",
|
|
10926
|
+
"type": "string",
|
|
10927
|
+
"enum": ["uploaded", "open"]
|
|
10928
|
+
},
|
|
10929
|
+
"content_type": { "type": "string" },
|
|
10930
|
+
"size": { "type": "integer" },
|
|
10931
|
+
"download_count": { "type": "integer" },
|
|
10932
|
+
"created_at": {
|
|
10933
|
+
"type": "string",
|
|
10934
|
+
"format": "date-time"
|
|
10935
|
+
},
|
|
10936
|
+
"updated_at": {
|
|
10937
|
+
"type": "string",
|
|
10938
|
+
"format": "date-time"
|
|
10939
|
+
},
|
|
10940
|
+
"uploader": {
|
|
10941
|
+
"title": "Simple User",
|
|
10942
|
+
"description": "Simple User",
|
|
10943
|
+
"type": "object",
|
|
10944
|
+
"properties": {
|
|
10945
|
+
"name": { "nullable": true, "type": "string" },
|
|
10946
|
+
"email": { "nullable": true, "type": "string" },
|
|
10947
|
+
"login": {
|
|
10948
|
+
"type": "string",
|
|
10949
|
+
"example": "octocat"
|
|
10950
|
+
},
|
|
10951
|
+
"id": { "type": "integer", "example": 1 },
|
|
10952
|
+
"node_id": {
|
|
10953
|
+
"type": "string",
|
|
10954
|
+
"example": "MDQ6VXNlcjE="
|
|
10955
|
+
},
|
|
10956
|
+
"avatar_url": {
|
|
10957
|
+
"type": "string",
|
|
10958
|
+
"format": "uri",
|
|
10959
|
+
"example": "https://github.com/images/error/octocat_happy.gif"
|
|
10960
|
+
},
|
|
10961
|
+
"gravatar_id": {
|
|
10962
|
+
"type": "string",
|
|
10963
|
+
"example": "41d064eb2195891e12d0413f63227ea7",
|
|
10964
|
+
"nullable": true
|
|
10965
|
+
},
|
|
10966
|
+
"url": {
|
|
10967
|
+
"type": "string",
|
|
10968
|
+
"format": "uri",
|
|
10969
|
+
"example": "https://api.github.com/users/octocat"
|
|
10970
|
+
},
|
|
10971
|
+
"html_url": {
|
|
10972
|
+
"type": "string",
|
|
10973
|
+
"format": "uri",
|
|
10974
|
+
"example": "https://github.com/octocat"
|
|
10975
|
+
},
|
|
10976
|
+
"followers_url": {
|
|
10977
|
+
"type": "string",
|
|
10978
|
+
"format": "uri",
|
|
10979
|
+
"example": "https://api.github.com/users/octocat/followers"
|
|
10980
|
+
},
|
|
10981
|
+
"following_url": {
|
|
10982
|
+
"type": "string",
|
|
10983
|
+
"example": "https://api.github.com/users/octocat/following{/other_user}"
|
|
10984
|
+
},
|
|
10985
|
+
"gists_url": {
|
|
10986
|
+
"type": "string",
|
|
10987
|
+
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
|
|
10988
|
+
},
|
|
10989
|
+
"starred_url": {
|
|
10990
|
+
"type": "string",
|
|
10991
|
+
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
|
|
10992
|
+
},
|
|
10993
|
+
"subscriptions_url": {
|
|
10994
|
+
"type": "string",
|
|
10995
|
+
"format": "uri",
|
|
10996
|
+
"example": "https://api.github.com/users/octocat/subscriptions"
|
|
10997
|
+
},
|
|
10998
|
+
"organizations_url": {
|
|
10999
|
+
"type": "string",
|
|
11000
|
+
"format": "uri",
|
|
11001
|
+
"example": "https://api.github.com/users/octocat/orgs"
|
|
11002
|
+
},
|
|
11003
|
+
"repos_url": {
|
|
11004
|
+
"type": "string",
|
|
11005
|
+
"format": "uri",
|
|
11006
|
+
"example": "https://api.github.com/users/octocat/repos"
|
|
11007
|
+
},
|
|
11008
|
+
"events_url": {
|
|
11009
|
+
"type": "string",
|
|
11010
|
+
"example": "https://api.github.com/users/octocat/events{/privacy}"
|
|
11011
|
+
},
|
|
11012
|
+
"received_events_url": {
|
|
11013
|
+
"type": "string",
|
|
11014
|
+
"format": "uri",
|
|
11015
|
+
"example": "https://api.github.com/users/octocat/received_events"
|
|
11016
|
+
},
|
|
11017
|
+
"type": { "type": "string", "example": "User" },
|
|
11018
|
+
"site_admin": { "type": "boolean" },
|
|
11019
|
+
"starred_at": {
|
|
11020
|
+
"type": "string",
|
|
11021
|
+
"example": "\"2020-07-09T00:17:55Z\""
|
|
11022
|
+
}
|
|
11023
|
+
},
|
|
11024
|
+
"required": [
|
|
11025
|
+
"avatar_url",
|
|
11026
|
+
"events_url",
|
|
11027
|
+
"followers_url",
|
|
11028
|
+
"following_url",
|
|
11029
|
+
"gists_url",
|
|
11030
|
+
"gravatar_id",
|
|
11031
|
+
"html_url",
|
|
11032
|
+
"id",
|
|
11033
|
+
"node_id",
|
|
11034
|
+
"login",
|
|
11035
|
+
"organizations_url",
|
|
11036
|
+
"received_events_url",
|
|
11037
|
+
"repos_url",
|
|
11038
|
+
"site_admin",
|
|
11039
|
+
"starred_url",
|
|
11040
|
+
"subscriptions_url",
|
|
11041
|
+
"type",
|
|
11042
|
+
"url"
|
|
11043
|
+
],
|
|
11044
|
+
"nullable": true
|
|
11045
|
+
}
|
|
11046
|
+
},
|
|
11047
|
+
"required": [
|
|
11048
|
+
"id",
|
|
11049
|
+
"name",
|
|
11050
|
+
"content_type",
|
|
11051
|
+
"size",
|
|
11052
|
+
"state",
|
|
11053
|
+
"url",
|
|
11054
|
+
"node_id",
|
|
11055
|
+
"download_count",
|
|
11056
|
+
"label",
|
|
11057
|
+
"uploader",
|
|
11058
|
+
"browser_download_url",
|
|
11059
|
+
"created_at",
|
|
11060
|
+
"updated_at"
|
|
11061
|
+
]
|
|
11062
|
+
}
|
|
11063
|
+
},
|
|
11064
|
+
"body_html": { "type": "string" },
|
|
11065
|
+
"body_text": { "type": "string" },
|
|
11066
|
+
"mentions_count": { "type": "integer" },
|
|
11067
|
+
"reactions": {
|
|
11068
|
+
"title": "Reaction Rollup",
|
|
11069
|
+
"type": "object",
|
|
11070
|
+
"properties": {
|
|
11071
|
+
"url": { "type": "string", "format": "uri" },
|
|
11072
|
+
"total_count": { "type": "integer" },
|
|
11073
|
+
"+1": { "type": "integer" },
|
|
11074
|
+
"-1": { "type": "integer" },
|
|
11075
|
+
"laugh": { "type": "integer" },
|
|
11076
|
+
"confused": { "type": "integer" },
|
|
11077
|
+
"heart": { "type": "integer" },
|
|
11078
|
+
"hooray": { "type": "integer" },
|
|
11079
|
+
"eyes": { "type": "integer" },
|
|
11080
|
+
"rocket": { "type": "integer" }
|
|
11081
|
+
},
|
|
11082
|
+
"required": [
|
|
11083
|
+
"url",
|
|
11084
|
+
"total_count",
|
|
11085
|
+
"+1",
|
|
11086
|
+
"-1",
|
|
11087
|
+
"laugh",
|
|
11088
|
+
"confused",
|
|
11089
|
+
"heart",
|
|
11090
|
+
"hooray",
|
|
11091
|
+
"eyes",
|
|
11092
|
+
"rocket"
|
|
11093
|
+
]
|
|
11094
|
+
}
|
|
11095
|
+
},
|
|
11096
|
+
"required": [
|
|
11097
|
+
"assets_url",
|
|
11098
|
+
"upload_url",
|
|
11099
|
+
"tarball_url",
|
|
11100
|
+
"zipball_url",
|
|
11101
|
+
"created_at",
|
|
11102
|
+
"published_at",
|
|
11103
|
+
"draft",
|
|
11104
|
+
"id",
|
|
11105
|
+
"node_id",
|
|
11106
|
+
"author",
|
|
11107
|
+
"html_url",
|
|
11108
|
+
"name",
|
|
11109
|
+
"prerelease",
|
|
11110
|
+
"tag_name",
|
|
11111
|
+
"target_commitish",
|
|
11112
|
+
"assets",
|
|
11113
|
+
"url"
|
|
11114
|
+
]
|
|
11115
|
+
},
|
|
11116
|
+
"examples": {
|
|
11117
|
+
"default": {
|
|
11118
|
+
"value": {
|
|
11119
|
+
"url": "https://api.github.com/repos/octocat/Hello-World/releases/1",
|
|
11120
|
+
"html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0",
|
|
11121
|
+
"assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets",
|
|
11122
|
+
"upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}",
|
|
11123
|
+
"tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0",
|
|
11124
|
+
"zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0",
|
|
11125
|
+
"discussion_url": "https://github.com/octocat/Hello-World/discussions/90",
|
|
11126
|
+
"id": 1,
|
|
11127
|
+
"node_id": "MDc6UmVsZWFzZTE=",
|
|
11128
|
+
"tag_name": "v1.0.0",
|
|
11129
|
+
"target_commitish": "master",
|
|
11130
|
+
"name": "v1.0.0",
|
|
11131
|
+
"body": "Description of the release",
|
|
11132
|
+
"draft": false,
|
|
11133
|
+
"prerelease": false,
|
|
11134
|
+
"created_at": "2013-02-27T19:35:32Z",
|
|
11135
|
+
"published_at": "2013-02-27T19:35:32Z",
|
|
11136
|
+
"author": {
|
|
11137
|
+
"login": "octocat",
|
|
11138
|
+
"id": 1,
|
|
11139
|
+
"node_id": "MDQ6VXNlcjE=",
|
|
11140
|
+
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
|
|
11141
|
+
"gravatar_id": "",
|
|
11142
|
+
"url": "https://api.github.com/users/octocat",
|
|
11143
|
+
"html_url": "https://github.com/octocat",
|
|
11144
|
+
"followers_url": "https://api.github.com/users/octocat/followers",
|
|
11145
|
+
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
|
|
11146
|
+
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
|
|
11147
|
+
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
|
|
11148
|
+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
|
|
11149
|
+
"organizations_url": "https://api.github.com/users/octocat/orgs",
|
|
11150
|
+
"repos_url": "https://api.github.com/users/octocat/repos",
|
|
11151
|
+
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
|
|
11152
|
+
"received_events_url": "https://api.github.com/users/octocat/received_events",
|
|
11153
|
+
"type": "User",
|
|
11154
|
+
"site_admin": false
|
|
11155
|
+
},
|
|
11156
|
+
"assets": [
|
|
11157
|
+
{
|
|
11158
|
+
"url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1",
|
|
11159
|
+
"browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip",
|
|
11160
|
+
"id": 1,
|
|
11161
|
+
"node_id": "MDEyOlJlbGVhc2VBc3NldDE=",
|
|
11162
|
+
"name": "example.zip",
|
|
11163
|
+
"label": "short description",
|
|
11164
|
+
"state": "uploaded",
|
|
11165
|
+
"content_type": "application/zip",
|
|
11166
|
+
"size": 1024,
|
|
11167
|
+
"download_count": 42,
|
|
11168
|
+
"created_at": "2013-02-27T19:35:32Z",
|
|
11169
|
+
"updated_at": "2013-02-27T19:35:32Z",
|
|
11170
|
+
"uploader": {
|
|
11171
|
+
"login": "octocat",
|
|
11172
|
+
"id": 1,
|
|
11173
|
+
"node_id": "MDQ6VXNlcjE=",
|
|
11174
|
+
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
|
|
11175
|
+
"gravatar_id": "",
|
|
11176
|
+
"url": "https://api.github.com/users/octocat",
|
|
11177
|
+
"html_url": "https://github.com/octocat",
|
|
11178
|
+
"followers_url": "https://api.github.com/users/octocat/followers",
|
|
11179
|
+
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
|
|
11180
|
+
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
|
|
11181
|
+
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
|
|
11182
|
+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
|
|
11183
|
+
"organizations_url": "https://api.github.com/users/octocat/orgs",
|
|
11184
|
+
"repos_url": "https://api.github.com/users/octocat/repos",
|
|
11185
|
+
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
|
|
11186
|
+
"received_events_url": "https://api.github.com/users/octocat/received_events",
|
|
11187
|
+
"type": "User",
|
|
11188
|
+
"site_admin": false
|
|
11189
|
+
}
|
|
11190
|
+
}
|
|
11191
|
+
]
|
|
11192
|
+
}
|
|
11193
|
+
}
|
|
11194
|
+
}
|
|
11195
|
+
}
|
|
11196
|
+
},
|
|
11197
|
+
"headers": {
|
|
11198
|
+
"Location": {
|
|
11199
|
+
"example": "https://api.github.com/repos/octocat/Hello-World/releases/1",
|
|
11200
|
+
"schema": { "type": "string" }
|
|
11201
|
+
}
|
|
11202
|
+
}
|
|
11203
|
+
},
|
|
11204
|
+
"422": {
|
|
11205
|
+
"description": "Validation failed",
|
|
11206
|
+
"content": {
|
|
11207
|
+
"application/json": {
|
|
11208
|
+
"schema": {
|
|
11209
|
+
"title": "Validation Error",
|
|
11210
|
+
"description": "Validation Error",
|
|
11211
|
+
"type": "object",
|
|
11212
|
+
"required": ["message", "documentation_url"],
|
|
11213
|
+
"properties": {
|
|
11214
|
+
"message": { "type": "string" },
|
|
11215
|
+
"documentation_url": { "type": "string" },
|
|
11216
|
+
"errors": {
|
|
11217
|
+
"type": "array",
|
|
11218
|
+
"items": {
|
|
11219
|
+
"type": "object",
|
|
11220
|
+
"required": ["code"],
|
|
11221
|
+
"properties": {
|
|
11222
|
+
"resource": { "type": "string" },
|
|
11223
|
+
"field": { "type": "string" },
|
|
11224
|
+
"message": { "type": "string" },
|
|
11225
|
+
"code": { "type": "string" },
|
|
11226
|
+
"index": { "type": "integer" },
|
|
11227
|
+
"value": {
|
|
11228
|
+
"oneOf": [
|
|
11229
|
+
{ "type": "string", "nullable": true },
|
|
11230
|
+
{ "type": "integer", "nullable": true },
|
|
11231
|
+
{
|
|
11232
|
+
"type": "array",
|
|
11233
|
+
"nullable": true,
|
|
11234
|
+
"items": { "type": "string" }
|
|
11235
|
+
}
|
|
11236
|
+
]
|
|
11237
|
+
}
|
|
11238
|
+
}
|
|
11239
|
+
}
|
|
11240
|
+
}
|
|
11241
|
+
}
|
|
11242
|
+
}
|
|
11243
|
+
}
|
|
11244
|
+
}
|
|
11245
|
+
}
|
|
11246
|
+
},
|
|
11247
|
+
"x-github": {
|
|
11248
|
+
"triggersNotification": true,
|
|
11249
|
+
"githubCloudOnly": false,
|
|
11250
|
+
"enabledForGitHubApps": true,
|
|
11251
|
+
"previews": [],
|
|
11252
|
+
"category": "repos",
|
|
11253
|
+
"subcategory": "releases"
|
|
11254
|
+
},
|
|
11255
|
+
"x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
|
|
11256
|
+
}
|
|
11257
|
+
},
|
|
11258
|
+
"/repos/{owner}/{repo}/releases/latest": {
|
|
11259
|
+
"get": {
|
|
11260
|
+
"summary": "Get the latest release",
|
|
11261
|
+
"description": "View the latest published full release for the repository.\n\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published.",
|
|
11262
|
+
"tags": ["repos"],
|
|
11263
|
+
"operationId": "repos/get-latest-release",
|
|
11264
|
+
"externalDocs": {
|
|
11265
|
+
"description": "API method documentation",
|
|
11266
|
+
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-the-latest-release"
|
|
11267
|
+
},
|
|
11268
|
+
"parameters": [
|
|
11269
|
+
{
|
|
11270
|
+
"name": "owner",
|
|
11271
|
+
"in": "path",
|
|
11272
|
+
"required": true,
|
|
11273
|
+
"schema": { "type": "string" }
|
|
11274
|
+
},
|
|
11275
|
+
{
|
|
11276
|
+
"name": "repo",
|
|
11277
|
+
"in": "path",
|
|
11278
|
+
"required": true,
|
|
11279
|
+
"schema": { "type": "string" }
|
|
11280
|
+
}
|
|
11281
|
+
],
|
|
11282
|
+
"responses": {
|
|
11283
|
+
"200": {
|
|
11284
|
+
"description": "Response",
|
|
11285
|
+
"content": {
|
|
11286
|
+
"application/json": {
|
|
11287
|
+
"schema": {
|
|
11288
|
+
"title": "Release",
|
|
11289
|
+
"description": "A release.",
|
|
11290
|
+
"type": "object",
|
|
11291
|
+
"properties": {
|
|
11292
|
+
"url": { "type": "string", "format": "uri" },
|
|
11293
|
+
"html_url": { "type": "string", "format": "uri" },
|
|
11294
|
+
"assets_url": { "type": "string", "format": "uri" },
|
|
11295
|
+
"upload_url": { "type": "string" },
|
|
11296
|
+
"tarball_url": {
|
|
11297
|
+
"type": "string",
|
|
11298
|
+
"format": "uri",
|
|
11299
|
+
"nullable": true
|
|
11300
|
+
},
|
|
11301
|
+
"zipball_url": {
|
|
11302
|
+
"type": "string",
|
|
11303
|
+
"format": "uri",
|
|
11304
|
+
"nullable": true
|
|
11305
|
+
},
|
|
11306
|
+
"id": { "type": "integer" },
|
|
11307
|
+
"node_id": { "type": "string" },
|
|
11308
|
+
"tag_name": {
|
|
11309
|
+
"description": "The name of the tag.",
|
|
11310
|
+
"example": "v1.0.0",
|
|
11311
|
+
"type": "string"
|
|
11312
|
+
},
|
|
11313
|
+
"target_commitish": {
|
|
11314
|
+
"description": "Specifies the commitish value that determines where the Git tag is created from.",
|
|
11315
|
+
"example": "master",
|
|
11316
|
+
"type": "string"
|
|
11317
|
+
},
|
|
11318
|
+
"name": { "type": "string", "nullable": true },
|
|
11319
|
+
"body": { "type": "string", "nullable": true },
|
|
11320
|
+
"draft": {
|
|
11321
|
+
"description": "true to create a draft (unpublished) release, false to create a published one.",
|
|
11322
|
+
"example": false,
|
|
11323
|
+
"type": "boolean"
|
|
11324
|
+
},
|
|
11325
|
+
"prerelease": {
|
|
11326
|
+
"description": "Whether to identify the release as a prerelease or a full release.",
|
|
11327
|
+
"example": false,
|
|
11328
|
+
"type": "boolean"
|
|
11329
|
+
},
|
|
11330
|
+
"created_at": { "type": "string", "format": "date-time" },
|
|
11331
|
+
"published_at": {
|
|
11332
|
+
"type": "string",
|
|
11333
|
+
"format": "date-time",
|
|
11334
|
+
"nullable": true
|
|
11335
|
+
},
|
|
11336
|
+
"author": {
|
|
11337
|
+
"title": "Simple User",
|
|
11338
|
+
"description": "Simple User",
|
|
11339
|
+
"type": "object",
|
|
11340
|
+
"properties": {
|
|
11341
|
+
"name": { "nullable": true, "type": "string" },
|
|
11342
|
+
"email": { "nullable": true, "type": "string" },
|
|
11343
|
+
"login": { "type": "string", "example": "octocat" },
|
|
11344
|
+
"id": { "type": "integer", "example": 1 },
|
|
11345
|
+
"node_id": {
|
|
11346
|
+
"type": "string",
|
|
11347
|
+
"example": "MDQ6VXNlcjE="
|
|
11348
|
+
},
|
|
11349
|
+
"avatar_url": {
|
|
11350
|
+
"type": "string",
|
|
11351
|
+
"format": "uri",
|
|
11352
|
+
"example": "https://github.com/images/error/octocat_happy.gif"
|
|
11353
|
+
},
|
|
11354
|
+
"gravatar_id": {
|
|
11355
|
+
"type": "string",
|
|
11356
|
+
"example": "41d064eb2195891e12d0413f63227ea7",
|
|
11357
|
+
"nullable": true
|
|
11358
|
+
},
|
|
11359
|
+
"url": {
|
|
11360
|
+
"type": "string",
|
|
11361
|
+
"format": "uri",
|
|
11362
|
+
"example": "https://api.github.com/users/octocat"
|
|
11363
|
+
},
|
|
11364
|
+
"html_url": {
|
|
11365
|
+
"type": "string",
|
|
11366
|
+
"format": "uri",
|
|
11367
|
+
"example": "https://github.com/octocat"
|
|
11368
|
+
},
|
|
11369
|
+
"followers_url": {
|
|
11370
|
+
"type": "string",
|
|
11371
|
+
"format": "uri",
|
|
11372
|
+
"example": "https://api.github.com/users/octocat/followers"
|
|
11373
|
+
},
|
|
11374
|
+
"following_url": {
|
|
11375
|
+
"type": "string",
|
|
11376
|
+
"example": "https://api.github.com/users/octocat/following{/other_user}"
|
|
11377
|
+
},
|
|
11378
|
+
"gists_url": {
|
|
11379
|
+
"type": "string",
|
|
11380
|
+
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
|
|
11381
|
+
},
|
|
11382
|
+
"starred_url": {
|
|
11383
|
+
"type": "string",
|
|
11384
|
+
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
|
|
11385
|
+
},
|
|
11386
|
+
"subscriptions_url": {
|
|
11387
|
+
"type": "string",
|
|
11388
|
+
"format": "uri",
|
|
11389
|
+
"example": "https://api.github.com/users/octocat/subscriptions"
|
|
11390
|
+
},
|
|
11391
|
+
"organizations_url": {
|
|
11392
|
+
"type": "string",
|
|
11393
|
+
"format": "uri",
|
|
11394
|
+
"example": "https://api.github.com/users/octocat/orgs"
|
|
11395
|
+
},
|
|
11396
|
+
"repos_url": {
|
|
11397
|
+
"type": "string",
|
|
11398
|
+
"format": "uri",
|
|
11399
|
+
"example": "https://api.github.com/users/octocat/repos"
|
|
11400
|
+
},
|
|
11401
|
+
"events_url": {
|
|
11402
|
+
"type": "string",
|
|
11403
|
+
"example": "https://api.github.com/users/octocat/events{/privacy}"
|
|
11404
|
+
},
|
|
11405
|
+
"received_events_url": {
|
|
11406
|
+
"type": "string",
|
|
11407
|
+
"format": "uri",
|
|
11408
|
+
"example": "https://api.github.com/users/octocat/received_events"
|
|
11409
|
+
},
|
|
11410
|
+
"type": { "type": "string", "example": "User" },
|
|
11411
|
+
"site_admin": { "type": "boolean" },
|
|
11412
|
+
"starred_at": {
|
|
11413
|
+
"type": "string",
|
|
11414
|
+
"example": "\"2020-07-09T00:17:55Z\""
|
|
11415
|
+
}
|
|
11416
|
+
},
|
|
11417
|
+
"required": [
|
|
11418
|
+
"avatar_url",
|
|
11419
|
+
"events_url",
|
|
11420
|
+
"followers_url",
|
|
11421
|
+
"following_url",
|
|
11422
|
+
"gists_url",
|
|
11423
|
+
"gravatar_id",
|
|
11424
|
+
"html_url",
|
|
11425
|
+
"id",
|
|
11426
|
+
"node_id",
|
|
11427
|
+
"login",
|
|
11428
|
+
"organizations_url",
|
|
11429
|
+
"received_events_url",
|
|
11430
|
+
"repos_url",
|
|
11431
|
+
"site_admin",
|
|
11432
|
+
"starred_url",
|
|
11433
|
+
"subscriptions_url",
|
|
11434
|
+
"type",
|
|
11435
|
+
"url"
|
|
11436
|
+
]
|
|
11437
|
+
},
|
|
11438
|
+
"assets": {
|
|
11439
|
+
"type": "array",
|
|
11440
|
+
"items": {
|
|
11441
|
+
"title": "Release Asset",
|
|
11442
|
+
"description": "Data related to a release.",
|
|
11443
|
+
"type": "object",
|
|
11444
|
+
"properties": {
|
|
11445
|
+
"url": { "type": "string", "format": "uri" },
|
|
11446
|
+
"browser_download_url": {
|
|
11447
|
+
"type": "string",
|
|
11448
|
+
"format": "uri"
|
|
11449
|
+
},
|
|
11450
|
+
"id": { "type": "integer" },
|
|
11451
|
+
"node_id": { "type": "string" },
|
|
11452
|
+
"name": {
|
|
11453
|
+
"description": "The file name of the asset.",
|
|
11454
|
+
"type": "string",
|
|
11455
|
+
"example": "Team Environment"
|
|
11456
|
+
},
|
|
11457
|
+
"label": { "type": "string", "nullable": true },
|
|
11458
|
+
"state": {
|
|
11459
|
+
"description": "State of the release asset.",
|
|
11460
|
+
"type": "string",
|
|
11461
|
+
"enum": ["uploaded", "open"]
|
|
11462
|
+
},
|
|
11463
|
+
"content_type": { "type": "string" },
|
|
11464
|
+
"size": { "type": "integer" },
|
|
11465
|
+
"download_count": { "type": "integer" },
|
|
11466
|
+
"created_at": {
|
|
11467
|
+
"type": "string",
|
|
11468
|
+
"format": "date-time"
|
|
11469
|
+
},
|
|
11470
|
+
"updated_at": {
|
|
11471
|
+
"type": "string",
|
|
11472
|
+
"format": "date-time"
|
|
11473
|
+
},
|
|
11474
|
+
"uploader": {
|
|
11475
|
+
"title": "Simple User",
|
|
11476
|
+
"description": "Simple User",
|
|
11477
|
+
"type": "object",
|
|
11478
|
+
"properties": {
|
|
11479
|
+
"name": { "nullable": true, "type": "string" },
|
|
11480
|
+
"email": { "nullable": true, "type": "string" },
|
|
11481
|
+
"login": {
|
|
11482
|
+
"type": "string",
|
|
11483
|
+
"example": "octocat"
|
|
11484
|
+
},
|
|
11485
|
+
"id": { "type": "integer", "example": 1 },
|
|
11486
|
+
"node_id": {
|
|
11487
|
+
"type": "string",
|
|
11488
|
+
"example": "MDQ6VXNlcjE="
|
|
11489
|
+
},
|
|
11490
|
+
"avatar_url": {
|
|
11491
|
+
"type": "string",
|
|
11492
|
+
"format": "uri",
|
|
11493
|
+
"example": "https://github.com/images/error/octocat_happy.gif"
|
|
11494
|
+
},
|
|
11495
|
+
"gravatar_id": {
|
|
11496
|
+
"type": "string",
|
|
11497
|
+
"example": "41d064eb2195891e12d0413f63227ea7",
|
|
11498
|
+
"nullable": true
|
|
11499
|
+
},
|
|
11500
|
+
"url": {
|
|
11501
|
+
"type": "string",
|
|
11502
|
+
"format": "uri",
|
|
11503
|
+
"example": "https://api.github.com/users/octocat"
|
|
11504
|
+
},
|
|
11505
|
+
"html_url": {
|
|
11506
|
+
"type": "string",
|
|
11507
|
+
"format": "uri",
|
|
11508
|
+
"example": "https://github.com/octocat"
|
|
11509
|
+
},
|
|
11510
|
+
"followers_url": {
|
|
11511
|
+
"type": "string",
|
|
11512
|
+
"format": "uri",
|
|
11513
|
+
"example": "https://api.github.com/users/octocat/followers"
|
|
11514
|
+
},
|
|
11515
|
+
"following_url": {
|
|
11516
|
+
"type": "string",
|
|
11517
|
+
"example": "https://api.github.com/users/octocat/following{/other_user}"
|
|
11518
|
+
},
|
|
11519
|
+
"gists_url": {
|
|
11520
|
+
"type": "string",
|
|
11521
|
+
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
|
|
11522
|
+
},
|
|
11523
|
+
"starred_url": {
|
|
11524
|
+
"type": "string",
|
|
11525
|
+
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
|
|
11526
|
+
},
|
|
11527
|
+
"subscriptions_url": {
|
|
11528
|
+
"type": "string",
|
|
11529
|
+
"format": "uri",
|
|
11530
|
+
"example": "https://api.github.com/users/octocat/subscriptions"
|
|
11531
|
+
},
|
|
11532
|
+
"organizations_url": {
|
|
11533
|
+
"type": "string",
|
|
11534
|
+
"format": "uri",
|
|
11535
|
+
"example": "https://api.github.com/users/octocat/orgs"
|
|
11536
|
+
},
|
|
11537
|
+
"repos_url": {
|
|
11538
|
+
"type": "string",
|
|
11539
|
+
"format": "uri",
|
|
11540
|
+
"example": "https://api.github.com/users/octocat/repos"
|
|
11541
|
+
},
|
|
11542
|
+
"events_url": {
|
|
11543
|
+
"type": "string",
|
|
11544
|
+
"example": "https://api.github.com/users/octocat/events{/privacy}"
|
|
11545
|
+
},
|
|
11546
|
+
"received_events_url": {
|
|
11547
|
+
"type": "string",
|
|
11548
|
+
"format": "uri",
|
|
11549
|
+
"example": "https://api.github.com/users/octocat/received_events"
|
|
11550
|
+
},
|
|
11551
|
+
"type": { "type": "string", "example": "User" },
|
|
11552
|
+
"site_admin": { "type": "boolean" },
|
|
11553
|
+
"starred_at": {
|
|
11554
|
+
"type": "string",
|
|
11555
|
+
"example": "\"2020-07-09T00:17:55Z\""
|
|
11556
|
+
}
|
|
11557
|
+
},
|
|
11558
|
+
"required": [
|
|
11559
|
+
"avatar_url",
|
|
11560
|
+
"events_url",
|
|
11561
|
+
"followers_url",
|
|
11562
|
+
"following_url",
|
|
11563
|
+
"gists_url",
|
|
11564
|
+
"gravatar_id",
|
|
11565
|
+
"html_url",
|
|
11566
|
+
"id",
|
|
11567
|
+
"node_id",
|
|
11568
|
+
"login",
|
|
11569
|
+
"organizations_url",
|
|
11570
|
+
"received_events_url",
|
|
11571
|
+
"repos_url",
|
|
11572
|
+
"site_admin",
|
|
11573
|
+
"starred_url",
|
|
11574
|
+
"subscriptions_url",
|
|
11575
|
+
"type",
|
|
11576
|
+
"url"
|
|
11577
|
+
],
|
|
11578
|
+
"nullable": true
|
|
11579
|
+
}
|
|
11580
|
+
},
|
|
11581
|
+
"required": [
|
|
11582
|
+
"id",
|
|
11583
|
+
"name",
|
|
11584
|
+
"content_type",
|
|
11585
|
+
"size",
|
|
11586
|
+
"state",
|
|
11587
|
+
"url",
|
|
11588
|
+
"node_id",
|
|
11589
|
+
"download_count",
|
|
11590
|
+
"label",
|
|
11591
|
+
"uploader",
|
|
11592
|
+
"browser_download_url",
|
|
11593
|
+
"created_at",
|
|
11594
|
+
"updated_at"
|
|
11595
|
+
]
|
|
11596
|
+
}
|
|
11597
|
+
},
|
|
11598
|
+
"body_html": { "type": "string" },
|
|
11599
|
+
"body_text": { "type": "string" },
|
|
11600
|
+
"mentions_count": { "type": "integer" },
|
|
11601
|
+
"reactions": {
|
|
11602
|
+
"title": "Reaction Rollup",
|
|
11603
|
+
"type": "object",
|
|
11604
|
+
"properties": {
|
|
11605
|
+
"url": { "type": "string", "format": "uri" },
|
|
11606
|
+
"total_count": { "type": "integer" },
|
|
11607
|
+
"+1": { "type": "integer" },
|
|
11608
|
+
"-1": { "type": "integer" },
|
|
11609
|
+
"laugh": { "type": "integer" },
|
|
11610
|
+
"confused": { "type": "integer" },
|
|
11611
|
+
"heart": { "type": "integer" },
|
|
11612
|
+
"hooray": { "type": "integer" },
|
|
11613
|
+
"eyes": { "type": "integer" },
|
|
11614
|
+
"rocket": { "type": "integer" }
|
|
11615
|
+
},
|
|
11616
|
+
"required": [
|
|
11617
|
+
"url",
|
|
11618
|
+
"total_count",
|
|
11619
|
+
"+1",
|
|
11620
|
+
"-1",
|
|
11621
|
+
"laugh",
|
|
11622
|
+
"confused",
|
|
11623
|
+
"heart",
|
|
11624
|
+
"hooray",
|
|
11625
|
+
"eyes",
|
|
11626
|
+
"rocket"
|
|
11627
|
+
]
|
|
11628
|
+
}
|
|
11629
|
+
},
|
|
11630
|
+
"required": [
|
|
11631
|
+
"assets_url",
|
|
11632
|
+
"upload_url",
|
|
11633
|
+
"tarball_url",
|
|
11634
|
+
"zipball_url",
|
|
11635
|
+
"created_at",
|
|
11636
|
+
"published_at",
|
|
11637
|
+
"draft",
|
|
11638
|
+
"id",
|
|
11639
|
+
"node_id",
|
|
11640
|
+
"author",
|
|
11641
|
+
"html_url",
|
|
11642
|
+
"name",
|
|
11643
|
+
"prerelease",
|
|
11644
|
+
"tag_name",
|
|
11645
|
+
"target_commitish",
|
|
11646
|
+
"assets",
|
|
11647
|
+
"url"
|
|
11648
|
+
]
|
|
11649
|
+
},
|
|
11650
|
+
"examples": {
|
|
11651
|
+
"default": {
|
|
11652
|
+
"value": {
|
|
11653
|
+
"url": "https://api.github.com/repos/octocat/Hello-World/releases/1",
|
|
11654
|
+
"html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0",
|
|
11655
|
+
"assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets",
|
|
11656
|
+
"upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}",
|
|
11657
|
+
"tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0",
|
|
11658
|
+
"zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0",
|
|
11659
|
+
"discussion_url": "https://github.com/octocat/Hello-World/discussions/90",
|
|
11660
|
+
"id": 1,
|
|
11661
|
+
"node_id": "MDc6UmVsZWFzZTE=",
|
|
11662
|
+
"tag_name": "v1.0.0",
|
|
11663
|
+
"target_commitish": "master",
|
|
11664
|
+
"name": "v1.0.0",
|
|
11665
|
+
"body": "Description of the release",
|
|
11666
|
+
"draft": false,
|
|
11667
|
+
"prerelease": false,
|
|
11668
|
+
"created_at": "2013-02-27T19:35:32Z",
|
|
11669
|
+
"published_at": "2013-02-27T19:35:32Z",
|
|
11670
|
+
"author": {
|
|
11671
|
+
"login": "octocat",
|
|
11672
|
+
"id": 1,
|
|
11673
|
+
"node_id": "MDQ6VXNlcjE=",
|
|
11674
|
+
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
|
|
11675
|
+
"gravatar_id": "",
|
|
11676
|
+
"url": "https://api.github.com/users/octocat",
|
|
11677
|
+
"html_url": "https://github.com/octocat",
|
|
11678
|
+
"followers_url": "https://api.github.com/users/octocat/followers",
|
|
11679
|
+
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
|
|
11680
|
+
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
|
|
11681
|
+
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
|
|
11682
|
+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
|
|
11683
|
+
"organizations_url": "https://api.github.com/users/octocat/orgs",
|
|
11684
|
+
"repos_url": "https://api.github.com/users/octocat/repos",
|
|
11685
|
+
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
|
|
11686
|
+
"received_events_url": "https://api.github.com/users/octocat/received_events",
|
|
11687
|
+
"type": "User",
|
|
11688
|
+
"site_admin": false
|
|
11689
|
+
},
|
|
11690
|
+
"assets": [
|
|
11691
|
+
{
|
|
11692
|
+
"url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1",
|
|
11693
|
+
"browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip",
|
|
9427
11694
|
"id": 1,
|
|
9428
|
-
"node_id": "
|
|
9429
|
-
"
|
|
9430
|
-
"
|
|
9431
|
-
"
|
|
9432
|
-
"
|
|
9433
|
-
"
|
|
9434
|
-
"
|
|
9435
|
-
"
|
|
9436
|
-
"
|
|
9437
|
-
"
|
|
9438
|
-
|
|
9439
|
-
"repos_url": "https://api.github.com/users/octocat/repos",
|
|
9440
|
-
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
|
|
9441
|
-
"received_events_url": "https://api.github.com/users/octocat/received_events",
|
|
9442
|
-
"type": "User",
|
|
9443
|
-
"site_admin": false
|
|
9444
|
-
},
|
|
9445
|
-
"assets": [
|
|
9446
|
-
{
|
|
9447
|
-
"url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1",
|
|
9448
|
-
"browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip",
|
|
11695
|
+
"node_id": "MDEyOlJlbGVhc2VBc3NldDE=",
|
|
11696
|
+
"name": "example.zip",
|
|
11697
|
+
"label": "short description",
|
|
11698
|
+
"state": "uploaded",
|
|
11699
|
+
"content_type": "application/zip",
|
|
11700
|
+
"size": 1024,
|
|
11701
|
+
"download_count": 42,
|
|
11702
|
+
"created_at": "2013-02-27T19:35:32Z",
|
|
11703
|
+
"updated_at": "2013-02-27T19:35:32Z",
|
|
11704
|
+
"uploader": {
|
|
11705
|
+
"login": "octocat",
|
|
9449
11706
|
"id": 1,
|
|
9450
|
-
"node_id": "
|
|
9451
|
-
"
|
|
9452
|
-
"
|
|
9453
|
-
"
|
|
9454
|
-
"
|
|
9455
|
-
"
|
|
9456
|
-
"
|
|
9457
|
-
"
|
|
9458
|
-
"
|
|
9459
|
-
"
|
|
9460
|
-
|
|
9461
|
-
|
|
9462
|
-
|
|
9463
|
-
|
|
9464
|
-
|
|
9465
|
-
|
|
9466
|
-
"html_url": "https://github.com/octocat",
|
|
9467
|
-
"followers_url": "https://api.github.com/users/octocat/followers",
|
|
9468
|
-
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
|
|
9469
|
-
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
|
|
9470
|
-
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
|
|
9471
|
-
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
|
|
9472
|
-
"organizations_url": "https://api.github.com/users/octocat/orgs",
|
|
9473
|
-
"repos_url": "https://api.github.com/users/octocat/repos",
|
|
9474
|
-
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
|
|
9475
|
-
"received_events_url": "https://api.github.com/users/octocat/received_events",
|
|
9476
|
-
"type": "User",
|
|
9477
|
-
"site_admin": false
|
|
9478
|
-
}
|
|
11707
|
+
"node_id": "MDQ6VXNlcjE=",
|
|
11708
|
+
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
|
|
11709
|
+
"gravatar_id": "",
|
|
11710
|
+
"url": "https://api.github.com/users/octocat",
|
|
11711
|
+
"html_url": "https://github.com/octocat",
|
|
11712
|
+
"followers_url": "https://api.github.com/users/octocat/followers",
|
|
11713
|
+
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
|
|
11714
|
+
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
|
|
11715
|
+
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
|
|
11716
|
+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
|
|
11717
|
+
"organizations_url": "https://api.github.com/users/octocat/orgs",
|
|
11718
|
+
"repos_url": "https://api.github.com/users/octocat/repos",
|
|
11719
|
+
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
|
|
11720
|
+
"received_events_url": "https://api.github.com/users/octocat/received_events",
|
|
11721
|
+
"type": "User",
|
|
11722
|
+
"site_admin": false
|
|
9479
11723
|
}
|
|
9480
|
-
|
|
9481
|
-
|
|
9482
|
-
|
|
9483
|
-
}
|
|
9484
|
-
}
|
|
9485
|
-
}
|
|
9486
|
-
},
|
|
9487
|
-
"headers": {
|
|
9488
|
-
"Link": {
|
|
9489
|
-
"example": "<https://api.github.com/resource?page=2>; rel=\"next\", <https://api.github.com/resource?page=5>; rel=\"last\"",
|
|
9490
|
-
"schema": { "type": "string" }
|
|
9491
|
-
}
|
|
9492
|
-
}
|
|
9493
|
-
},
|
|
9494
|
-
"404": {
|
|
9495
|
-
"description": "Resource not found",
|
|
9496
|
-
"content": {
|
|
9497
|
-
"application/json": {
|
|
9498
|
-
"schema": {
|
|
9499
|
-
"title": "Basic Error",
|
|
9500
|
-
"description": "Basic Error",
|
|
9501
|
-
"type": "object",
|
|
9502
|
-
"properties": {
|
|
9503
|
-
"message": { "type": "string" },
|
|
9504
|
-
"documentation_url": { "type": "string" },
|
|
9505
|
-
"url": { "type": "string" },
|
|
9506
|
-
"status": { "type": "string" }
|
|
11724
|
+
}
|
|
11725
|
+
]
|
|
11726
|
+
}
|
|
9507
11727
|
}
|
|
9508
11728
|
}
|
|
9509
11729
|
}
|
|
@@ -9520,15 +11740,15 @@
|
|
|
9520
11740
|
"x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
|
|
9521
11741
|
}
|
|
9522
11742
|
},
|
|
9523
|
-
"/repos/{owner}/{repo}/releases/
|
|
11743
|
+
"/repos/{owner}/{repo}/releases/tags/{tag}": {
|
|
9524
11744
|
"get": {
|
|
9525
|
-
"summary": "Get
|
|
9526
|
-
"description": "
|
|
11745
|
+
"summary": "Get a release by tag name",
|
|
11746
|
+
"description": "Get a published release with the specified tag.",
|
|
9527
11747
|
"tags": ["repos"],
|
|
9528
|
-
"operationId": "repos/get-
|
|
11748
|
+
"operationId": "repos/get-release-by-tag",
|
|
9529
11749
|
"externalDocs": {
|
|
9530
11750
|
"description": "API method documentation",
|
|
9531
|
-
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-
|
|
11751
|
+
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-a-release-by-tag-name"
|
|
9532
11752
|
},
|
|
9533
11753
|
"parameters": [
|
|
9534
11754
|
{
|
|
@@ -9542,6 +11762,14 @@
|
|
|
9542
11762
|
"in": "path",
|
|
9543
11763
|
"required": true,
|
|
9544
11764
|
"schema": { "type": "string" }
|
|
11765
|
+
},
|
|
11766
|
+
{
|
|
11767
|
+
"name": "tag",
|
|
11768
|
+
"description": "tag parameter",
|
|
11769
|
+
"in": "path",
|
|
11770
|
+
"required": true,
|
|
11771
|
+
"schema": { "type": "string" },
|
|
11772
|
+
"x-multi-segment": true
|
|
9545
11773
|
}
|
|
9546
11774
|
],
|
|
9547
11775
|
"responses": {
|
|
@@ -9993,6 +12221,24 @@
|
|
|
9993
12221
|
}
|
|
9994
12222
|
}
|
|
9995
12223
|
}
|
|
12224
|
+
},
|
|
12225
|
+
"404": {
|
|
12226
|
+
"description": "Resource not found",
|
|
12227
|
+
"content": {
|
|
12228
|
+
"application/json": {
|
|
12229
|
+
"schema": {
|
|
12230
|
+
"title": "Basic Error",
|
|
12231
|
+
"description": "Basic Error",
|
|
12232
|
+
"type": "object",
|
|
12233
|
+
"properties": {
|
|
12234
|
+
"message": { "type": "string" },
|
|
12235
|
+
"documentation_url": { "type": "string" },
|
|
12236
|
+
"url": { "type": "string" },
|
|
12237
|
+
"status": { "type": "string" }
|
|
12238
|
+
}
|
|
12239
|
+
}
|
|
12240
|
+
}
|
|
12241
|
+
}
|
|
9996
12242
|
}
|
|
9997
12243
|
},
|
|
9998
12244
|
"x-github": {
|
|
@@ -10005,15 +12251,15 @@
|
|
|
10005
12251
|
"x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
|
|
10006
12252
|
}
|
|
10007
12253
|
},
|
|
10008
|
-
"/repos/{owner}/{repo}/releases/
|
|
12254
|
+
"/repos/{owner}/{repo}/releases/{release_id}": {
|
|
10009
12255
|
"get": {
|
|
10010
|
-
"summary": "Get a release
|
|
10011
|
-
"description": "
|
|
12256
|
+
"summary": "Get a release",
|
|
12257
|
+
"description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#hypermedia).",
|
|
10012
12258
|
"tags": ["repos"],
|
|
10013
|
-
"operationId": "repos/get-release
|
|
12259
|
+
"operationId": "repos/get-release",
|
|
10014
12260
|
"externalDocs": {
|
|
10015
12261
|
"description": "API method documentation",
|
|
10016
|
-
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-a-release
|
|
12262
|
+
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-a-release"
|
|
10017
12263
|
},
|
|
10018
12264
|
"parameters": [
|
|
10019
12265
|
{
|
|
@@ -10029,17 +12275,16 @@
|
|
|
10029
12275
|
"schema": { "type": "string" }
|
|
10030
12276
|
},
|
|
10031
12277
|
{
|
|
10032
|
-
"name": "
|
|
10033
|
-
"description": "
|
|
12278
|
+
"name": "release_id",
|
|
12279
|
+
"description": "release_id parameter",
|
|
10034
12280
|
"in": "path",
|
|
10035
12281
|
"required": true,
|
|
10036
|
-
"schema": { "type": "
|
|
10037
|
-
"x-multi-segment": true
|
|
12282
|
+
"schema": { "type": "integer" }
|
|
10038
12283
|
}
|
|
10039
12284
|
],
|
|
10040
12285
|
"responses": {
|
|
10041
12286
|
"200": {
|
|
10042
|
-
"description": "
|
|
12287
|
+
"description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#hypermedia).",
|
|
10043
12288
|
"content": {
|
|
10044
12289
|
"application/json": {
|
|
10045
12290
|
"schema": {
|
|
@@ -10514,17 +12759,15 @@
|
|
|
10514
12759
|
"subcategory": "releases"
|
|
10515
12760
|
},
|
|
10516
12761
|
"x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
|
|
10517
|
-
}
|
|
10518
|
-
|
|
10519
|
-
|
|
10520
|
-
|
|
10521
|
-
"summary": "Get a release",
|
|
10522
|
-
"description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#hypermedia).",
|
|
12762
|
+
},
|
|
12763
|
+
"patch": {
|
|
12764
|
+
"summary": "Update a release",
|
|
12765
|
+
"description": "Users with push access to the repository can edit a release.",
|
|
10523
12766
|
"tags": ["repos"],
|
|
10524
|
-
"operationId": "repos/
|
|
12767
|
+
"operationId": "repos/update-release",
|
|
10525
12768
|
"externalDocs": {
|
|
10526
12769
|
"description": "API method documentation",
|
|
10527
|
-
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#
|
|
12770
|
+
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#update-a-release"
|
|
10528
12771
|
},
|
|
10529
12772
|
"parameters": [
|
|
10530
12773
|
{
|
|
@@ -10547,9 +12790,52 @@
|
|
|
10547
12790
|
"schema": { "type": "integer" }
|
|
10548
12791
|
}
|
|
10549
12792
|
],
|
|
12793
|
+
"requestBody": {
|
|
12794
|
+
"content": {
|
|
12795
|
+
"application/json": {
|
|
12796
|
+
"schema": {
|
|
12797
|
+
"type": "object",
|
|
12798
|
+
"properties": {
|
|
12799
|
+
"tag_name": {
|
|
12800
|
+
"type": "string",
|
|
12801
|
+
"description": "The name of the tag."
|
|
12802
|
+
},
|
|
12803
|
+
"target_commitish": {
|
|
12804
|
+
"type": "string",
|
|
12805
|
+
"description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`)."
|
|
12806
|
+
},
|
|
12807
|
+
"name": {
|
|
12808
|
+
"type": "string",
|
|
12809
|
+
"description": "The name of the release."
|
|
12810
|
+
},
|
|
12811
|
+
"body": {
|
|
12812
|
+
"type": "string",
|
|
12813
|
+
"description": "Text describing the contents of the tag."
|
|
12814
|
+
},
|
|
12815
|
+
"draft": {
|
|
12816
|
+
"type": "boolean",
|
|
12817
|
+
"description": "`true` makes the release a draft, and `false` publishes the release."
|
|
12818
|
+
},
|
|
12819
|
+
"prerelease": {
|
|
12820
|
+
"type": "boolean",
|
|
12821
|
+
"description": "`true` to identify the release as a prerelease, `false` to identify the release as a full release."
|
|
12822
|
+
}
|
|
12823
|
+
}
|
|
12824
|
+
},
|
|
12825
|
+
"example": {
|
|
12826
|
+
"tag_name": "v1.0.0",
|
|
12827
|
+
"target_commitish": "master",
|
|
12828
|
+
"name": "v1.0.0",
|
|
12829
|
+
"body": "Description of the release",
|
|
12830
|
+
"draft": false,
|
|
12831
|
+
"prerelease": false
|
|
12832
|
+
}
|
|
12833
|
+
}
|
|
12834
|
+
}
|
|
12835
|
+
},
|
|
10550
12836
|
"responses": {
|
|
10551
12837
|
"200": {
|
|
10552
|
-
"description": "
|
|
12838
|
+
"description": "Response",
|
|
10553
12839
|
"content": {
|
|
10554
12840
|
"application/json": {
|
|
10555
12841
|
"schema": {
|
|
@@ -10996,24 +13282,6 @@
|
|
|
10996
13282
|
}
|
|
10997
13283
|
}
|
|
10998
13284
|
}
|
|
10999
|
-
},
|
|
11000
|
-
"404": {
|
|
11001
|
-
"description": "Resource not found",
|
|
11002
|
-
"content": {
|
|
11003
|
-
"application/json": {
|
|
11004
|
-
"schema": {
|
|
11005
|
-
"title": "Basic Error",
|
|
11006
|
-
"description": "Basic Error",
|
|
11007
|
-
"type": "object",
|
|
11008
|
-
"properties": {
|
|
11009
|
-
"message": { "type": "string" },
|
|
11010
|
-
"documentation_url": { "type": "string" },
|
|
11011
|
-
"url": { "type": "string" },
|
|
11012
|
-
"status": { "type": "string" }
|
|
11013
|
-
}
|
|
11014
|
-
}
|
|
11015
|
-
}
|
|
11016
|
-
}
|
|
11017
13285
|
}
|
|
11018
13286
|
},
|
|
11019
13287
|
"x-github": {
|