@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": {
@@ -9594,7 +9594,7 @@
9594
9594
  "/organizations/{organization_id}/custom_roles": {
9595
9595
  "get": {
9596
9596
  "summary": "List custom repository roles in an organization",
9597
- "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/enterprise-server@3.5/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".",
9597
+ "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nTo use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope.\nGitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/enterprise-server@3.5/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".",
9598
9598
  "tags": [
9599
9599
  "orgs"
9600
9600
  ],
@@ -23629,6 +23629,11 @@
23629
23629
  "application/json": {
23630
23630
  "schema": {
23631
23631
  "$ref": "#/components/schemas/branch-with-protection"
23632
+ },
23633
+ "examples": {
23634
+ "default": {
23635
+ "$ref": "#/components/examples/branch-get"
23636
+ }
23632
23637
  }
23633
23638
  }
23634
23639
  }
@@ -23971,6 +23976,11 @@
23971
23976
  "application/json": {
23972
23977
  "schema": {
23973
23978
  "$ref": "#/components/schemas/protected-branch"
23979
+ },
23980
+ "examples": {
23981
+ "default": {
23982
+ "$ref": "#/components/examples/branch-protection-update"
23983
+ }
23974
23984
  }
23975
23985
  }
23976
23986
  }
@@ -24845,7 +24855,7 @@
24845
24855
  "properties": {
24846
24856
  "contexts": {
24847
24857
  "type": "array",
24848
- "description": "contexts parameter",
24858
+ "description": "The name of the status checks",
24849
24859
  "items": {
24850
24860
  "type": "string"
24851
24861
  }
@@ -24861,6 +24871,17 @@
24861
24871
  }
24862
24872
  }
24863
24873
  ]
24874
+ },
24875
+ "examples": {
24876
+ "default": {
24877
+ "summary": "Example adding status checks to a branch protection rule",
24878
+ "value": {
24879
+ "contexts": [
24880
+ "continuous-integration/travis-ci",
24881
+ "continuous-integration/jenkins"
24882
+ ]
24883
+ }
24884
+ }
24864
24885
  }
24865
24886
  }
24866
24887
  }
@@ -24939,7 +24960,7 @@
24939
24960
  "properties": {
24940
24961
  "contexts": {
24941
24962
  "type": "array",
24942
- "description": "contexts parameter",
24963
+ "description": "The name of the status checks",
24943
24964
  "items": {
24944
24965
  "type": "string"
24945
24966
  }
@@ -24955,6 +24976,16 @@
24955
24976
  }
24956
24977
  }
24957
24978
  ]
24979
+ },
24980
+ "examples": {
24981
+ "default": {
24982
+ "summary": "Example updating status checks for a branch protection rule",
24983
+ "value": {
24984
+ "contexts": [
24985
+ "continuous-integration/travis-ci"
24986
+ ]
24987
+ }
24988
+ }
24958
24989
  }
24959
24990
  }
24960
24991
  }
@@ -25028,7 +25059,7 @@
25028
25059
  "properties": {
25029
25060
  "contexts": {
25030
25061
  "type": "array",
25031
- "description": "contexts parameter",
25062
+ "description": "The name of the status checks",
25032
25063
  "items": {
25033
25064
  "type": "string"
25034
25065
  }
@@ -25044,6 +25075,16 @@
25044
25075
  }
25045
25076
  }
25046
25077
  ]
25078
+ },
25079
+ "examples": {
25080
+ "default": {
25081
+ "summary": "Example removing status checks from a branch protection rule",
25082
+ "value": {
25083
+ "contexts": [
25084
+ "continuous-integration/travis-ci"
25085
+ ]
25086
+ }
25087
+ }
25047
25088
  }
25048
25089
  }
25049
25090
  }
