@octokit/openapi 7.5.0 → 7.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (34) hide show
  1. package/generated/api.github.com.deref.json +466 -140
  2. package/generated/api.github.com.json +607 -28
  3. package/generated/ghes-3.2-diff-to-api.github.com.deref.json +1 -1
  4. package/generated/ghes-3.2-diff-to-api.github.com.json +1 -1
  5. package/generated/ghes-3.2-diff-to-ghes-3.3.deref.json +31 -25
  6. package/generated/ghes-3.2-diff-to-ghes-3.3.json +25 -14
  7. package/generated/ghes-3.2.deref.json +319 -242
  8. package/generated/ghes-3.2.json +558 -26
  9. package/generated/ghes-3.3-anicca-diff-to-ghes-3.4.deref.json +0 -16
  10. package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json +187 -223
  11. package/generated/ghes-3.3-diff-to-ghes-3.4.json +432 -10
  12. package/generated/ghes-3.3.deref.json +319 -242
  13. package/generated/ghes-3.3.json +558 -26
  14. package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json +9 -1
  15. package/generated/ghes-3.4-diff-to-ghes-3.5.json +9 -1
  16. package/generated/ghes-3.4.deref.json +322 -228
  17. package/generated/ghes-3.4.json +566 -28
  18. package/generated/ghes-3.5-diff-to-api.github.com.deref.json +1 -1
  19. package/generated/ghes-3.5-diff-to-api.github.com.json +1 -1
  20. package/generated/ghes-3.5-diff-to-ghes-3.6.deref.json +45 -39
  21. package/generated/ghes-3.5-diff-to-ghes-3.6.json +283 -15
  22. package/generated/ghes-3.5.deref.json +322 -228
  23. package/generated/ghes-3.5.json +566 -28
  24. package/generated/ghes-3.6-anicca-diff-to-api.github.com.deref.json +433 -88
  25. package/generated/ghes-3.6-diff-to-api.github.com.deref.json +17464 -6423
  26. package/generated/ghes-3.6-diff-to-api.github.com.json +4502 -2247
  27. package/generated/ghes-3.6.deref.json +406 -240
  28. package/generated/ghes-3.6.json +654 -40
  29. package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +318 -32
  30. package/generated/github.ae-diff-to-api.github.com.deref.json +15845 -8423
  31. package/generated/github.ae-diff-to-api.github.com.json +1168 -44
  32. package/generated/github.ae.deref.json +409 -163
  33. package/generated/github.ae.json +646 -35
  34. package/package.json +1 -1
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "7.5.0",
4
+ "version": "7.6.0",
5
5
  "title": "GitHub's official OpenAPI spec + Octokit extension",
6
6
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
7
7
  "license": {
@@ -6926,7 +6926,7 @@
6926
6926
  "/organizations/{organization_id}/custom_roles": {
6927
6927
  "get": {
6928
6928
  "summary": "List custom repository roles in an organization",
6929
- "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".",
6929
+ "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nTo use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope.\nGitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".",
6930
6930
  "tags": [
6931
6931
  "orgs"
6932
6932
  ],
@@ -23513,6 +23513,11 @@
23513
23513
  "application/json": {
23514
23514
  "schema": {
23515
23515
  "$ref": "#/components/schemas/branch-with-protection"
23516
+ },
23517
+ "examples": {
23518
+ "default": {
23519
+ "$ref": "#/components/examples/branch-get"
23520
+ }
23516
23521
  }
23517
23522
  }
23518
23523
  }
@@ -23855,6 +23860,11 @@
23855
23860
  "application/json": {
23856
23861
  "schema": {
23857
23862
  "$ref": "#/components/schemas/protected-branch"
23863
+ },
23864
+ "examples": {
23865
+ "default": {
23866
+ "$ref": "#/components/examples/branch-protection-update"
23867
+ }
23858
23868
  }
23859
23869
  }
23860
23870
  }
@@ -24729,7 +24739,7 @@
24729
24739
  "properties": {
24730
24740
  "contexts": {
24731
24741
  "type": "array",
24732
- "description": "contexts parameter",
24742
+ "description": "The name of the status checks",
24733
24743
  "items": {
24734
24744
  "type": "string"
24735
24745
  }
@@ -24745,6 +24755,17 @@
24745
24755
  }
24746
24756
  }
24747
24757
  ]
