@octokit/openapi 5.6.4 → 5.6.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (27) hide show
  1. package/generated/api.github.com.deref.json +2 -2
  2. package/generated/api.github.com.json +2 -2
  3. package/generated/ghes-2.22-diff-to-ghes-3.0.deref.json +1 -1
  4. package/generated/ghes-2.22-diff-to-ghes-3.0.json +1 -1
  5. package/generated/ghes-2.22.deref.json +1 -1
  6. package/generated/ghes-2.22.json +1 -1
  7. package/generated/ghes-3.0-anicca-diff-to-ghes-3.1.deref.json +0 -145
  8. package/generated/ghes-3.0-diff-to-ghes-3.1.deref.json +8739 -19455
  9. package/generated/ghes-3.0-diff-to-ghes-3.1.json +245 -1527
  10. package/generated/ghes-3.0.deref.json +7 -7
  11. package/generated/ghes-3.0.json +7 -7
  12. package/generated/ghes-3.1-anicca-diff-to-ghes-3.2.deref.json +286 -1467
  13. package/generated/ghes-3.1-diff-to-ghes-3.2.deref.json +81247 -128945
  14. package/generated/ghes-3.1-diff-to-ghes-3.2.json +9485 -14738
  15. package/generated/ghes-3.1.deref.json +39 -39
  16. package/generated/ghes-3.1.json +39 -39
  17. package/generated/ghes-3.2-anicca-diff-to-api.github.com.deref.json +0 -130
  18. package/generated/ghes-3.2-diff-to-api.github.com.deref.json +282 -2066
  19. package/generated/ghes-3.2-diff-to-api.github.com.json +160 -865
  20. package/generated/ghes-3.2.deref.json +8 -8
  21. package/generated/ghes-3.2.json +8 -20
  22. package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +0 -55
  23. package/generated/github.ae-diff-to-api.github.com.deref.json +1 -4963
  24. package/generated/github.ae-diff-to-api.github.com.json +106 -2784
  25. package/generated/github.ae.deref.json +5 -5
  26. package/generated/github.ae.json +5 -11
  27. package/package.json +1 -1
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "5.6.4",
4
+ "version": "5.6.5",
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,65 +6476,6 @@
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" } } }
6538
6479
  }
6539
6480
  },
6540
6481
  "/meta": {
@@ -6608,15 +6549,15 @@
6608
6549
  "x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
6609
6550
  }
6610
6551
  },
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",
6552
+ "/orgs/{org}/actions/permissions/selected-actions": {
6553
+ "get": {
6554
+ "summary": "Get allowed actions for an organization",
6555
+ "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.",
6556
+ "operationId": "actions/get-allowed-actions-organization",
6557
+ "tags": ["actions"],
6617
6558
  "externalDocs": {
6618
6559
  "description": "API method documentation",
6619
- "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs/#update-an-organization"
6560
+ "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-allowed-actions-for-an-organization"
6620
6561
  },
6621
6562
  "parameters": [
6622
6563
  {
@@ -6626,460 +6567,131 @@
6626
6567
  "schema": { "type": "string" }
6627
6568
  }
6628
6569
  ],
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."
6638
- },
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
6570
+ "responses": {
6571
+ "200": {
6572
+ "description": "Response",
6573
+ "content": {
6574
+ "application/json": {
6575
+ "schema": {
6576
+ "type": "object",
6577
+ "properties": {
6578
+ "github_owned_allowed": {
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
+ }
6703
6587
  },
6704
- "blog": {
6705
- "type": "string",
6706
- "example": "\"http://github.blog\""
6588
+ "required": ["github_owned_allowed", "patterns_allowed"]
6589
+ },
6590
+ "examples": {
6591
+ "default": {
6592
+ "value": {
6593
+ "github_owned_allowed": true,
6594
+ "verified_allowed": false,
6595
+ "patterns_allowed": ["monalisa/octocat@*", "docker/*"]
6596
+ }
6707
6597
  }
6708
6598
  }
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"
6721
6599
  }
6722
6600
  }
6723
6601
  }
6724
6602
  },
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
+ ],
6725
6665
  "responses": {
6726
6666
  "200": {
6727
6667
  "description": "Response",
6728
6668
  "content": {
6729
6669
  "application/json": {
6730
6670
  "schema": {
6731
- "title": "Organization Full",
6732
- "description": "Organization Full",
6733
- "type": "object",
6734
- "properties": {
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
- ]
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
+ }
6934
6682
  },
6935
6683
  "examples": {
6936
6684
  "default": {
6937
- "value": {
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"
6988
- }
6989
- }
6990
- }
6991
- }
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
- "415": {
7013
- "description": "Preview header missing",
7014
- "content": {
7015
- "application/json": {
7016
- "schema": {
7017
- "type": "object",
7018
- "required": ["message", "documentation_url"],
7019
- "properties": {
7020
- "message": { "type": "string" },
7021
- "documentation_url": { "type": "string" }
7022
- }
7023
- }
7024
- }
7025
- }
7026
- },
7027
- "422": {
7028
- "description": "Validation failed",
7029
- "content": {
7030
- "application/json": {
7031
- "schema": {
7032
- "oneOf": [
7033
- {
7034
- "title": "Validation Error",
7035
- "description": "Validation Error",
7036
- "type": "object",
7037
- "required": ["message", "documentation_url"],
7038
- "properties": {
7039
- "message": { "type": "string" },
7040
- "documentation_url": { "type": "string" },
7041
- "errors": {
7042
- "type": "array",
7043
- "items": {
7044
- "type": "object",
7045
- "required": ["code"],
7046
- "properties": {
7047
- "resource": { "type": "string" },
7048
- "field": { "type": "string" },
7049
- "message": { "type": "string" },
7050
- "code": { "type": "string" },
7051
- "index": { "type": "integer" },
7052
- "value": {
7053
- "oneOf": [
7054
- { "type": "string", "nullable": true },
7055
- { "type": "integer", "nullable": true },
7056
- {
7057
- "type": "array",
7058
- "nullable": true,
7059
- "items": { "type": "string" }
7060
- }
7061
- ]
7062
- }
7063
- }
7064
- }
7065
- }
7066
- }
7067
- },
7068
- {
7069
- "title": "Validation Error Simple",
7070
- "description": "Validation Error Simple",
7071
- "type": "object",
7072
- "required": ["message", "documentation_url"],
7073
- "properties": {
7074
- "message": { "type": "string" },
7075
- "documentation_url": { "type": "string" },
7076
- "errors": {
7077
- "type": "array",
7078
- "items": { "type": "string" }
7079
- }
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
7080
6692
  }
7081
- }
7082
- ]
6693
+ ]
6694
+ }
7083
6695
  }
7084
6696
  }
7085
6697
  }
@@ -7090,26 +6702,26 @@
7090
6702
  "enabledForGitHubApps": true,
7091
6703
  "previews": [
7092
6704
  {
7093
- "required": false,
7094
- "name": "surtur",
7095
- "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```"
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```"
7096
6708
  }
7097
6709
  ],
7098
- "category": "orgs",
7099
- "subcategory": null
6710
+ "category": "enterprise-admin",
6711
+ "subcategory": "org-pre-receive-hooks"
7100
6712
  },
7101
- "x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
6713
+ "x-octokit": { "diff": { "api.github.com": { "type": "added" } } }
7102
6714
  }
7103
6715
  },
7104
- "/orgs/{org}/actions/permissions/selected-actions": {
6716
+ "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}": {
7105
6717
  "get": {
7106
- "summary": "Get allowed actions for an organization",
7107
- "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.",
7108
- "operationId": "actions/get-allowed-actions-organization",
7109
- "tags": ["actions"],
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"],
7110
6722
  "externalDocs": {
7111
6723
  "description": "API method documentation",
7112
- "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-allowed-actions-for-an-organization"
6724
+ "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-an-organization"
7113
6725
  },
7114
6726
  "parameters": [
7115
6727
  {
@@ -7117,6 +6729,13 @@
7117
6729
  "in": "path",
7118
6730
  "required": true,
7119
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" }
7120
6739
  }
7121
6740
  ],
7122
6741
  "responses": {
@@ -7127,249 +6746,21 @@
7127
6746
  "schema": {
7128
6747
  "type": "object",
7129
6748
  "properties": {
7130
- "github_owned_allowed": {
7131
- "type": "boolean",
7132
- "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization."
7133
- },
7134
- "patterns_allowed": {
7135
- "type": "array",
7136
- "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/*`.\"",
7137
- "items": { "type": "string" }
7138
- }
7139
- },
7140
- "required": ["github_owned_allowed", "patterns_allowed"]
6749
+ "id": { "type": "integer" },
6750
+ "name": { "type": "string" },
6751
+ "enforcement": { "type": "string" },
6752
+ "configuration_url": { "type": "string" },
6753
+ "allow_downstream_configuration": { "type": "boolean" }
6754
+ }
7141
6755
  },