@@ -25569,7 +25610,7 @@
25569
25610
  "properties": {
25570
25611
  "teams": {
25571
25612
  "type": "array",
25572
- "description": "teams parameter",
25613
+ "description": "The slug values for teams",
25573
25614
  "items": {
25574
25615
  "type": "string"
25575
25616
  }
@@ -25585,6 +25626,16 @@
25585
25626
  }
25586
25627
  }
25587
25628
  ]
25629
+ },
25630
+ "examples": {
25631
+ "default": {
25632
+ "summary": "Example adding a team in a branch protection rule",
25633
+ "value": {
25634
+ "teams": [
25635
+ "justice-league"
25636
+ ]
25637
+ }
25638
+ }
25588
25639
  }
25589
25640
  }
25590
25641
  }
@@ -25654,7 +25705,7 @@
25654
25705
  "properties": {
25655
25706
  "teams": {
25656
25707
  "type": "array",
25657
- "description": "teams parameter",
25708
+ "description": "The slug values for teams",
25658
25709
  "items": {
25659
25710
  "type": "string"
25660
25711
  }
@@ -25665,11 +25716,21 @@
25665
25716
  ],
25666
25717
  "example": {
25667
25718
  "teams": [
25668
- "my-team"
25719
+ "justice-league"
25669
25720
  ]
25670
25721
  }
25671
25722
  }
25672
25723
  ]
25724
+ },
25725
+ "examples": {
25726
+ "default": {
25727
+ "summary": "Example replacing a team in a branch protection rule",
25728
+ "value": {
25729
+ "teams": [
25730
+ "justice-league"
25731
+ ]
25732
+ }
25733
+ }
25673
25734
  }
25674
25735
  }
25675
25736
  }
@@ -25738,7 +25799,7 @@
25738
25799
  "properties": {
25739
25800
  "teams": {
25740
25801
  "type": "array",
25741
- "description": "teams parameter",
25802
+ "description": "The slug values for teams",
25742
25803
  "items": {
25743
25804
  "type": "string"
25744
25805
  }
@@ -25754,6 +25815,16 @@
25754
25815
  }
25755
25816
  }
25756
25817
  ]
25818
+ },
25819
+ "examples": {
25820
+ "default": {
25821
+ "summary": "Example removing a team in a branch protection rule",
25822
+ "value": {
25823
+ "teams": [
25824
+ "justice-league"
25825
+ ]
25826
+ }
25827
+ }
25757
25828
  }
25758
25829
  }
25759
25830
  }
@@ -25878,7 +25949,7 @@
25878
25949
  "properties": {
25879
25950
  "users": {
25880
25951
  "type": "array",
25881
- "description": "users parameter",
25952
+ "description": "The username for users",
25882
25953
  "items": {
25883
25954
  "type": "string"
25884
25955
  }
@@ -25894,6 +25965,16 @@
25894
25965
  }
25895
25966
  }
25896
25967
  ]
25968
+ },
25969
+ "examples": {
25970
+ "default": {
25971
+ "summary": "Example adding a user in a branch protection rule",
25972
+ "value": {
25973
+ "users": [
25974
+ "octocat"
25975
+ ]
25976
+ }
25977
+ }
25897
25978
  }
25898
25979
  }
25899
25980
  }
@@ -25963,7 +26044,7 @@
25963
26044
  "properties": {
25964
26045
  "users": {
25965
26046
  "type": "array",
25966
- "description": "users parameter",
26047
+ "description": "The username for users",
25967
26048
  "items": {
25968
26049
  "type": "string"
25969
26050
  }
@@ -25979,6 +26060,16 @@
25979
26060
  }
25980
26061
  }
25981
26062
  ]
26063
+ },
26064
+ "examples": {
26065
+ "default": {
26066
+ "summary": "Example replacing a user in a branch protection rule",
26067
+ "value": {
26068
+ "users": [
26069
+ "octocat"
26070
+ ]
26071
+ }
26072
+ }
25982
26073
  }
25983
26074
  }
25984
26075
  }