24758
+ },
24759
+ "examples": {
24760
+ "default": {
24761
+ "summary": "Example adding status checks to a branch protection rule",
24762
+ "value": {
24763
+ "contexts": [
24764
+ "continuous-integration/travis-ci",
24765
+ "continuous-integration/jenkins"
24766
+ ]
24767
+ }
24768
+ }
24748
24769
  }
24749
24770
  }
24750
24771
  }
@@ -24823,7 +24844,7 @@
24823
24844
  "properties": {
24824
24845
  "contexts": {
24825
24846
  "type": "array",
24826
- "description": "contexts parameter",
24847
+ "description": "The name of the status checks",
24827
24848
  "items": {
24828
24849
  "type": "string"
24829
24850
  }
@@ -24839,6 +24860,16 @@
24839
24860
  }
24840
24861
  }
24841
24862
  ]
24863
+ },
24864
+ "examples": {
24865
+ "default": {
24866
+ "summary": "Example updating status checks for a branch protection rule",
24867
+ "value": {
24868
+ "contexts": [
24869
+ "continuous-integration/travis-ci"
24870
+ ]
24871
+ }
24872
+ }
24842
24873
  }
24843
24874
  }
24844
24875
  }
@@ -24912,7 +24943,7 @@
24912
24943
  "properties": {
24913
24944
  "contexts": {
24914
24945
  "type": "array",
24915
- "description": "contexts parameter",
24946
+ "description": "The name of the status checks",
24916
24947
  "items": {
24917
24948
  "type": "string"
24918
24949
  }
@@ -24928,6 +24959,16 @@
24928
24959
  }
24929
24960
  }
24930
24961
  ]
24962
+ },
24963
+ "examples": {
24964
+ "default": {
24965
+ "summary": "Example removing status checks from a branch protection rule",
24966
+ "value": {
24967
+ "contexts": [
24968
+ "continuous-integration/travis-ci"
24969
+ ]
24970
+ }
24971
+ }
24931
24972
  }
24932
24973
  }
24933
24974
  }
@@ -25453,7 +25494,7 @@
25453
25494
  "properties": {
25454
25495
  "teams": {
25455
25496
  "type": "array",
25456
- "description": "teams parameter",
25497
+ "description": "The slug values for teams",
25457
25498
  "items": {
25458
25499
  "type": "string"
25459
25500
  }
@@ -25469,6 +25510,16 @@
25469
25510
  }
25470
25511
  }
25471
25512
  ]
25513
+ },
25514
+ "examples": {
25515
+ "default": {
25516
+ "summary": "Example adding a team in a branch protection rule",
25517
+ "value": {
25518
+ "teams": [
25519
+ "justice-league"
25520
+ ]
25521
+ }
25522
+ }
25472
25523
  }
25473
25524
  }
25474
25525
  }
@@ -25538,7 +25589,7 @@
25538
25589
  "properties": {
25539
25590
  "teams": {
25540
25591
  "type": "array",
25541
- "description": "teams parameter",
25592
+ "description": "The slug values for teams",
25542
25593
  "items": {
25543
25594
  "type": "string"
25544
25595
  }
@@ -25549,11 +25600,21 @@
25549
25600
  ],
25550
25601
  "example": {
25551
25602
  "teams": [
25552
- "my-team"
25603
+ "justice-league"
25553
25604
  ]
25554
25605
  }
25555
25606
  }
25556
25607
  ]
25608
+ },
25609
+ "examples": {
25610
+ "default": {
25611
+ "summary": "Example replacing a team in a branch protection rule",
25612
+ "value": {
25613
+ "teams": [
25614
+ "justice-league"
25615
+ ]
25616
+ }
25617
+ }
25557
25618
  }
25558
25619
  }
25559
25620
  }
@@ -25622,7 +25683,7 @@
25622
25683
  "properties": {
25623
25684
  "teams": {
25624
25685
  "type": "array",
25625
- "description": "teams parameter",
25686
+ "description": "The slug values for teams",
25626
25687
  "items": {
25627
25688
  "type": "string"
25628
25689
  }
@@ -25638,6 +25699,16 @@
25638
25699
  }
25639
25700
  }