7142
6756
  "examples": {
7143
6757
  "default": {
7144
6758
  "value": {
7145
- "github_owned_allowed": true,
7146
- "verified_allowed": false,
7147
- "patterns_allowed": ["monalisa/octocat@*", "docker/*"]
7148
- }
7149
- }
7150
- }
7151
- }
7152
- }
7153
- }
7154
- },
7155
- "x-github": {
7156
- "enabledForGitHubApps": true,
7157
- "githubCloudOnly": false,
7158
- "previews": [],
7159
- "category": "actions",
7160
- "subcategory": "permissions"
7161
- },
7162
- "x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
7163
- },
7164
- "put": {
7165
- "summary": "Set allowed actions for an organization",
7166
- "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.",
7167
- "operationId": "actions/set-allowed-actions-organization",
7168
- "tags": ["actions"],
7169
- "externalDocs": {
7170
- "description": "API method documentation",
7171
- "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#set-allowed-actions-for-an-organization"
7172
- },
7173
- "parameters": [
7174
- {
7175
- "name": "org",
7176
- "in": "path",
7177
- "required": true,
7178
- "schema": { "type": "string" }
7179
- }
7180
- ],
7181
- "responses": { "204": { "description": "Response" } },
7182
- "requestBody": {
7183
- "content": {
7184
- "application/json": {
7185
- "schema": {
7186
- "type": "object",
7187
- "properties": {
7188
- "github_owned_allowed": {
7189
- "type": "boolean",
7190
- "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization."
7191
- },
7192
- "patterns_allowed": {
7193
- "type": "array",
7194
- "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/*`.\"",
7195
- "items": { "type": "string" }
7196
- }
7197
- },
7198
- "required": ["github_owned_allowed", "patterns_allowed"]
7199
- },
7200
- "examples": {
7201
- "selected_actions": {
7202
- "value": {
7203
- "github_owned_allowed": true,
7204
- "verified_allowed": false,
7205
- "patterns_allowed": ["monalisa/octocat@*", "docker/*"]
7206
- }
7207
- }
7208
- }
7209
- }
7210
- }
7211
- },
7212
- "x-github": {
7213
- "enabledForGitHubApps": true,
7214
- "githubCloudOnly": false,
7215
- "previews": [],
7216
- "category": "actions",
7217
- "subcategory": "permissions"
7218
- },
7219
- "x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
7220
- }
7221
- },
7222
- "/orgs/{org}/pre-receive-hooks": {
7223
- "get": {
7224
- "summary": "List pre-receive hooks for an organization",
7225
- "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.",
7226
- "operationId": "enterprise-admin/list-pre-receive-hooks-for-org",
7227
- "tags": ["enterprise-admin"],
7228
- "externalDocs": {
7229
- "description": "API method documentation",
7230
- "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#list-pre-receive-hooks-for-an-organization"
7231
- },
7232
- "parameters": [
7233
- {
7234
- "name": "org",
7235
- "in": "path",
7236
- "required": true,
7237
- "schema": { "type": "string" }
7238
- },
7239
- {
7240
- "name": "per_page",
7241
- "description": "Results per page (max 100)",
7242
- "in": "query",
7243
- "schema": { "type": "integer", "default": 30 }
7244
- },
7245
- {
7246
- "name": "page",
7247
- "description": "Page number of the results to fetch.",
7248
- "in": "query",
7249
- "schema": { "type": "integer", "default": 1 }
7250
- },
7251
- {
7252
- "name": "direction",
7253
- "description": "One of `asc` (ascending) or `desc` (descending).",
7254
- "in": "query",
7255
- "required": false,
7256
- "schema": {
7257
- "type": "string",
7258
- "enum": ["asc", "desc"],
7259
- "default": "desc"
7260
- }
7261
- },
7262
- {
7263
- "name": "sort",
7264
- "description": "The sort order for the response collection.",
7265
- "in": "query",
7266
- "required": false,
7267
- "schema": {
7268
- "type": "string",
7269
- "enum": ["created", "updated", "name"],
7270
- "default": "created"
7271
- }
7272
- }
7273
- ],
7274
- "responses": {
7275
- "200": {
7276
- "description": "Response",
7277
- "content": {
7278
- "application/json": {
7279
- "schema": {
7280
- "type": "array",
7281
- "items": {
7282
- "type": "object",
7283
- "properties": {
7284
- "id": { "type": "integer" },
7285
- "name": { "type": "string" },
7286
- "enforcement": { "type": "string" },
7287
- "configuration_url": { "type": "string" },
7288
- "allow_downstream_configuration": { "type": "boolean" }
7289
- }
7290
- }
7291
- },
7292
- "examples": {
7293
- "default": {
7294
- "value": [
7295
- {
7296
- "id": 42,
7297
- "name": "Check Commits",
7298
- "enforcement": "disabled",
7299
- "configuration_url": "https://github.example.com/api/v3/admin/pre-receive-hooks/42",
7300
- "allow_downstream_configuration": true
7301
- }
7302
- ]
7303
- }
7304
- }
7305
- }
7306
- }
7307
- }
7308
- },
7309
- "x-github": {
7310
- "githubCloudOnly": false,
7311
- "enabledForGitHubApps": true,
7312
- "previews": [
7313
- {
7314
- "required": true,
7315
- "name": "eye-scream",
7316
- "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```"
7317
- }
7318
- ],
7319
- "category": "enterprise-admin",
7320
- "subcategory": "org-pre-receive-hooks"
7321
- },
7322
- "x-octokit": { "diff": { "api.github.com": { "type": "added" } } }
7323
- }
7324
- },
7325
- "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}": {
7326
- "get": {
7327
- "summary": "Get a pre-receive hook for an organization",
7328
- "description": "",
7329
- "operationId": "enterprise-admin/get-pre-receive-hook-for-org",
7330
- "tags": ["enterprise-admin"],
7331
- "externalDocs": {
7332
- "description": "API method documentation",
7333
- "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-an-organization"
7334
- },
7335
- "parameters": [
7336
- {
7337
- "name": "org",
7338
- "in": "path",
7339
- "required": true,
7340
- "schema": { "type": "string" }
7341
- },
7342
- {
7343
- "name": "pre_receive_hook_id",
7344
- "description": "pre_receive_hook_id parameter",
7345
- "in": "path",
7346
- "required": true,
7347
- "schema": { "type": "integer" }
7348
- }
7349
- ],
7350
- "responses": {
7351
- "200": {
7352
- "description": "Response",
7353
- "content": {
7354
- "application/json": {
7355
- "schema": {
7356
- "type": "object",
7357
- "properties": {
7358
- "id": { "type": "integer" },
7359
- "name": { "type": "string" },
7360
- "enforcement": { "type": "string" },
7361
- "configuration_url": { "type": "string" },
7362
- "allow_downstream_configuration": { "type": "boolean" }
7363
- }
7364
- },
7365
- "examples": {
7366
- "default": {
7367
- "value": {
7368
- "id": 42,
7369
- "name": "Check Commits",
7370
- "enforcement": "disabled",
7371
- "configuration_url": "https://github.example.com/api/v3/admin/pre-receive-hooks/42",
7372
- "allow_downstream_configuration": true
6759
+ "id": 42,
6760
+ "name": "Check Commits",
6761
+ "enforcement": "disabled",
6762
+ "configuration_url": "https://github.example.com/api/v3/admin/pre-receive-hooks/42",
6763
+ "allow_downstream_configuration": true
7373
6764
  }
7374
6765
  }
7375
6766
  }
@@ -7619,69 +7010,6 @@
7619
7010
  "subcategory": "permissions"
7620
7011
  },
7621
7012
  "x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
7622
- },
7623
- "put": {
7624
- "summary": "Set allowed actions for a repository",
7625
- "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.",
7626
- "operationId": "actions/set-allowed-actions-repository",
7627
- "tags": ["actions"],
7628
- "externalDocs": {
7629
- "description": "API method documentation",
7630
- "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#set-allowed-actions-for-a-repository"
7631
- },
7632
- "parameters": [
7633
- {
7634
- "name": "owner",
7635
- "in": "path",
7636
- "required": true,
7637
- "schema": { "type": "string" }
7638
- },
7639
- {
7640
- "name": "repo",
7641
- "in": "path",
7642
- "required": true,
7643
- "schema": { "type": "string" }
7644
- }
7645
- ],
7646
- "responses": { "204": { "description": "Response" } },
7647
- "requestBody": {
7648
- "content": {
7649
- "application/json": {
7650
- "schema": {
7651
- "type": "object",
7652
- "properties": {
7653
- "github_owned_allowed": {
7654
- "type": "boolean",
7655
- "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization."
7656
- },
7657
- "patterns_allowed": {
7658
- "type": "array",
7659
- "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/*`.\"",
7660
- "items": { "type": "string" }
7661
- }
7662
- },
7663
- "required": ["github_owned_allowed", "patterns_allowed"]
7664
- },
7665
- "examples": {
7666
- "selected_actions": {
7667
- "value": {
7668
- "github_owned_allowed": true,
7669
- "verified_allowed": false,
7670
- "patterns_allowed": ["monalisa/octocat@*", "docker/*"]
7671
- }
7672
- }
7673
- }
7674
- }
7675
- }
7676
- },
7677
- "x-github": {
7678
- "enabledForGitHubApps": true,
7679
- "githubCloudOnly": false,
7680
- "previews": [],
7681
- "category": "actions",
7682
- "subcategory": "permissions"
7683
- },
7684
- "x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
7685
7013
  }
7686
7014
  },
7687
7015
  "/repos/{owner}/{repo}/pre-receive-hooks": {
@@ -8439,1168 +7767,104 @@
8439
7767
  "default": {
8440
7768
  "value": [
8441
7769
  {
8442
- "url": "https://api.github.com/repos/octocat/Hello-World/releases/1",
8443
- "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0",
8444
- "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets",
8445
- "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}",
8446
- "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0",
8447
- "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0",
8448
- "id": 1,
8449
- "node_id": "MDc6UmVsZWFzZTE=",
8450
- "tag_name": "v1.0.0",
8451
- "target_commitish": "master",
8452
- "name": "v1.0.0",
8453
- "body": "Description of the release",
8454
- "draft": false,
8455
- "prerelease": false,
8456
- "created_at": "2013-02-27T19:35:32Z",
8457
- "published_at": "2013-02-27T19:35:32Z",
8458
- "author": {
8459
- "login": "octocat",
8460
- "id": 1,
8461
- "node_id": "MDQ6VXNlcjE=",
8462
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
8463
- "gravatar_id": "",
8464
- "url": "https://api.github.com/users/octocat",
8465
- "html_url": "https://github.com/octocat",
8466
- "followers_url": "https://api.github.com/users/octocat/followers",
8467
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
8468
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
8469
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
8470
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
8471
- "organizations_url": "https://api.github.com/users/octocat/orgs",
8472
- "repos_url": "https://api.github.com/users/octocat/repos",
8473
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
8474
- "received_events_url": "https://api.github.com/users/octocat/received_events",
8475
- "type": "User",
8476
- "site_admin": false
8477
- },
8478
- "assets": [
8479
- {
8480
- "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1",
8481
- "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip",
8482
- "id": 1,
8483
- "node_id": "MDEyOlJlbGVhc2VBc3NldDE=",
8484
- "name": "example.zip",
8485
- "label": "short description",
8486
- "state": "uploaded",
8487
- "content_type": "application/zip",
8488
- "size": 1024,
8489
- "download_count": 42,
8490
- "created_at": "2013-02-27T19:35:32Z",
8491
- "updated_at": "2013-02-27T19:35:32Z",
8492
- "uploader": {
8493
- "login": "octocat",
8494
- "id": 1,
8495
- "node_id": "MDQ6VXNlcjE=",
8496
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
8497
- "gravatar_id": "",
8498
- "url": "https://api.github.com/users/octocat",
8499
- "html_url": "https://github.com/octocat",
8500
- "followers_url": "https://api.github.com/users/octocat/followers",
8501
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
8502
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
8503
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
8504
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
8505
- "organizations_url": "https://api.github.com/users/octocat/orgs",
8506
- "repos_url": "https://api.github.com/users/octocat/repos",
8507
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
8508
- "received_events_url": "https://api.github.com/users/octocat/received_events",
8509
- "type": "User",
8510
- "site_admin": false
8511
- }
8512
- }
8513
- ]
8514
- }
8515
- ]
8516
- }
8517
- }
8518
- }
8519
- },
8520
- "headers": {
8521
- "Link": {
8522
- "example": "<https://api.github.com/resource?page=2>; rel=\"next\", <https://api.github.com/resource?page=5>; rel=\"last\"",
8523
- "schema": { "type": "string" }
8524
- }
8525
- }
8526
- },
8527
- "404": {
8528
- "description": "Resource not found",
8529
- "content": {
8530
- "application/json": {
8531
- "schema": {
8532
- "title": "Basic Error",
8533
- "description": "Basic Error",
8534
- "type": "object",
8535
- "properties": {
8536
- "message": { "type": "string" },
8537
- "documentation_url": { "type": "string" },
8538
- "url": { "type": "string" },
8539
- "status": { "type": "string" }
8540
- }
8541
- }
8542
- }
8543
- }
8544
- }
8545
- },
8546
- "x-github": {
8547
- "githubCloudOnly": false,
8548
- "enabledForGitHubApps": true,
8549
- "previews": [],
8550
- "category": "repos",
8551
- "subcategory": "releases"
8552
- },
8553
- "x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
8554
- },
8555
- "post": {
8556
- "summary": "Create a release",
8557
- "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.",
8558
- "tags": ["repos"],
8559
- "operationId": "repos/create-release",
8560
- "externalDocs": {
8561
- "description": "API method documentation",
8562
- "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#create-a-release"
8563
- },
8564
- "parameters": [
8565
- {
8566
- "name": "owner",
8567
- "in": "path",
8568
- "required": true,
8569
- "schema": { "type": "string" }
8570
- },
8571
- {
8572
- "name": "repo",
8573
- "in": "path",
8574
- "required": true,
8575
- "schema": { "type": "string" }
8576
- }
8577
- ],
8578
- "requestBody": {
8579
- "required": true,
8580
- "content": {
8581
- "application/json": {
8582
- "schema": {
8583
- "type": "object",
8584
- "properties": {
8585
- "tag_name": {
8586
- "type": "string",
8587
- "description": "The name of the tag."
8588
- },
8589
- "target_commitish": {
8590
- "type": "string",
8591
- "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`)."
8592
- },
8593
- "name": {
8594
- "type": "string",
8595
- "description": "The name of the release."
8596
- },
8597
- "body": {
8598
- "type": "string",
8599
- "description": "Text describing the contents of the tag."
8600
- },
8601
- "draft": {
8602
- "type": "boolean",
8603
- "description": "`true` to create a draft (unpublished) release, `false` to create a published one.",
8604
- "default": false
8605
- },
8606
- "prerelease": {
8607
- "type": "boolean",
8608
- "description": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.",
8609
- "default": false
8610
- }
8611
- },
8612
- "required": ["tag_name"]
8613
- },
8614
- "example": {
8615
- "tag_name": "v1.0.0",
8616
- "target_commitish": "master",
8617
- "name": "v1.0.0",
8618
- "body": "Description of the release",
8619
- "draft": false,
8620
- "prerelease": false
8621
- }
8622
- }
8623
- }
8624
- },
8625
- "responses": {
8626
- "201": {
8627
- "description": "Response",
8628
- "content": {
8629
- "application/json": {
8630
- "schema": {
8631
- "title": "Release",
8632
- "description": "A release.",
8633
- "type": "object",
8634
- "properties": {
8635
- "url": { "type": "string", "format": "uri" },
8636
- "html_url": { "type": "string", "format": "uri" },
8637
- "assets_url": { "type": "string", "format": "uri" },
8638
- "upload_url": { "type": "string" },
8639
- "tarball_url": {
8640
- "type": "string",
8641
- "format": "uri",
8642
- "nullable": true
8643
- },
8644
- "zipball_url": {
8645
- "type": "string",
8646
- "format": "uri",
8647
- "nullable": true
8648
- },
8649
- "id": { "type": "integer" },
8650
- "node_id": { "type": "string" },
8651
- "tag_name": {
8652
- "description": "The name of the tag.",
8653
- "example": "v1.0.0",
8654
- "type": "string"
8655
- },
8656
- "target_commitish": {
8657
- "description": "Specifies the commitish value that determines where the Git tag is created from.",
8658
- "example": "master",
8659
- "type": "string"
8660
- },
8661
- "name": { "type": "string", "nullable": true },
8662
- "body": { "type": "string", "nullable": true },
8663
- "draft": {
8664
- "description": "true to create a draft (unpublished) release, false to create a published one.",
8665
- "example": false,
8666
- "type": "boolean"
8667
- },
8668
- "prerelease": {
8669
- "description": "Whether to identify the release as a prerelease or a full release.",
8670
- "example": false,
8671
- "type": "boolean"
8672
- },
8673
- "created_at": { "type": "string", "format": "date-time" },
8674
- "published_at": {
8675
- "type": "string",
8676
- "format": "date-time",
8677
- "nullable": true
8678
- },
8679
- "author": {
8680
- "title": "Simple User",
8681
- "description": "Simple User",
8682
- "type": "object",
8683
- "properties": {
8684
- "name": { "nullable": true, "type": "string" },
8685
- "email": { "nullable": true, "type": "string" },
8686
- "login": { "type": "string", "example": "octocat" },
8687
- "id": { "type": "integer", "example": 1 },
8688
- "node_id": {
8689
- "type": "string",
8690
- "example": "MDQ6VXNlcjE="
8691
- },
8692
- "avatar_url": {
8693
- "type": "string",
8694
- "format": "uri",
8695
- "example": "https://github.com/images/error/octocat_happy.gif"
8696
- },
8697
- "gravatar_id": {
8698
- "type": "string",
8699
- "example": "41d064eb2195891e12d0413f63227ea7",
8700
- "nullable": true
8701
- },
8702
- "url": {
8703
- "type": "string",
8704
- "format": "uri",
8705
- "example": "https://api.github.com/users/octocat"
8706
- },
8707
- "html_url": {
8708
- "type": "string",
8709
- "format": "uri",
8710
- "example": "https://github.com/octocat"
8711
- },
8712
- "followers_url": {
8713
- "type": "string",
8714
- "format": "uri",
8715
- "example": "https://api.github.com/users/octocat/followers"
8716
- },
8717
- "following_url": {
8718
- "type": "string",
8719
- "example": "https://api.github.com/users/octocat/following{/other_user}"
8720
- },
8721
- "gists_url": {
8722
- "type": "string",
8723
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
8724
- },
8725
- "starred_url": {
8726
- "type": "string",
8727
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
8728
- },
8729
- "subscriptions_url": {
8730
- "type": "string",
8731
- "format": "uri",
8732
- "example": "https://api.github.com/users/octocat/subscriptions"
8733
- },
8734
- "organizations_url": {
8735
- "type": "string",
8736
- "format": "uri",
8737
- "example": "https://api.github.com/users/octocat/orgs"
8738
- },
8739
- "repos_url": {
8740
- "type": "string",
8741
- "format": "uri",
8742
- "example": "https://api.github.com/users/octocat/repos"
8743
- },
8744
- "events_url": {
8745
- "type": "string",
8746
- "example": "https://api.github.com/users/octocat/events{/privacy}"
8747
- },
8748
- "received_events_url": {
8749
- "type": "string",
8750
- "format": "uri",
8751
- "example": "https://api.github.com/users/octocat/received_events"
8752
- },
8753
- "type": { "type": "string", "example": "User" },
8754
- "site_admin": { "type": "boolean" },
8755
- "starred_at": {
8756
- "type": "string",
8757
- "example": "\"2020-07-09T00:17:55Z\""
8758
- }
8759
- },
8760
- "required": [
8761
- "avatar_url",
8762
- "events_url",
8763
- "followers_url",
8764
- "following_url",
8765
- "gists_url",
8766
- "gravatar_id",
8767
- "html_url",
8768
- "id",
8769
- "node_id",
8770
- "login",
8771
- "organizations_url",
8772
- "received_events_url",
8773
- "repos_url",
8774
- "site_admin",
8775
- "starred_url",
8776
- "subscriptions_url",
8777
- "type",
8778
- "url"
8779
- ]
8780
- },
8781
- "assets": {
8782
- "type": "array",
8783
- "items": {
8784
- "title": "Release Asset",
8785
- "description": "Data related to a release.",
8786
- "type": "object",
8787
- "properties": {
8788
- "url": { "type": "string", "format": "uri" },
8789
- "browser_download_url": {
8790
- "type": "string",
8791
- "format": "uri"
8792
- },
8793
- "id": { "type": "integer" },
8794
- "node_id": { "type": "string" },
8795
- "name": {
8796
- "description": "The file name of the asset.",
8797
- "type": "string",
8798
- "example": "Team Environment"
8799
- },
8800
- "label": { "type": "string", "nullable": true },
8801
- "state": {
8802
- "description": "State of the release asset.",
8803
- "type": "string",
8804
- "enum": ["uploaded", "open"]
8805
- },
8806
- "content_type": { "type": "string" },
8807
- "size": { "type": "integer" },
8808
- "download_count": { "type": "integer" },
8809
- "created_at": {
8810
- "type": "string",
8811
- "format": "date-time"
8812
- },
8813
- "updated_at": {
8814
- "type": "string",
8815
- "format": "date-time"
8816
- },
8817
- "uploader": {
8818
- "title": "Simple User",
8819
- "description": "Simple User",
8820
- "type": "object",
8821
- "properties": {
8822
- "name": { "nullable": true, "type": "string" },
8823
- "email": { "nullable": true, "type": "string" },
8824
- "login": {
8825
- "type": "string",
8826
- "example": "octocat"
8827
- },
8828
- "id": { "type": "integer", "example": 1 },
8829
- "node_id": {
8830
- "type": "string",
8831
- "example": "MDQ6VXNlcjE="
8832
- },
8833
- "avatar_url": {
8834
- "type": "string",
8835
- "format": "uri",
8836
- "example": "https://github.com/images/error/octocat_happy.gif"
8837
- },
8838
- "gravatar_id": {
8839
- "type": "string",
8840
- "example": "41d064eb2195891e12d0413f63227ea7",
8841
- "nullable": true
8842
- },
8843
- "url": {
8844
- "type": "string",
8845
- "format": "uri",
8846
- "example": "https://api.github.com/users/octocat"
8847
- },
8848
- "html_url": {
8849
- "type": "string",
8850
- "format": "uri",
8851
- "example": "https://github.com/octocat"
8852
- },
8853
- "followers_url": {
8854
- "type": "string",
8855
- "format": "uri",
8856
- "example": "https://api.github.com/users/octocat/followers"
8857
- },
8858
- "following_url": {
8859
- "type": "string",
8860
- "example": "https://api.github.com/users/octocat/following{/other_user}"
8861
- },
8862
- "gists_url": {
8863
- "type": "string",
8864
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
8865
- },
8866
- "starred_url": {
8867
- "type": "string",
8868
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
8869
- },
8870
- "subscriptions_url": {
8871
- "type": "string",
8872
- "format": "uri",
8873
- "example": "https://api.github.com/users/octocat/subscriptions"
8874
- },
8875
- "organizations_url": {
8876
- "type": "string",
8877
- "format": "uri",
8878
- "example": "https://api.github.com/users/octocat/orgs"
8879
- },
8880
- "repos_url": {
8881
- "type": "string",
8882
- "format": "uri",
8883
- "example": "https://api.github.com/users/octocat/repos"
8884
- },
8885
- "events_url": {
8886
- "type": "string",
8887
- "example": "https://api.github.com/users/octocat/events{/privacy}"
8888
- },
8889
- "received_events_url": {
8890
- "type": "string",
8891
- "format": "uri",
8892
- "example": "https://api.github.com/users/octocat/received_events"
8893
- },
8894
- "type": { "type": "string", "example": "User" },
8895
- "site_admin": { "type": "boolean" },
8896
- "starred_at": {
8897
- "type": "string",
8898
- "example": "\"2020-07-09T00:17:55Z\""
8899
- }
8900
- },
8901
- "required": [
8902
- "avatar_url",
8903
- "events_url",
8904
- "followers_url",
8905
- "following_url",
8906
- "gists_url",
8907
- "gravatar_id",
8908
- "html_url",
8909
- "id",
8910
- "node_id",
8911
- "login",
8912
- "organizations_url",
8913
- "received_events_url",
8914
- "repos_url",
8915
- "site_admin",
8916
- "starred_url",
8917
- "subscriptions_url",
8918
- "type",
8919
- "url"
8920
- ],
8921
- "nullable": true
8922
- }
8923
- },
8924
- "required": [
8925
- "id",
8926
- "name",
8927
- "content_type",
8928
- "size",
8929
- "state",
8930
- "url",
8931
- "node_id",
8932
- "download_count",
8933
- "label",
8934
- "uploader",
8935
- "browser_download_url",
8936
- "created_at",
8937
- "updated_at"
8938
- ]
8939
- }
8940
- },
8941
- "body_html": { "type": "string" },
8942
- "body_text": { "type": "string" },
8943
- "mentions_count": { "type": "integer" },
8944
- "reactions": {
8945
- "title": "Reaction Rollup",
8946
- "type": "object",
8947
- "properties": {
8948
- "url": { "type": "string", "format": "uri" },
8949
- "total_count": { "type": "integer" },
8950
- "+1": { "type": "integer" },
8951
- "-1": { "type": "integer" },
8952
- "laugh": { "type": "integer" },
8953
- "confused": { "type": "integer" },
8954
- "heart": { "type": "integer" },
8955
- "hooray": { "type": "integer" },
8956
- "eyes": { "type": "integer" },
8957
- "rocket": { "type": "integer" }
8958
- },
8959
- "required": [
8960
- "url",
8961
- "total_count",
8962
- "+1",
8963
- "-1",
8964
- "laugh",
8965
- "confused",
8966
- "heart",
8967
- "hooray",
8968
- "eyes",
8969
- "rocket"
8970
- ]
8971
- }
8972
- },
8973
- "required": [
8974
- "assets_url",
8975
- "upload_url",
8976
- "tarball_url",
8977
- "zipball_url",
8978
- "created_at",
8979
- "published_at",
8980
- "draft",
8981
- "id",
8982
- "node_id",
8983
- "author",
8984
- "html_url",
8985
- "name",
8986
- "prerelease",
8987
- "tag_name",
8988
- "target_commitish",
8989
- "assets",
8990
- "url"
8991
- ]
8992
- },
8993
- "examples": {
8994
- "default": {
8995
- "value": {
8996
- "url": "https://api.github.com/repos/octocat/Hello-World/releases/1",
8997
- "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0",
8998
- "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets",
8999
- "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}",
9000
- "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0",
9001
- "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0",
9002
- "discussion_url": "https://github.com/octocat/Hello-World/discussions/90",
9003
- "id": 1,
9004
- "node_id": "MDc6UmVsZWFzZTE=",
9005
- "tag_name": "v1.0.0",
9006
- "target_commitish": "master",
9007
- "name": "v1.0.0",
9008
- "body": "Description of the release",
9009
- "draft": false,
9010
- "prerelease": false,
9011
- "created_at": "2013-02-27T19:35:32Z",
9012
- "published_at": "2013-02-27T19:35:32Z",
9013
- "author": {
9014
- "login": "octocat",
9015
- "id": 1,
9016
- "node_id": "MDQ6VXNlcjE=",
9017
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
9018
- "gravatar_id": "",
9019
- "url": "https://api.github.com/users/octocat",
9020
- "html_url": "https://github.com/octocat",
9021
- "followers_url": "https://api.github.com/users/octocat/followers",
9022
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
9023
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
9024
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
9025
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
9026
- "organizations_url": "https://api.github.com/users/octocat/orgs",
9027
- "repos_url": "https://api.github.com/users/octocat/repos",
9028
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
9029
- "received_events_url": "https://api.github.com/users/octocat/received_events",
9030
- "type": "User",
9031
- "site_admin": false
9032
- },
9033
- "assets": [
9034
- {
9035
- "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1",
9036
- "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip",
9037
- "id": 1,
9038
- "node_id": "MDEyOlJlbGVhc2VBc3NldDE=",
9039
- "name": "example.zip",
9040
- "label": "short description",
9041
- "state": "uploaded",
9042
- "content_type": "application/zip",
9043
- "size": 1024,
9044
- "download_count": 42,
9045
- "created_at": "2013-02-27T19:35:32Z",
9046
- "updated_at": "2013-02-27T19:35:32Z",
9047
- "uploader": {
9048
- "login": "octocat",
9049
- "id": 1,
9050
- "node_id": "MDQ6VXNlcjE=",
9051
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
9052
- "gravatar_id": "",
9053
- "url": "https://api.github.com/users/octocat",
9054
- "html_url": "https://github.com/octocat",
9055
- "followers_url": "https://api.github.com/users/octocat/followers",
9056
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
9057
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
9058
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
9059
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
9060
- "organizations_url": "https://api.github.com/users/octocat/orgs",
9061
- "repos_url": "https://api.github.com/users/octocat/repos",
9062
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
9063
- "received_events_url": "https://api.github.com/users/octocat/received_events",
9064
- "type": "User",
9065
- "site_admin": false
9066
- }
9067
- }
9068
- ]
9069
- }
9070
- }
9071
- }
9072
- }
9073
- },
9074
- "headers": {
9075
- "Location": {
9076
- "example": "https://api.github.com/repos/octocat/Hello-World/releases/1",
9077
- "schema": { "type": "string" }
9078
- }
9079
- }
9080
- },
9081
- "422": {
9082
- "description": "Validation failed",
9083
- "content": {
9084
- "application/json": {
9085
- "schema": {
9086
- "title": "Validation Error",
9087
- "description": "Validation Error",
9088
- "type": "object",
9089
- "required": ["message", "documentation_url"],
9090
- "properties": {
9091
- "message": { "type": "string" },
9092
- "documentation_url": { "type": "string" },
9093
- "errors": {
9094
- "type": "array",
9095
- "items": {
9096
- "type": "object",
9097
- "required": ["code"],
9098
- "properties": {
9099
- "resource": { "type": "string" },
9100
- "field": { "type": "string" },
9101
- "message": { "type": "string" },
9102
- "code": { "type": "string" },
9103
- "index": { "type": "integer" },
9104
- "value": {
9105
- "oneOf": [
9106
- { "type": "string", "nullable": true },
9107
- { "type": "integer", "nullable": true },
9108
- {
9109
- "type": "array",
9110
- "nullable": true,
9111
- "items": { "type": "string" }
9112
- }
9113
- ]
9114
- }
9115
- }
9116
- }
9117
- }
9118
- }
9119
- }
9120
- }
9121
- }
9122
- }
9123
- },
9124
- "x-github": {
9125
- "triggersNotification": true,
9126
- "githubCloudOnly": false,
9127
- "enabledForGitHubApps": true,
9128
- "previews": [],
9129
- "category": "repos",
9130
- "subcategory": "releases"
9131
- },
9132
- "x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
9133
- }
9134
- },
9135
- "/repos/{owner}/{repo}/releases/latest": {
9136
- "get": {
9137
- "summary": "Get the latest release",
9138
- "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.",
9139
- "tags": ["repos"],
9140
- "operationId": "repos/get-latest-release",
9141
- "externalDocs": {
9142
- "description": "API method documentation",
9143
- "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-the-latest-release"
9144
- },
9145
- "parameters": [
9146
- {
9147
- "name": "owner",
9148
- "in": "path",
9149
- "required": true,
9150
- "schema": { "type": "string" }
9151
- },
9152
- {
9153
- "name": "repo",
9154
- "in": "path",
9155
- "required": true,
9156
- "schema": { "type": "string" }
9157
- }
9158
- ],
9159
- "responses": {
9160
- "200": {
9161
- "description": "Response",
9162
- "content": {
9163
- "application/json": {
9164
- "schema": {
9165
- "title": "Release",
9166
- "description": "A release.",
9167
- "type": "object",
9168
- "properties": {
9169
- "url": { "type": "string", "format": "uri" },
9170
- "html_url": { "type": "string", "format": "uri" },
9171
- "assets_url": { "type": "string", "format": "uri" },
9172
- "upload_url": { "type": "string" },
9173
- "tarball_url": {
9174
- "type": "string",
9175
- "format": "uri",
9176
- "nullable": true
9177
- },
9178
- "zipball_url": {
9179
- "type": "string",
9180
- "format": "uri",
9181
- "nullable": true
9182
- },
9183
- "id": { "type": "integer" },
9184
- "node_id": { "type": "string" },
9185
- "tag_name": {
9186
- "description": "The name of the tag.",
9187
- "example": "v1.0.0",
9188
- "type": "string"
9189
- },
9190
- "target_commitish": {
9191
- "description": "Specifies the commitish value that determines where the Git tag is created from.",
9192
- "example": "master",
9193
- "type": "string"
9194
- },
9195
- "name": { "type": "string", "nullable": true },
9196
- "body": { "type": "string", "nullable": true },
9197
- "draft": {
9198
- "description": "true to create a draft (unpublished) release, false to create a published one.",
9199
- "example": false,
9200
- "type": "boolean"
9201
- },
9202
- "prerelease": {
9203
- "description": "Whether to identify the release as a prerelease or a full release.",
9204
- "example": false,
9205
- "type": "boolean"
9206
- },
9207
- "created_at": { "type": "string", "format": "date-time" },
9208
- "published_at": {
9209
- "type": "string",
9210
- "format": "date-time",
9211
- "nullable": true
9212
- },
9213
- "author": {
9214
- "title": "Simple User",
9215
- "description": "Simple User",
9216
- "type": "object",
9217
- "properties": {
9218
- "name": { "nullable": true, "type": "string" },
9219
- "email": { "nullable": true, "type": "string" },
9220
- "login": { "type": "string", "example": "octocat" },
9221
- "id": { "type": "integer", "example": 1 },
9222
- "node_id": {
9223
- "type": "string",
9224
- "example": "MDQ6VXNlcjE="
9225
- },
9226
- "avatar_url": {
9227
- "type": "string",
9228
- "format": "uri",
9229
- "example": "https://github.com/images/error/octocat_happy.gif"
9230
- },
9231
- "gravatar_id": {
9232
- "type": "string",
9233
- "example": "41d064eb2195891e12d0413f63227ea7",
9234
- "nullable": true
9235
- },
9236
- "url": {
9237
- "type": "string",
9238
- "format": "uri",
9239
- "example": "https://api.github.com/users/octocat"
9240
- },
9241
- "html_url": {
9242
- "type": "string",
9243
- "format": "uri",
9244
- "example": "https://github.com/octocat"
9245
- },
9246
- "followers_url": {
9247
- "type": "string",
9248
- "format": "uri",
9249
- "example": "https://api.github.com/users/octocat/followers"
9250
- },
9251
- "following_url": {
9252
- "type": "string",
9253
- "example": "https://api.github.com/users/octocat/following{/other_user}"
9254
- },
9255
- "gists_url": {
9256
- "type": "string",
9257
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
9258
- },
9259
- "starred_url": {
9260
- "type": "string",
9261
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
9262
- },
9263
- "subscriptions_url": {
9264
- "type": "string",
9265
- "format": "uri",
9266
- "example": "https://api.github.com/users/octocat/subscriptions"
9267
- },
9268
- "organizations_url": {
9269
- "type": "string",
9270
- "format": "uri",
9271
- "example": "https://api.github.com/users/octocat/orgs"
9272
- },
9273
- "repos_url": {
9274
- "type": "string",
9275
- "format": "uri",
9276
- "example": "https://api.github.com/users/octocat/repos"
9277
- },
9278
- "events_url": {
9279
- "type": "string",
9280
- "example": "https://api.github.com/users/octocat/events{/privacy}"
9281
- },
9282
- "received_events_url": {
9283
- "type": "string",
9284
- "format": "uri",
9285
- "example": "https://api.github.com/users/octocat/received_events"
9286
- },
9287
- "type": { "type": "string", "example": "User" },
9288
- "site_admin": { "type": "boolean" },
9289
- "starred_at": {
9290
- "type": "string",
9291
- "example": "\"2020-07-09T00:17:55Z\""
9292
- }
9293
- },
9294
- "required": [
9295
- "avatar_url",
9296
- "events_url",
9297
- "followers_url",
9298
- "following_url",
9299
- "gists_url",
9300
- "gravatar_id",
9301
- "html_url",
9302
- "id",
9303
- "node_id",
9304
- "login",
9305
- "organizations_url",
9306
- "received_events_url",
9307
- "repos_url",
9308
- "site_admin",
9309
- "starred_url",
9310
- "subscriptions_url",
9311
- "type",
9312
- "url"
9313
- ]
9314
- },
9315
- "assets": {
9316
- "type": "array",
9317
- "items": {
9318
- "title": "Release Asset",
9319
- "description": "Data related to a release.",
9320
- "type": "object",
9321
- "properties": {
9322
- "url": { "type": "string", "format": "uri" },
9323
- "browser_download_url": {
9324
- "type": "string",
9325
- "format": "uri"
9326
- },
9327
- "id": { "type": "integer" },
9328
- "node_id": { "type": "string" },
9329
- "name": {
9330
- "description": "The file name of the asset.",
9331
- "type": "string",
9332
- "example": "Team Environment"
9333
- },
9334
- "label": { "type": "string", "nullable": true },
9335
- "state": {
9336
- "description": "State of the release asset.",
9337
- "type": "string",
9338
- "enum": ["uploaded", "open"]
9339
- },
9340
- "content_type": { "type": "string" },
9341
- "size": { "type": "integer" },
9342
- "download_count": { "type": "integer" },
9343
- "created_at": {
9344
- "type": "string",
9345
- "format": "date-time"
9346
- },
9347
- "updated_at": {
9348
- "type": "string",
9349
- "format": "date-time"
9350
- },
9351
- "uploader": {
9352
- "title": "Simple User",
9353
- "description": "Simple User",
9354
- "type": "object",
9355
- "properties": {
9356
- "name": { "nullable": true, "type": "string" },
9357
- "email": { "nullable": true, "type": "string" },
9358
- "login": {
9359
- "type": "string",
9360
- "example": "octocat"
9361
- },
9362
- "id": { "type": "integer", "example": 1 },
9363
- "node_id": {
9364
- "type": "string",
9365
- "example": "MDQ6VXNlcjE="
9366
- },
9367
- "avatar_url": {
9368
- "type": "string",
9369
- "format": "uri",
9370
- "example": "https://github.com/images/error/octocat_happy.gif"
9371
- },
9372
- "gravatar_id": {
9373
- "type": "string",
9374
- "example": "41d064eb2195891e12d0413f63227ea7",
9375
- "nullable": true
9376
- },
9377
- "url": {
9378
- "type": "string",
9379
- "format": "uri",
9380
- "example": "https://api.github.com/users/octocat"
9381
- },
9382
- "html_url": {
9383
- "type": "string",
9384
- "format": "uri",
9385
- "example": "https://github.com/octocat"
9386
- },
9387
- "followers_url": {
9388
- "type": "string",
9389
- "format": "uri",
9390
- "example": "https://api.github.com/users/octocat/followers"
9391
- },
9392
- "following_url": {
9393
- "type": "string",
9394
- "example": "https://api.github.com/users/octocat/following{/other_user}"
9395
- },
9396
- "gists_url": {
9397
- "type": "string",
9398
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
9399
- },
9400
- "starred_url": {
9401
- "type": "string",
9402
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
9403
- },
9404
- "subscriptions_url": {
9405
- "type": "string",
9406
- "format": "uri",
9407
- "example": "https://api.github.com/users/octocat/subscriptions"
9408
- },
9409
- "organizations_url": {
9410
- "type": "string",
9411
- "format": "uri",
9412
- "example": "https://api.github.com/users/octocat/orgs"
9413
- },
9414
- "repos_url": {
9415
- "type": "string",
9416
- "format": "uri",
9417
- "example": "https://api.github.com/users/octocat/repos"
9418
- },
9419
- "events_url": {
9420
- "type": "string",
9421
- "example": "https://api.github.com/users/octocat/events{/privacy}"
9422
- },
9423
- "received_events_url": {
9424
- "type": "string",
9425
- "format": "uri",
9426
- "example": "https://api.github.com/users/octocat/received_events"
9427
- },
9428
- "type": { "type": "string", "example": "User" },
9429
- "site_admin": { "type": "boolean" },
9430
- "starred_at": {
9431
- "type": "string",
9432
- "example": "\"2020-07-09T00:17:55Z\""
9433
- }
9434
- },
9435
- "required": [
9436
- "avatar_url",
9437
- "events_url",
9438
- "followers_url",
9439
- "following_url",
9440
- "gists_url",
9441
- "gravatar_id",
9442
- "html_url",
9443
- "id",
9444
- "node_id",
9445
- "login",
9446
- "organizations_url",
9447
- "received_events_url",
9448
- "repos_url",
9449
- "site_admin",
9450
- "starred_url",
9451
- "subscriptions_url",
9452
- "type",
9453
- "url"
9454
- ],
9455
- "nullable": true
9456
- }
9457
- },
9458
- "required": [
9459
- "id",
9460
- "name",
9461
- "content_type",
9462
- "size",
9463
- "state",
9464
- "url",
9465
- "node_id",
9466
- "download_count",
9467
- "label",
9468
- "uploader",
9469
- "browser_download_url",
9470
- "created_at",
9471
- "updated_at"
9472
- ]
9473
- }
9474
- },
9475
- "body_html": { "type": "string" },
9476
- "body_text": { "type": "string" },
9477
- "mentions_count": { "type": "integer" },
9478
- "reactions": {
9479
- "title": "Reaction Rollup",
9480
- "type": "object",
9481
- "properties": {
9482
- "url": { "type": "string", "format": "uri" },
9483
- "total_count": { "type": "integer" },
9484
- "+1": { "type": "integer" },
9485
- "-1": { "type": "integer" },
9486
- "laugh": { "type": "integer" },
9487
- "confused": { "type": "integer" },
9488
- "heart": { "type": "integer" },
9489
- "hooray": { "type": "integer" },
9490
- "eyes": { "type": "integer" },
9491
- "rocket": { "type": "integer" }
9492
- },
9493
- "required": [
9494
- "url",
9495
- "total_count",
9496
- "+1",
9497
- "-1",
9498
- "laugh",
9499
- "confused",
9500
- "heart",
9501
- "hooray",
9502
- "eyes",
9503
- "rocket"
9504
- ]
9505
- }
9506
- },
9507
- "required": [
9508
- "assets_url",
9509
- "upload_url",
9510
- "tarball_url",
9511
- "zipball_url",
9512
- "created_at",
9513
- "published_at",
9514
- "draft",
9515
- "id",
9516
- "node_id",
9517
- "author",
9518
- "html_url",
9519
- "name",
9520
- "prerelease",
9521
- "tag_name",
9522
- "target_commitish",
9523
- "assets",
9524
- "url"
9525
- ]
9526
- },
9527
- "examples": {
9528
- "default": {
9529
- "value": {
9530
- "url": "https://api.github.com/repos/octocat/Hello-World/releases/1",
9531
- "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0",
9532
- "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets",
9533
- "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}",
9534
- "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0",
9535
- "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0",
9536
- "discussion_url": "https://github.com/octocat/Hello-World/discussions/90",
9537
- "id": 1,
9538
- "node_id": "MDc6UmVsZWFzZTE=",
9539
- "tag_name": "v1.0.0",
9540
- "target_commitish": "master",
9541
- "name": "v1.0.0",
9542
- "body": "Description of the release",
9543
- "draft": false,
9544
- "prerelease": false,
9545
- "created_at": "2013-02-27T19:35:32Z",
9546
- "published_at": "2013-02-27T19:35:32Z",
9547
- "author": {
9548
- "login": "octocat",
7770
+ "url": "https://api.github.com/repos/octocat/Hello-World/releases/1",
7771
+ "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0",
7772
+ "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets",
7773
+ "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}",
7774
+ "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0",
7775
+ "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0",
9549
7776
  "id": 1,
9550
- "node_id": "MDQ6VXNlcjE=",
9551
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
9552
- "gravatar_id": "",
9553
- "url": "https://api.github.com/users/octocat",
9554
- "html_url": "https://github.com/octocat",
9555
- "followers_url": "https://api.github.com/users/octocat/followers",
9556
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
9557
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
9558
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
9559
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
9560
- "organizations_url": "https://api.github.com/users/octocat/orgs",
9561
- "repos_url": "https://api.github.com/users/octocat/repos",
9562
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
9563
- "received_events_url": "https://api.github.com/users/octocat/received_events",
9564
- "type": "User",
9565
- "site_admin": false
9566
- },
9567
- "assets": [
9568
- {
9569
- "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1",
9570
- "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip",
7777
+ "node_id": "MDc6UmVsZWFzZTE=",
7778
+ "tag_name": "v1.0.0",
7779
+ "target_commitish": "master",
7780
+ "name": "v1.0.0",
7781
+ "body": "Description of the release",
7782
+ "draft": false,
7783
+ "prerelease": false,
7784
+ "created_at": "2013-02-27T19:35:32Z",
7785
+ "published_at": "2013-02-27T19:35:32Z",
7786
+ "author": {
7787
+ "login": "octocat",
9571
7788
  "id": 1,
9572
- "node_id": "MDEyOlJlbGVhc2VBc3NldDE=",
9573
- "name": "example.zip",
9574
- "label": "short description",
9575
- "state": "uploaded",
9576
- "content_type": "application/zip",
9577
- "size": 1024,
9578
- "download_count": 42,
9579
- "created_at": "2013-02-27T19:35:32Z",
9580
- "updated_at": "2013-02-27T19:35:32Z",
9581
- "uploader": {
9582
- "login": "octocat",
7789
+ "node_id": "MDQ6VXNlcjE=",
7790
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
7791
+ "gravatar_id": "",
7792
+ "url": "https://api.github.com/users/octocat",
7793
+ "html_url": "https://github.com/octocat",
7794
+ "followers_url": "https://api.github.com/users/octocat/followers",
7795
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
7796
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
7797
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
7798
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
7799
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
7800
+ "repos_url": "https://api.github.com/users/octocat/repos",
7801
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
7802
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
7803
+ "type": "User",
7804
+ "site_admin": false
7805
+ },
7806
+ "assets": [
7807
+ {
7808
+ "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1",
7809
+ "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip",
9583
7810
  "id": 1,
9584
- "node_id": "MDQ6VXNlcjE=",
9585
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
9586
- "gravatar_id": "",
9587
- "url": "https://api.github.com/users/octocat",
9588
- "html_url": "https://github.com/octocat",
9589
- "followers_url": "https://api.github.com/users/octocat/followers",
9590
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
9591
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
9592
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
9593
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
9594
- "organizations_url": "https://api.github.com/users/octocat/orgs",
9595
- "repos_url": "https://api.github.com/users/octocat/repos",
9596
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
9597
- "received_events_url": "https://api.github.com/users/octocat/received_events",
9598
- "type": "User",
9599
- "site_admin": false
7811
+ "node_id": "MDEyOlJlbGVhc2VBc3NldDE=",
7812
+ "name": "example.zip",
7813
+ "label": "short description",
7814
+ "state": "uploaded",
7815
+ "content_type": "application/zip",
7816
+ "size": 1024,
7817
+ "download_count": 42,
7818
+ "created_at": "2013-02-27T19:35:32Z",
7819
+ "updated_at": "2013-02-27T19:35:32Z",
7820
+ "uploader": {
7821
+ "login": "octocat",
7822
+ "id": 1,
7823
+ "node_id": "MDQ6VXNlcjE=",
7824
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
7825
+ "gravatar_id": "",
7826
+ "url": "https://api.github.com/users/octocat",
7827
+ "html_url": "https://github.com/octocat",
7828
+ "followers_url": "https://api.github.com/users/octocat/followers",
7829
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
7830
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
7831
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
7832
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
7833
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
7834
+ "repos_url": "https://api.github.com/users/octocat/repos",
7835
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
7836
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
7837
+ "type": "User",
7838
+ "site_admin": false
7839
+ }
9600
7840
  }
9601
- }
9602
- ]
9603
- }
7841
+ ]
7842
+ }
7843
+ ]
7844
+ }
7845
+ }
7846
+ }
7847
+ },
7848
+ "headers": {
7849
+ "Link": {
7850
+ "example": "<https://api.github.com/resource?page=2>; rel=\"next\", <https://api.github.com/resource?page=5>; rel=\"last\"",
7851
+ "schema": { "type": "string" }
7852
+ }
7853
+ }
7854
+ },
7855
+ "404": {
7856
+ "description": "Resource not found",
7857
+ "content": {
7858
+ "application/json": {
7859
+ "schema": {
7860
+ "title": "Basic Error",
7861
+ "description": "Basic Error",
7862
+ "type": "object",
7863
+ "properties": {
7864
+ "message": { "type": "string" },
7865
+ "documentation_url": { "type": "string" },
7866
+ "url": { "type": "string" },
7867
+ "status": { "type": "string" }
9604
7868
  }
9605
7869
  }
9606
7870
  }
@@ -9617,15 +7881,15 @@
9617
7881
  "x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
9618
7882
  }
9619
7883
  },
9620
- "/repos/{owner}/{repo}/releases/tags/{tag}": {
7884
+ "/repos/{owner}/{repo}/releases/latest": {
9621
7885
  "get": {
9622
- "summary": "Get a release by tag name",
9623
- "description": "Get a published release with the specified tag.",
7886
+ "summary": "Get the latest release",
7887
+ "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.",
9624
7888
  "tags": ["repos"],
9625
- "operationId": "repos/get-release-by-tag",
7889
+ "operationId": "repos/get-latest-release",
9626
7890
  "externalDocs": {
9627
7891
  "description": "API method documentation",
9628
- "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-a-release-by-tag-name"
7892
+ "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-the-latest-release"
9629
7893
  },
9630
7894
  "parameters": [
9631
7895
  {
@@ -9639,14 +7903,6 @@
9639
7903
  "in": "path",
9640
7904
  "required": true,
9641
7905
  "schema": { "type": "string" }
9642
- },
9643
- {
9644
- "name": "tag",
9645
- "description": "tag parameter",
9646
- "in": "path",
9647
- "required": true,
9648
- "schema": { "type": "string" },
9649
- "x-multi-segment": true
9650
7906
  }
9651
7907
  ],
9652
7908
  "responses": {
@@ -10098,24 +8354,6 @@
10098
8354
  }
10099
8355
  }
10100
8356
  }
10101
- },
10102
- "404": {
10103
- "description": "Resource not found",
10104
- "content": {
10105
- "application/json": {
10106
- "schema": {
10107
- "title": "Basic Error",
10108
- "description": "Basic Error",
10109
- "type": "object",
10110
- "properties": {
10111
- "message": { "type": "string" },
10112
- "documentation_url": { "type": "string" },
10113
- "url": { "type": "string" },
10114
- "status": { "type": "string" }
10115
- }
10116
- }
10117
- }
10118
- }
10119
8357
  }
10120
8358
  },
10121
8359
  "x-github": {
@@ -10128,15 +8366,15 @@
10128
8366
  "x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
10129
8367
  }
10130
8368
  },