@@ -26047,7 +26138,7 @@
26047
26138
  "properties": {
26048
26139
  "users": {
26049
26140
  "type": "array",
26050
- "description": "users parameter",
26141
+ "description": "The username for users",
26051
26142
  "items": {
26052
26143
  "type": "string"
26053
26144
  }
@@ -26063,6 +26154,16 @@
26063
26154
  }
26064
26155
  }
26065
26156
  ]
26157
+ },
26158
+ "examples": {
26159
+ "default": {
26160
+ "summary": "Example removing a user in a branch protection rule",
26161
+ "value": {
26162
+ "users": [
26163
+ "octocat"
26164
+ ]
26165
+ }
26166
+ }
26066
26167
  }
26067
26168
  }
26068
26169
  }
@@ -27918,7 +28019,7 @@
27918
28019
  },
27919
28020
  "delete": {
27920
28021
  "summary": "Delete a code scanning analysis from a repository",
27921
- "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.",
28022
+ "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.",
27922
28023
  "operationId": "code-scanning/delete-analysis",
27923
28024
  "tags": [
27924
28025
  "code-scanning"
@@ -29856,7 +29957,7 @@
29856
29957
  "/repos/{owner}/{repo}/contents/{path}": {
29857
29958
  "get": {
29858
29959
  "summary": "Get repository content",
29859
- "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/enterprise-server@3.5/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/enterprise-server@3.5/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/enterprise-server@3.5/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/enterprise-server@3.5/rest/reference/git#get-a-tree).\n* This API supports files up to 1 megabyte in size.\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.",
29960
+ "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/enterprise-server@3.5/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/enterprise-server@3.5/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/enterprise-server@3.5/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/enterprise-server@3.5/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* This API supports files up to 1 megabyte in size.\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.",
29860
29961
  "tags": [
29861
29962
  "repos"
29862
29963
  ],
@@ -34194,6 +34295,14 @@
34194
34295
  ]
34195
34296
  }
34196
34297
  }
34298
+ },
34299
+ "examples": {
34300
+ "default": {
34301
+ "summary": "Example request body",
34302
+ "value": {
34303
+ "permissions": "write"
34304
+ }
34305
+ }
34197
34306
  }
34198
34307
  }
34199
34308
  }
@@ -35325,6 +35434,12 @@
35325
35434
  "closed"
35326
35435
  ]
35327
35436
  },
35437
+ "state_reason": {
35438
+ "type": "string",
35439
+ "nullable": true,
35440
+ "description": "The reason for the current state",
35441
+ "example": "not_planned"
35442
+ },
35328
35443
  "milestone": {
35329
35444
  "oneOf": [
35330
35445
  {
@@ -54534,14 +54649,6 @@
54534
54649
  "write"
54535
54650
  ]
54536
54651
  },
54537
- "organization_custom_roles": {
54538
- "type": "string",
54539
- "description": "The level of permission to grant the access token for custom roles management.",
54540
- "enum": [
54541
- "read",
54542
- "write"
54543
- ]
54544
- },
54545
54652
  "deployments": {
54546
54653
  "type": "string",
54547
54654
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -62520,6 +62627,263 @@
62520
62627
  "parent"
62521
62628
  ]
62522
62629
  },