25640
25701
  ]
25702
+ },
25703
+ "examples": {
25704
+ "default": {
25705
+ "summary": "Example removing a team in a branch protection rule",
25706
+ "value": {
25707
+ "teams": [
25708
+ "justice-league"
25709
+ ]
25710
+ }
25711
+ }
25641
25712
  }
25642
25713
  }
25643
25714
  }
@@ -25762,7 +25833,7 @@
25762
25833
  "properties": {
25763
25834
  "users": {
25764
25835
  "type": "array",
25765
- "description": "users parameter",
25836
+ "description": "The username for users",
25766
25837
  "items": {
25767
25838
  "type": "string"
25768
25839
  }
@@ -25778,6 +25849,16 @@
25778
25849
  }
25779
25850
  }
25780
25851
  ]
25852
+ },
25853
+ "examples": {
25854
+ "default": {
25855
+ "summary": "Example adding a user in a branch protection rule",
25856
+ "value": {
25857
+ "users": [
25858
+ "octocat"
25859
+ ]
25860
+ }
25861
+ }
25781
25862
  }
25782
25863
  }
25783
25864
  }
@@ -25847,7 +25928,7 @@
25847
25928
  "properties": {
25848
25929
  "users": {
25849
25930
  "type": "array",
25850
- "description": "users parameter",
25931
+ "description": "The username for users",
25851
25932
  "items": {
25852
25933
  "type": "string"
25853
25934
  }
@@ -25863,6 +25944,16 @@
25863
25944
  }
25864
25945
  }
25865
25946
  ]
25947
+ },
25948
+ "examples": {
25949
+ "default": {
25950
+ "summary": "Example replacing a user in a branch protection rule",
25951
+ "value": {
25952
+ "users": [
25953
+ "octocat"
25954
+ ]
25955
+ }
25956
+ }
25866
25957
  }
25867
25958
  }
25868
25959
  }
@@ -25931,7 +26022,7 @@
25931
26022
  "properties": {
25932
26023
  "users": {
25933
26024
  "type": "array",
25934
- "description": "users parameter",
26025
+ "description": "The username for users",
25935
26026
  "items": {
25936
26027
  "type": "string"
25937
26028
  }
@@ -25947,6 +26038,16 @@
25947
26038
  }
25948
26039
  }
25949
26040
  ]
26041
+ },
26042
+ "examples": {
26043
+ "default": {
26044
+ "summary": "Example removing a user in a branch protection rule",
26045
+ "value": {
26046
+ "users": [
26047
+ "octocat"
26048
+ ]
26049
+ }
26050
+ }
25950
26051
  }
25951
26052
  }
25952
26053
  }
@@ -27662,6 +27763,22 @@
27662
27763
  "schema": {
27663
27764
  "$ref": "#/components/schemas/code-scanning-analysis-sarif-id"
27664
27765
  }
27766
+ },
27767
+ {
27768
+ "$ref": "#/components/parameters/direction"
27769
+ },
27770
+ {
27771
+ "name": "sort",
27772
+ "description": "The property by which to sort the results.",
27773
+ "in": "query",
27774
+ "required": false,
27775
+ "schema": {
27776
+ "type": "string",
27777
+ "enum": [
27778
+ "created"
27779
+ ],
27780
+ "default": "created"
27781
+ }
27665
27782
  }
27666
27783
  ],
27667
27784
  "responses": {
@@ -27776,7 +27893,7 @@
27776
27893
  },