10131
- "/repos/{owner}/{repo}/releases/{release_id}": {
8369
+ "/repos/{owner}/{repo}/releases/tags/{tag}": {
10132
8370
  "get": {
10133
- "summary": "Get a release",
10134
- "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).",
8371
+ "summary": "Get a release by tag name",
8372
+ "description": "Get a published release with the specified tag.",
10135
8373
  "tags": ["repos"],
10136
- "operationId": "repos/get-release",
8374
+ "operationId": "repos/get-release-by-tag",
10137
8375
  "externalDocs": {
10138
8376
  "description": "API method documentation",
10139
- "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-a-release"
8377
+ "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-a-release-by-tag-name"
10140
8378
  },
10141
8379
  "parameters": [
10142
8380
  {
@@ -10152,16 +8390,17 @@
10152
8390
  "schema": { "type": "string" }
10153
8391
  },
10154
8392
  {
10155
- "name": "release_id",
10156
- "description": "release_id parameter",
8393
+ "name": "tag",
8394
+ "description": "tag parameter",
10157
8395
  "in": "path",
10158
8396
  "required": true,
10159
- "schema": { "type": "integer" }
8397
+ "schema": { "type": "string" },
8398
+ "x-multi-segment": true
10160
8399
  }
10161
8400
  ],
10162
8401
  "responses": {
10163
8402
  "200": {
10164
- "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).",
8403
+ "description": "Response",
10165
8404
  "content": {
10166
8405
  "application/json": {
10167
8406
  "schema": {
@@ -10636,15 +8875,17 @@
10636
8875
  "subcategory": "releases"
10637
8876
  },
10638
8877
  "x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
10639
- },
10640
- "patch": {
10641
- "summary": "Update a release",
10642
- "description": "Users with push access to the repository can edit a release.",
8878
+ }
8879
+ },
8880
+ "/repos/{owner}/{repo}/releases/{release_id}": {
8881
+ "get": {
8882
+ "summary": "Get a release",
8883
+ "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).",
10643
8884
  "tags": ["repos"],
10644
- "operationId": "repos/update-release",
8885
+ "operationId": "repos/get-release",
10645
8886
  "externalDocs": {
10646
8887
  "description": "API method documentation",
10647
- "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#update-a-release"
8888
+ "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-a-release"
10648
8889
  },
10649
8890
  "parameters": [
10650
8891
  {
@@ -10667,52 +8908,9 @@
10667
8908
  "schema": { "type": "integer" }
10668
8909
  }
10669
8910
  ],
10670
- "requestBody": {
10671
- "content": {
10672
- "application/json": {
10673
- "schema": {
10674
- "type": "object",
10675
- "properties": {
10676
- "tag_name": {
10677
- "type": "string",
10678
- "description": "The name of the tag."
10679
- },
10680
- "target_commitish": {
10681
- "type": "string",
10682
- "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`)."
10683
- },
10684
- "name": {
10685
- "type": "string",
10686
- "description": "The name of the release."
10687
- },
10688
- "body": {
10689
- "type": "string",
10690
- "description": "Text describing the contents of the tag."
10691
- },
10692
- "draft": {
10693
- "type": "boolean",
10694
- "description": "`true` makes the release a draft, and `false` publishes the release."
10695
- },
10696
- "prerelease": {
10697
- "type": "boolean",
10698
- "description": "`true` to identify the release as a prerelease, `false` to identify the release as a full release."
10699
- }
10700
- }
10701
- },
10702
- "example": {
10703
- "tag_name": "v1.0.0",
10704
- "target_commitish": "master",
10705
- "name": "v1.0.0",
10706
- "body": "Description of the release",
10707
- "draft": false,
10708
- "prerelease": false
10709
- }
10710
- }
10711
- }
10712
- },
10713
8911
  "responses": {
10714
8912
  "200": {
10715
- "description": "Response",
8913
+ "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).",
10716
8914
  "content": {
10717
8915
  "application/json": {
10718
8916
  "schema": {
@@ -11159,6 +9357,24 @@
11159
9357
  }
11160
9358
  }
11161
9359
  }
9360
+ },
9361
+ "404": {
9362
+ "description": "Resource not found",
9363
+ "content": {
9364
+ "application/json": {
9365
+ "schema": {
9366
+ "title": "Basic Error",
9367
+ "description": "Basic Error",
9368
+ "type": "object",
9369
+ "properties": {
9370
+ "message": { "type": "string" },
9371
+ "documentation_url": { "type": "string" },
9372
+ "url": { "type": "string" },
9373
+ "status": { "type": "string" }
9374
+ }
9375
+ }
9376
+ }
9377
+ }
11162
9378
  }
11163
9379
  },
11164
9380
  "x-github": {