62630
+ "team-organization": {
62631
+ "title": "Team Organization",
62632
+ "description": "Team Organization",
62633
+ "type": "object",
62634
+ "properties": {
62635
+ "login": {
62636
+ "type": "string",
62637
+ "example": "github"
62638
+ },
62639
+ "id": {
62640
+ "type": "integer",
62641
+ "example": 1
62642
+ },
62643
+ "node_id": {
62644
+ "type": "string",
62645
+ "example": "MDEyOk9yZ2FuaXphdGlvbjE="
62646
+ },
62647
+ "url": {
62648
+ "type": "string",
62649
+ "format": "uri",
62650
+ "example": "https://api.github.com/orgs/github"
62651
+ },
62652
+ "repos_url": {
62653
+ "type": "string",
62654
+ "format": "uri",
62655
+ "example": "https://api.github.com/orgs/github/repos"
62656
+ },
62657
+ "events_url": {
62658
+ "type": "string",
62659
+ "format": "uri",
62660
+ "example": "https://api.github.com/orgs/github/events"
62661
+ },
62662
+ "hooks_url": {
62663
+ "type": "string",
62664
+ "example": "https://api.github.com/orgs/github/hooks"
62665
+ },
62666
+ "issues_url": {
62667
+ "type": "string",
62668
+ "example": "https://api.github.com/orgs/github/issues"
62669
+ },
62670
+ "members_url": {
62671
+ "type": "string",
62672
+ "example": "https://api.github.com/orgs/github/members{/member}"
62673
+ },
62674
+ "public_members_url": {
62675
+ "type": "string",
62676
+ "example": "https://api.github.com/orgs/github/public_members{/member}"
62677
+ },
62678
+ "avatar_url": {
62679
+ "type": "string",
62680
+ "example": "https://github.com/images/error/octocat_happy.gif"
62681
+ },
62682
+ "description": {
62683
+ "type": "string",
62684
+ "example": "A great organization",
62685
+ "nullable": true
62686
+ },
62687
+ "name": {
62688
+ "type": "string",
62689
+ "example": "github"
62690
+ },
62691
+ "company": {
62692
+ "type": "string",
62693
+ "example": "GitHub"
62694
+ },
62695
+ "blog": {
62696
+ "type": "string",
62697
+ "format": "uri",
62698
+ "example": "https://github.com/blog"
62699
+ },
62700
+ "location": {
62701
+ "type": "string",
62702
+ "example": "San Francisco"
62703
+ },
62704
+ "email": {
62705
+ "type": "string",
62706
+ "format": "email",
62707
+ "example": "octocat@github.com"
62708
+ },
62709
+ "twitter_username": {
62710
+ "type": "string",
62711
+ "example": "github",
62712
+ "nullable": true
62713
+ },
62714
+ "is_verified": {
62715
+ "type": "boolean",
62716
+ "example": true
62717
+ },
62718
+ "has_organization_projects": {
62719
+ "type": "boolean",
62720
+ "example": true
62721
+ },
62722
+ "has_repository_projects": {
62723
+ "type": "boolean",
62724
+ "example": true
62725
+ },
62726
+ "public_repos": {
62727
+ "type": "integer",
62728
+ "example": 2
62729
+ },
62730
+ "public_gists": {
62731
+ "type": "integer",
62732
+ "example": 1
62733
+ },
62734
+ "followers": {
62735
+ "type": "integer",
62736
+ "example": 20
62737
+ },
62738
+ "following": {
62739
+ "type": "integer",
62740
+ "example": 0
62741
+ },
62742
+ "html_url": {
62743
+ "type": "string",
62744
+ "format": "uri",
62745
+ "example": "https://github.com/octocat"
62746
+ },
62747
+ "created_at": {
62748
+ "type": "string",
62749
+ "format": "date-time",
62750
+ "example": "2008-01-14T04:33:35Z"
62751
+ },
62752
+ "type": {
62753
+ "type": "string",
62754
+ "example": "Organization"
62755
+ },
62756
+ "total_private_repos": {
62757
+ "type": "integer",
62758
+ "example": 100
62759
+ },
62760
+ "owned_private_repos": {
62761
+ "type": "integer",
62762
+ "example": 100
62763
+ },
62764
+ "private_gists": {
62765
+ "type": "integer",
62766
+ "example": 81,
62767
+ "nullable": true
62768
+ },
62769
+ "disk_usage": {
62770
+ "type": "integer",
62771
+ "example": 10000,
62772
+ "nullable": true
62773
+ },
62774
+ "collaborators": {
62775
+ "type": "integer",
62776
+ "example": 8,
62777
+ "nullable": true
62778
+ },
62779
+ "billing_email": {
62780
+ "type": "string",
62781
+ "format": "email",
62782
+ "example": "org@example.com",
62783
+ "nullable": true
62784
+ },
62785
+ "plan": {
62786
+ "type": "object",
62787
+ "properties": {
62788
+ "name": {
62789
+ "type": "string"
62790
+ },
62791
+ "space": {
62792
+ "type": "integer"
62793
+ },
62794
+ "private_repos": {
62795
+ "type": "integer"
62796
+ },
62797
+ "filled_seats": {
62798
+ "type": "integer"
62799
+ },
62800
+ "seats": {
62801
+ "type": "integer"
62802
+ }
62803
+ },
62804
+ "required": [
62805
+ "name",
62806
+ "space",
62807
+ "private_repos"
62808
+ ]
62809
+ },
62810
+ "default_repository_permission": {
62811
+ "type": "string",
62812
+ "nullable": true
62813
+ },
62814
+ "members_can_create_repositories": {
62815
+ "type": "boolean",
62816
+ "example": true,
62817
+ "nullable": true
62818
+ },
62819
+ "two_factor_requirement_enabled": {
62820
+ "type": "boolean",
62821
+ "example": true,
62822
+ "nullable": true
62823
+ },
62824
+ "members_allowed_repository_creation_type": {
62825
+ "type": "string",
62826
+ "example": "all"
62827
+ },
62828
+ "members_can_create_public_repositories": {
62829
+ "type": "boolean",
62830
+ "example": true
62831
+ },
62832
+ "members_can_create_private_repositories": {
62833
+ "type": "boolean",
62834
+ "example": true
62835
+ },
62836
+ "members_can_create_internal_repositories": {
62837
+ "type": "boolean",
62838
+ "example": true
62839
+ },
62840
+ "members_can_create_pages": {
62841
+ "type": "boolean",
62842
+ "example": true
62843
+ },
62844
+ "members_can_create_public_pages": {
62845
+ "type": "boolean",
62846
+ "example": true
62847
+ },
62848
+ "members_can_create_private_pages": {
62849
+ "type": "boolean",
62850
+ "example": true
62851
+ },
62852
+ "members_can_fork_private_repositories": {
62853
+ "type": "boolean",
62854
+ "example": false,
62855
+ "nullable": true
62856
+ },
62857
+ "updated_at": {
62858
+ "type": "string",
62859
+ "format": "date-time"
62860
+ }
62861
+ },
62862
+ "required": [
62863
+ "login",
62864
+ "url",
62865
+ "id",
62866
+ "node_id",
62867
+ "repos_url",
62868
+ "events_url",
62869
+ "hooks_url",
62870
+ "issues_url",
62871
+ "members_url",
62872
+ "public_members_url",
62873
+ "avatar_url",
62874
+ "description",
62875
+ "html_url",
62876
+ "has_organization_projects",
62877
+ "has_repository_projects",
62878
+ "public_repos",
62879
+ "public_gists",
62880
+ "followers",
62881
+ "following",
62882
+ "type",
62883
+ "created_at",
62884
+ "updated_at"
62885
+ ]
62886
+ },
62523
62887
  "team-full": {
62524
62888
  "title": "Full Team",
62525
62889
  "description": "Groups of organization members that gives permissions on specified repositories.",
@@ -62604,7 +62968,7 @@
62604
62968
  "example": "2017-08-17T12:37:15Z"
62605
62969
  },