27777
27894
  "delete": {
27778
27895
  "summary": "Delete a code scanning analysis from a repository",
27779
- "description": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the `repo` scope. For public repositories,\nyou must use an access token with `public_repo` scope.\nGitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `analysis_key`\n* `environment`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\n`next_analysis_url` and `confirm_delete_url`.\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n **Inner loop**:\n * Delete the identified analysis.\n * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.",
27896
+ "description": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the `repo` scope. For public repositories,\nyou must use an access token with `public_repo` scope.\nGitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `category`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\n`next_analysis_url` and `confirm_delete_url`.\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n **Inner loop**:\n * Delete the identified analysis.\n * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.",
27780
27897
  "operationId": "code-scanning/delete-analysis",
27781
27898
  "tags": [
27782
27899
  "code-scanning"
@@ -30505,7 +30622,7 @@
30505
30622
  "/repos/{owner}/{repo}/contents/{path}": {
30506
30623
  "get": {
30507
30624
  "summary": "Get repository content",
30508
- "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit\n`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. \n\nFiles and symlinks support [a custom media type](https://docs.github.com/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Note**:\n* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/reference/git#trees).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/rest/reference/git#get-a-tree).\n\n#### Size limits\nIf the requested file's size is:\n* 1 MB or smaller: All features of this endpoint are supported.\n* Between 1-100 MB: Only the `raw` or `object` [custom media types](https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents) are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty string and the `encoding` field will be `\"none\"`. To get the contents of these larger files, use the `raw` media type.\n * Greater than 100 MB: This endpoint is not supported.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.",
30625
+ "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit\n`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. \n\nFiles and symlinks support [a custom media type](https://docs.github.com/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Notes**:\n* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/reference/git#trees).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/rest/reference/git#get-a-tree).\n * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\n#### Size limits\nIf the requested file's size is:\n* 1 MB or smaller: All features of this endpoint are supported.\n* Between 1-100 MB: Only the `raw` or `object` [custom media types](https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents) are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty string and the `encoding` field will be `\"none\"`. To get the contents of these larger files, use the `raw` media type.\n * Greater than 100 MB: This endpoint is not supported.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.",
30509
30626
  "tags": [
30510
30627
  "repos"
30511
30628
  ],
@@ -32857,6 +32974,10 @@
32857
32974
  "name": {
32858
32975
  "type": "string",
32859
32976
  "description": "When forking from an existing repository, a new name for the fork."
32977
+ },
32978
+ "default_branch_only": {
32979
+ "type": "boolean",
32980
+ "description": "When forking from an existing repository, fork with only the default branch."
32860
32981
  }
32861
32982
  }
32862
32983
  }
@@ -35522,6 +35643,15 @@
35522
35643
  "application/json": {
35523
35644
  "schema": {
35524
35645
  "$ref": "#/components/schemas/interaction-limit"
35646
+ },
35647
+ "examples": {
35648
+ "default": {
35649
+ "summary": "Example request body",
35650
+ "value": {
35651
+ "limit": "collaborators_only",
35652
+ "expiry": "one_day"
35653
+ }
35654
+ }
35525
35655
  }
35526
35656
  }
35527
35657
  }
@@ -35692,6 +35822,14 @@
35692
35822
  ]
35693
35823
  }
35694
35824
  }
35825
+ },
35826
+ "examples": {
35827
+ "default": {
35828
+ "summary": "Example request body",
35829
+ "value": {
35830
+ "permissions": "write"
35831
+ }
35832
+ }
35695
35833
  }
35696
35834
  }
35697
35835
  }
@@ -36787,6 +36925,12 @@
36787
36925
  "closed"
36788
36926
  ]
36789
36927
  },
36928
+ "state_reason": {
36929
+ "type": "string",
36930
+ "nullable": true,
36931
+ "description": "The reason for the current state",
36932
+ "example": "not_planned"
36933
+ },
36790
36934
  "milestone": {
36791
36935
  "oneOf": [
36792
36936
  {
@@ -59971,14 +60115,6 @@
59971
60115
  "write"
59972
60116
  ]
59973
60117
  },
59974
- "organization_custom_roles": {
59975
- "type": "string",
59976
- "description": "The level of permission to grant the access token for custom roles management.",
59977
- "enum": [
59978
- "read",
59979
- "write"
59980
- ]
59981
- },
59982
60118
  "deployments": {
59983
60119
  "type": "string",
59984
60120
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -60123,6 +60259,14 @@
60123
60259
  "write"
60124
60260
  ]
60125
60261
  },