62606
62970
  "organization": {
62607
- "$ref": "#/components/schemas/organization-full"
62971
+ "$ref": "#/components/schemas/team-organization"
62608
62972
  },
62609
62973
  "ldap_dn": {
62610
62974
  "description": "Distinguished Name (DN) that team maps to within LDAP environment",
@@ -87911,6 +88275,109 @@
87911
88275
  }
87912
88276
  ]
87913
88277
  },
88278
+ "branch-get": {
88279
+ "value": {
88280
+ "name": "main",
88281
+ "commit": {
88282
+ "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
88283
+ "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk",
88284
+ "commit": {
88285
+ "author": {
88286
+ "name": "The Octocat",
88287
+ "email": "octocat@nowhere.com",
88288
+ "date": "2012-03-06T23:06:50Z"
88289
+ },
88290
+ "committer": {
88291
+ "name": "The Octocat",
88292
+ "email": "octocat@nowhere.com",
88293
+ "date": "2012-03-06T23:06:50Z"
88294
+ },
88295
+ "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.",
88296
+ "tree": {
88297
+ "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608",
88298
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608"
88299
+ },
88300
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
88301
+ "comment_count": 77,
88302
+ "verification": {
88303
+ "verified": false,
88304
+ "reason": "unsigned",
88305
+ "signature": null,
88306
+ "payload": null
88307
+ }
88308
+ },
88309
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
88310
+ "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
88311
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments",
88312
+ "author": {
88313
+ "login": "octocat",
88314
+ "id": 583231,
88315
+ "node_id": "MDQ6VXNlcjU4MzIzMQ==",
88316
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
88317
+ "gravatar_id": "",
88318
+ "url": "https://api.github.com/users/octocat",
88319
+ "html_url": "https://github.com/octocat",
88320
+ "followers_url": "https://api.github.com/users/octocat/followers",
88321
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
88322
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
88323
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
88324
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
88325
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
88326
+ "repos_url": "https://api.github.com/users/octocat/repos",
88327
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
88328
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
88329
+ "type": "User",
88330
+ "site_admin": false
88331
+ },
88332
+ "committer": {
88333
+ "login": "octocat",
88334
+ "id": 583231,
88335
+ "node_id": "MDQ6VXNlcjU4MzIzMQ==",
88336
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
88337
+ "gravatar_id": "",
88338
+ "url": "https://api.github.com/users/octocat",
88339
+ "html_url": "https://github.com/octocat",
88340
+ "followers_url": "https://api.github.com/users/octocat/followers",
88341
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
88342
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
88343
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
88344
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
88345
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
88346
+ "repos_url": "https://api.github.com/users/octocat/repos",
88347
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
88348
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
88349
+ "type": "User",
88350
+ "site_admin": false
88351
+ },
88352
+ "parents": [
88353
+ {
88354
+ "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e",
88355
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e",
88356
+ "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e"
88357
+ },
88358
+ {
88359
+ "sha": "762941318ee16e59dabbacb1b4049eec22f0d303",
88360
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303",
88361
+ "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303"
88362
+ }
88363
+ ]
88364
+ },
88365
+ "_links": {
88366
+ "self": "https://api.github.com/repos/octocat/Hello-World/branches/main",
88367
+ "html": "https://github.com/octocat/Hello-World/tree/main"
88368
+ },
88369
+ "protected": false,
88370
+ "protection": {
88371
+ "enabled": false,
88372
+ "required_status_checks": {
88373
+ "enforcement_level": "off",
88374
+ "contexts": [],
88375
+ "checks": []
88376
+ }
88377
+ },
88378
+ "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection"
88379
+ }
88380
+ },
87914
88381
  "branch-protection": {
87915
88382
  "value": {
87916
88383
  "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection",
@@ -88107,6 +88574,71 @@
88107
88574
  }
88108
88575
  }
88109
88576
  },
88577
+ "branch-protection-update": {
88578
+ "value": {
88579
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection",
88580
+ "required_status_checks": {
88581
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks",
88582
+ "strict": true,
88583
+ "contexts": [
88584
+ "continuous-integration/travis-ci"
88585
+ ],
88586
+ "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts",
88587
+ "checks": [
88588
+ {
88589
+ "context": "continuous-integration/travis-ci",
88590
+ "app_id": null
88591
+ }
88592
+ ]
88593
+ },
88594
+ "restrictions": {
88595
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions",
88596
+ "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users",
88597
+ "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams",
88598
+ "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps",
88599
+ "users": [],
88600
+ "teams": [],
88601
+ "apps": []
88602
+ },
88603
+ "required_pull_request_reviews": {
88604
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews",
88605
+ "dismiss_stale_reviews": true,
88606
+ "require_code_owner_reviews": true,
88607
+ "required_approving_review_count": 2,
88608
+ "dismissal_restrictions": {
88609
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions",
88610
+ "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users",
88611
+ "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams",
88612
+ "users": [],
88613
+ "teams": [],
88614
+ "apps": []
88615
+ }
88616
+ },
88617
+ "required_signatures": {
88618
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures",
88619
+ "enabled": false
88620
+ },
88621
+ "enforce_admins": {
88622
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins",
88623
+ "enabled": true
88624
+ },
88625
+ "required_linear_history": {
88626
+ "enabled": true
88627
+ },
88628
+ "allow_force_pushes": {
88629
+ "enabled": true
88630
+ },
88631
+ "allow_deletions": {
88632
+ "enabled": true
88633
+ },
88634
+ "block_creations": {
88635
+ "enabled": true
88636
+ },
88637
+ "required_conversation_resolution": {
88638
+ "enabled": true
88639
+ }
88640
+ }
88641
+ },
88110
88642
  "protected-branch-admin-enforced-2": {
88111
88643
  "value": {
88112
88644
  "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins",
@@ -89642,6 +90174,7 @@
89642
90174
  "ref": "refs/heads/main",
89643
90175
  "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
89644
90176
  "environment": "",
90177
+ "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
89645
90178
  "state": "open",
89646
90179
  "fixed_at": null,
89647
90180
  "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930",
@@ -92930,7 +93463,8 @@
92930
93463
  "type": "User",
92931
93464
  "site_admin": false
92932
93465
  },
92933
- "author_association": "COLLABORATOR"
93466
+ "author_association": "COLLABORATOR",
93467
+ "state_reason": "completed"
92934
93468
  }