60262
+ "organization_custom_roles": {
60263
+ "type": "string",
60264
+ "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.",
60265
+ "enum": [
60266
+ "read",
60267
+ "write"
60268
+ ]
60269
+ },
60126
60270
  "organization_hooks": {
60127
60271
  "type": "string",
60128
60272
  "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.",
@@ -69249,6 +69393,267 @@
69249
69393
  }
69250
69394
  }
69251
69395
  },
69396
+ "team-organization": {
69397
+ "title": "Team Organization",
69398
+ "description": "Team Organization",
69399
+ "type": "object",
69400
+ "properties": {
69401
+ "login": {
69402
+ "type": "string",
69403
+ "example": "github"
69404
+ },
69405
+ "id": {
69406
+ "type": "integer",
69407
+ "example": 1
69408
+ },
69409
+ "node_id": {
69410
+ "type": "string",
69411
+ "example": "MDEyOk9yZ2FuaXphdGlvbjE="
69412
+ },
69413
+ "url": {
69414
+ "type": "string",
69415
+ "format": "uri",
69416
+ "example": "https://api.github.com/orgs/github"
69417
+ },
69418
+ "repos_url": {
69419
+ "type": "string",
69420
+ "format": "uri",
69421
+ "example": "https://api.github.com/orgs/github/repos"
69422
+ },
69423
+ "events_url": {
69424
+ "type": "string",
69425
+ "format": "uri",
69426
+ "example": "https://api.github.com/orgs/github/events"
69427
+ },
69428
+ "hooks_url": {
69429
+ "type": "string",
69430
+ "example": "https://api.github.com/orgs/github/hooks"
69431
+ },
69432
+ "issues_url": {
69433
+ "type": "string",
69434
+ "example": "https://api.github.com/orgs/github/issues"
69435
+ },
69436
+ "members_url": {
69437
+ "type": "string",
69438
+ "example": "https://api.github.com/orgs/github/members{/member}"
69439
+ },
69440
+ "public_members_url": {
69441
+ "type": "string",
69442
+ "example": "https://api.github.com/orgs/github/public_members{/member}"
69443
+ },
69444
+ "avatar_url": {
69445
+ "type": "string",
69446
+ "example": "https://github.com/images/error/octocat_happy.gif"
69447
+ },
69448
+ "description": {
69449
+ "type": "string",
69450
+ "example": "A great organization",
69451
+ "nullable": true
69452
+ },
69453
+ "name": {
69454
+ "type": "string",
69455
+ "example": "github"
69456
+ },
69457
+ "company": {
69458
+ "type": "string",
69459
+ "example": "GitHub"
69460
+ },
69461
+ "blog": {
69462
+ "type": "string",
69463
+ "format": "uri",
69464
+ "example": "https://github.com/blog"
69465
+ },
69466
+ "location": {
69467
+ "type": "string",
69468
+ "example": "San Francisco"
69469
+ },
69470
+ "email": {
69471
+ "type": "string",
69472
+ "format": "email",
69473
+ "example": "octocat@github.com"
69474
+ },
69475
+ "twitter_username": {
69476
+ "type": "string",
69477
+ "example": "github",
69478
+ "nullable": true
69479
+ },
69480
+ "is_verified": {
69481
+ "type": "boolean",
69482
+ "example": true
69483
+ },
69484
+ "has_organization_projects": {
69485
+ "type": "boolean",
69486
+ "example": true
69487
+ },
69488
+ "has_repository_projects": {
69489
+ "type": "boolean",
69490
+ "example": true
69491
+ },
69492
+ "public_repos": {
69493
+ "type": "integer",
69494
+ "example": 2
69495
+ },
69496
+ "public_gists": {
69497
+ "type": "integer",
69498
+ "example": 1
69499
+ },
69500
+ "followers": {
69501
+ "type": "integer",
69502
+ "example": 20
69503
+ },
69504
+ "following": {
69505
+ "type": "integer",
69506
+ "example": 0
69507
+ },
69508
+ "html_url": {
69509
+ "type": "string",
69510
+ "format": "uri",
69511
+ "example": "https://github.com/octocat"
69512
+ },
69513
+ "created_at": {
69514
+ "type": "string",
69515
+ "format": "date-time",
69516
+ "example": "2008-01-14T04:33:35Z"
69517
+ },
69518
+ "type": {
69519
+ "type": "string",
69520
+ "example": "Organization"
69521
+ },
69522
+ "total_private_repos": {
69523
+ "type": "integer",
69524
+ "example": 100
69525
+ },
69526
+ "owned_private_repos": {
69527
+ "type": "integer",
69528
+ "example": 100
69529
+ },
69530
+ "private_gists": {
69531
+ "type": "integer",
69532
+ "example": 81,
69533
+ "nullable": true
69534
+ },
69535
+ "disk_usage": {
69536
+ "type": "integer",
69537
+ "example": 10000,
69538
+ "nullable": true
69539
+ },
69540
+ "collaborators": {
69541
+ "type": "integer",
69542
+ "example": 8,
69543
+ "nullable": true
69544
+ },
69545
+ "billing_email": {
69546
+ "type": "string",
69547
+ "format": "email",
69548
+ "example": "org@example.com",
69549
+ "nullable": true
69550
+ },
69551
+ "plan": {
69552
+ "type": "object",
69553
+ "properties": {
69554
+ "name": {
69555
+ "type": "string"
69556
+ },
69557
+ "space": {
69558
+ "type": "integer"
69559
+ },
69560
+ "private_repos": {
69561
+ "type": "integer"
69562
+ },
69563
+ "filled_seats": {
69564
+ "type": "integer"
69565
+ },
69566
+ "seats": {
69567
+ "type": "integer"
69568
+ }
69569
+ },
69570
+ "required": [
69571
+ "name",
69572
+ "space",
69573
+ "private_repos"
69574
+ ]
69575
+ },
69576
+ "default_repository_permission": {
69577
+ "type": "string",
69578
+ "nullable": true
69579
+ },
69580
+ "members_can_create_repositories": {
69581
+ "type": "boolean",
69582
+ "example": true,
69583
+ "nullable": true
69584
+ },
69585
+ "two_factor_requirement_enabled": {
69586
+ "type": "boolean",
69587
+ "example": true,
69588
+ "nullable": true
69589
+ },
69590
+ "members_allowed_repository_creation_type": {
69591
+ "type": "string",
69592
+ "example": "all"
69593
+ },
69594
+ "members_can_create_public_repositories": {
69595
+ "type": "boolean",
69596
+ "example": true
69597
+ },
69598
+ "members_can_create_private_repositories": {
69599
+ "type": "boolean",
69600
+ "example": true
69601
+ },
69602
+ "members_can_create_internal_repositories": {
69603
+ "type": "boolean",
69604
+ "example": true
69605
+ },
69606
+ "members_can_create_pages": {
69607
+ "type": "boolean",
69608
+ "example": true
69609
+ },
69610
+ "members_can_create_public_pages": {
69611
+ "type": "boolean",
69612
+ "example": true
69613
+ },
69614
+ "members_can_create_private_pages": {
69615
+ "type": "boolean",
69616
+ "example": true
69617
+ },
69618
+ "members_can_fork_private_repositories": {
69619
+ "type": "boolean",
69620
+ "example": false,
69621
+ "nullable": true
69622
+ },
69623
+ "web_commit_signoff_required": {
69624
+ "type": "boolean",
69625
+ "example": false
69626
+ },
69627
+ "updated_at": {
69628
+ "type": "string",
69629
+ "format": "date-time"
69630
+ }
69631
+ },
69632
+ "required": [
69633
+ "login",
69634
+ "url",
69635
+ "id",
69636
+ "node_id",
69637
+ "repos_url",
69638
+ "events_url",
69639
+ "hooks_url",
69640
+ "issues_url",
69641
+ "members_url",
69642
+ "public_members_url",
69643
+ "avatar_url",
69644
+ "description",
69645
+ "html_url",
69646
+ "has_organization_projects",
69647
+ "has_repository_projects",
69648
+ "public_repos",
69649
+ "public_gists",
69650
+ "followers",
69651
+ "following",
69652
+ "type",
69653
+ "created_at",
69654
+ "updated_at"
69655
+ ]
69656
+ },
69252
69657
  "team-full": {
69253
69658
  "title": "Full Team",
69254
69659
  "description": "Groups of organization members that gives permissions on specified repositories.",
@@ -69333,7 +69738,7 @@
69333
69738
  "example": "2017-08-17T12:37:15Z"
69334
69739
  },
69335
69740
  "organization": {
69336
- "$ref": "#/components/schemas/organization-full"
69741
+ "$ref": "#/components/schemas/team-organization"
69337
69742
  },
69338
69743
  "ldap_dn": {
69339
69744
  "description": "Distinguished Name (DN) that team maps to within LDAP environment",
@@ -97014,6 +97419,109 @@
97014
97419
  }
97015
97420
  ]
97016
97421
  },
97422
+ "branch-get": {
97423
+ "value": {
97424
+ "name": "main",
97425
+ "commit": {
97426
+ "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
97427
+ "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk",
97428
+ "commit": {
97429
+ "author": {
97430
+ "name": "The Octocat",
97431
+ "email": "octocat@nowhere.com",
97432
+ "date": "2012-03-06T23:06:50Z"
97433
+ },
97434
+ "committer": {
97435
+ "name": "The Octocat",
97436
+ "email": "octocat@nowhere.com",
97437
+ "date": "2012-03-06T23:06:50Z"
97438
+ },
97439
+ "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.",
97440
+ "tree": {
97441
+ "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608",
97442
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608"
97443
+ },
97444
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
97445
+ "comment_count": 77,
97446
+ "verification": {
97447
+ "verified": false,
97448
+ "reason": "unsigned",
97449
+ "signature": null,
97450
+ "payload": null
97451
+ }
97452
+ },
97453
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
97454
+ "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
97455
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments",
97456
+ "author": {
97457
+ "login": "octocat",
97458
+ "id": 583231,
97459
+ "node_id": "MDQ6VXNlcjU4MzIzMQ==",
97460
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
97461
+ "gravatar_id": "",
97462
+ "url": "https://api.github.com/users/octocat",
97463
+ "html_url": "https://github.com/octocat",
97464
+ "followers_url": "https://api.github.com/users/octocat/followers",
97465
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
97466
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
97467
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
97468
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
97469
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
97470
+ "repos_url": "https://api.github.com/users/octocat/repos",
97471
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
97472
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
97473
+ "type": "User",
97474
+ "site_admin": false
97475
+ },
97476
+ "committer": {
97477
+ "login": "octocat",
97478
+ "id": 583231,
97479
+ "node_id": "MDQ6VXNlcjU4MzIzMQ==",
97480
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
97481
+ "gravatar_id": "",
97482
+ "url": "https://api.github.com/users/octocat",
97483
+ "html_url": "https://github.com/octocat",
97484
+ "followers_url": "https://api.github.com/users/octocat/followers",
97485
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
97486
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
97487
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
97488
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
97489
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
97490
+ "repos_url": "https://api.github.com/users/octocat/repos",
97491
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
97492
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
97493
+ "type": "User",
97494
+ "site_admin": false
97495
+ },
97496
+ "parents": [
97497
+ {
97498
+ "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e",
97499
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e",
97500
+ "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e"
97501
+ },
97502
+ {
97503
+ "sha": "762941318ee16e59dabbacb1b4049eec22f0d303",
97504
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303",
97505
+ "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303"
97506
+ }
97507
+ ]
97508
+ },
97509
+ "_links": {
97510
+ "self": "https://api.github.com/repos/octocat/Hello-World/branches/main",
97511
+ "html": "https://github.com/octocat/Hello-World/tree/main"
97512
+ },
97513
+ "protected": false,
97514
+ "protection": {
97515
+ "enabled": false,
97516
+ "required_status_checks": {
97517
+ "enforcement_level": "off",
97518
+ "contexts": [],
97519
+ "checks": []
97520
+ }
97521
+ },
97522
+ "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection"
97523
+ }
97524
+ },
97017
97525
  "branch-protection": {
97018
97526
  "value": {
97019
97527
  "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection",
@@ -97210,6 +97718,71 @@
97210
97718
  }
97211
97719
  }