92935
93469
  ]
92936
93470
  },
@@ -93090,7 +93624,8 @@
93090
93624
  "type": "User",
93091
93625
  "site_admin": false
93092
93626
  },
93093
- "author_association": "COLLABORATOR"
93627
+ "author_association": "COLLABORATOR",
93628
+ "state_reason": "completed"
93094
93629
  }
93095
93630
  },
93096
93631
  "issue-comment-items": {
@@ -93326,7 +93861,8 @@
93326
93861
  "closed_at": null,
93327
93862
  "created_at": "2011-04-22T13:33:48Z",
93328
93863
  "updated_at": "2011-04-22T13:33:48Z",
93329
- "author_association": "COLLABORATOR"
93864
+ "author_association": "COLLABORATOR",
93865
+ "state_reason": "completed"
93330
93866
  }
93331
93867
  }
93332
93868
  ]
@@ -93535,7 +94071,8 @@
93535
94071
  "closed_at": null,
93536
94072
  "created_at": "2011-04-22T13:33:48Z",
93537
94073
  "updated_at": "2011-04-22T13:33:48Z",
93538
- "author_association": "COLLABORATOR"
94074
+ "author_association": "COLLABORATOR",
94075
+ "state_reason": "completed"
93539
94076
  }
93540
94077
  }
93541
94078
  },
@@ -97774,7 +98311,8 @@
97774
98311
  "body": "...",
97775
98312
  "score": 1,
97776
98313
  "locked": true,
97777
- "author_association": "COLLABORATOR"
98314
+ "author_association": "COLLABORATOR",
98315
+ "state_reason": "completed"
97778
98316
  }
97779
98317
  ]
97780
98318
  }