97212
97720
  },
97721
+ "branch-protection-update": {
97722
+ "value": {
97723
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection",
97724
+ "required_status_checks": {
97725
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks",
97726
+ "strict": true,
97727
+ "contexts": [
97728
+ "continuous-integration/travis-ci"
97729
+ ],
97730
+ "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts",
97731
+ "checks": [
97732
+ {
97733
+ "context": "continuous-integration/travis-ci",
97734
+ "app_id": null
97735
+ }
97736
+ ]
97737
+ },
97738
+ "restrictions": {
97739
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions",
97740
+ "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users",
97741
+ "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams",
97742
+ "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps",
97743
+ "users": [],
97744
+ "teams": [],
97745
+ "apps": []
97746
+ },
97747
+ "required_pull_request_reviews": {
97748
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews",
97749
+ "dismiss_stale_reviews": true,
97750
+ "require_code_owner_reviews": true,
97751
+ "required_approving_review_count": 2,
97752
+ "dismissal_restrictions": {
97753
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions",
97754
+ "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users",
97755
+ "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams",
97756
+ "users": [],
97757
+ "teams": [],
97758
+ "apps": []
97759
+ }
97760
+ },
97761
+ "required_signatures": {
97762
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures",
97763
+ "enabled": false
97764
+ },
97765
+ "enforce_admins": {
97766
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins",
97767
+ "enabled": true
97768
+ },
97769
+ "required_linear_history": {
97770
+ "enabled": true
97771
+ },
97772
+ "allow_force_pushes": {
97773
+ "enabled": true
97774
+ },
97775
+ "allow_deletions": {
97776
+ "enabled": true
97777
+ },
97778
+ "block_creations": {
97779
+ "enabled": true
97780
+ },
97781
+ "required_conversation_resolution": {
97782
+ "enabled": true
97783
+ }
97784
+ }
97785
+ },
97213
97786
  "protected-branch-admin-enforced-2": {
97214
97787
  "value": {
97215
97788
  "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins",
@@ -98751,6 +99324,7 @@
98751
99324
  "ref": "refs/heads/main",
98752
99325
  "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
98753
99326
  "environment": "",
99327
+ "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
98754
99328
  "state": "open",
98755
99329
  "fixed_at": null,
98756
99330
  "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930",
@@ -102703,7 +103277,8 @@
102703
103277
  "type": "User",
102704
103278
  "site_admin": false
102705
103279
  },
102706
- "author_association": "COLLABORATOR"
103280
+ "author_association": "COLLABORATOR",
103281
+ "state_reason": "completed"
102707
103282
  }
102708
103283
  ]
102709
103284
  },
@@ -102863,7 +103438,8 @@
102863
103438
  "type": "User",
102864
103439
  "site_admin": false
102865
103440
  },
102866
- "author_association": "COLLABORATOR"
103441
+ "author_association": "COLLABORATOR",
103442
+ "state_reason": "completed"
102867
103443
  }
102868
103444
  },
102869
103445
  "issue-comment-items": {
@@ -103099,7 +103675,8 @@
103099
103675
  "closed_at": null,
103100
103676
  "created_at": "2011-04-22T13:33:48Z",
103101
103677
  "updated_at": "2011-04-22T13:33:48Z",
103102
- "author_association": "COLLABORATOR"
103678
+ "author_association": "COLLABORATOR",
103679
+ "state_reason": "completed"
103103
103680
  }
103104
103681
  }
103105
103682
  ]
@@ -103308,7 +103885,8 @@
103308
103885
  "closed_at": null,
103309
103886
  "created_at": "2011-04-22T13:33:48Z",
103310
103887
  "updated_at": "2011-04-22T13:33:48Z",
103311
- "author_association": "COLLABORATOR"
103888
+ "author_association": "COLLABORATOR",
103889
+ "state_reason": "completed"
103312
103890
  }
103313
103891
  }
103314
103892
  },
@@ -108282,7 +108860,8 @@
108282
108860
  "body": "...",
108283
108861
  "score": 1,
108284
108862
  "locked": true,
108285
- "author_association": "COLLABORATOR"
108863
+ "author_association": "COLLABORATOR",
108864
+ "state_reason": "completed"
108286
108865
  }
108287
108866
  ]
108288
108867
  }