@octokit/openapi 7.5.0 → 7.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (34) hide show
  1. package/generated/api.github.com.deref.json +2249 -268
  2. package/generated/api.github.com.json +1222 -129
  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 +386 -28
  6. package/generated/ghes-3.2-diff-to-ghes-3.3.json +43 -17
  7. package/generated/ghes-3.2.deref.json +778 -256
  8. package/generated/ghes-3.2.json +588 -40
  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 +205 -225
  11. package/generated/ghes-3.3-diff-to-ghes-3.4.json +445 -12
  12. package/generated/ghes-3.3.deref.json +785 -257
  13. package/generated/ghes-3.3.json +595 -41
  14. package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json +153 -1
  15. package/generated/ghes-3.4-diff-to-ghes-3.5.json +13 -1
  16. package/generated/ghes-3.4.deref.json +816 -243
  17. package/generated/ghes-3.4.json +603 -43
  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 +462 -42
  21. package/generated/ghes-3.5-diff-to-ghes-3.6.json +304 -18
  22. package/generated/ghes-3.5.deref.json +829 -243
  23. package/generated/ghes-3.5.json +603 -43
  24. package/generated/ghes-3.6-anicca-diff-to-api.github.com.deref.json +519 -89
  25. package/generated/ghes-3.6-diff-to-api.github.com.deref.json +18071 -6614
  26. package/generated/ghes-3.6-diff-to-api.github.com.json +6665 -4290
  27. package/generated/ghes-3.6.deref.json +1048 -256
  28. package/generated/ghes-3.6.json +826 -56
  29. package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +347 -32
  30. package/generated/github.ae-diff-to-api.github.com.deref.json +11634 -3854
  31. package/generated/github.ae-diff-to-api.github.com.json +1185 -40
  32. package/generated/github.ae.deref.json +1087 -178
  33. package/generated/github.ae.json +865 -50
  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.8.0",
5
5
  "title": "GitHub's official OpenAPI spec + Octokit extension",
6
6
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
7
7
  "license": {
@@ -5177,6 +5177,14 @@
5177
5177
  ]
5178
5178
  }
5179
5179
  }
5180
+ },
5181
+ "examples": {
5182
+ "default": {
5183
+ "summary": "Example request body",
5184
+ "value": {
5185
+ "permissions": "write"
5186
+ }
5187
+ }
5180
5188
  }
5181
5189
  }
5182
5190
  }
@@ -5799,6 +5807,12 @@
5799
5807
  "closed"
5800
5808
  ]
5801
5809
  },
5810
+ "state_reason": {
5811
+ "type": "string",
5812
+ "nullable": true,
5813
+ "description": "The reason for the current state",
5814
+ "example": "not_planned"
5815
+ },
5802
5816
  "milestone": {
5803
5817
  "oneOf": [
5804
5818
  {
@@ -6382,6 +6396,9 @@
6382
6396
  },
6383
6397
  "500": {
6384
6398
  "$ref": "#/components/responses/internal_error"
6399
+ },
6400
+ "503": {
6401
+ "$ref": "#/components/responses/service_unavailable"
6385
6402
  }
6386
6403
  },
6387
6404
  "x-github": {
@@ -6940,7 +6957,7 @@
6940
6957
  "/repos/{template_owner}/{template_repo}/generate": {
6941
6958
  "post": {
6942
6959
  "summary": "Create a repository using a template",
6943
- "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.5/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.5/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
6960
+ "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.5/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.5/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
6944
6961
  "tags": [
6945
6962
  "repos"
6946
6963
  ],
@@ -10344,14 +10361,6 @@
10344
10361
  "write"
10345
10362
  ]
10346
10363
  },
10347
- "organization_custom_roles": {
10348
- "type": "string",
10349
- "description": "The level of permission to grant the access token for custom roles management.",
10350
- "enum": [
10351
- "read",
10352
- "write"
10353
- ]
10354
- },
10355
10364
  "deployments": {
10356
10365
  "type": "string",
10357
10366
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -11632,6 +11641,10 @@
11632
11641
  "starred_at": {
11633
11642
  "type": "string",
11634
11643
  "example": "\"2020-07-09T00:17:42Z\""
11644
+ },
11645
+ "anonymous_access_enabled": {
11646
+ "type": "boolean",
11647
+ "description": "Whether anonymous git access is enabled for this repository"
11635
11648
  }
11636
11649
  },
11637
11650
  "required": [
@@ -13092,7 +13105,7 @@
13092
13105
  "example": "2017-08-17T12:37:15Z"
13093
13106
  },
13094
13107
  "organization": {
13095
- "$ref": "#/components/schemas/organization-full"
13108
+ "$ref": "#/components/schemas/team-organization"
13096
13109
  },
13097
13110
  "ldap_dn": {
13098
13111
  "description": "Distinguished Name (DN) that team maps to within LDAP environment",
@@ -19445,6 +19458,10 @@
19445
19458
  "starred_at": {
19446
19459
  "type": "string",
19447
19460
  "example": "\"2020-07-09T00:17:42Z\""
19461
+ },
19462
+ "anonymous_access_enabled": {
19463
+ "type": "boolean",
19464
+ "description": "Whether anonymous git access is enabled for this repository"
19448
19465
  }
19449
19466
  },
19450
19467
  "required": [
@@ -19648,6 +19665,11 @@
19648
19665
  "nullable": true,
19649
19666
  "type": "string",
19650
19667
  "description": "Detailed documentation for the rule as GitHub Flavored Markdown."
19668
+ },
19669
+ "help_uri": {
19670
+ "nullable": true,
19671
+ "type": "string",
19672
+ "description": "A link to the documentation for the rule used to detect the alert."
19651
19673
  }
19652
19674
  }
19653
19675
  },
@@ -19841,6 +19863,263 @@
19841
19863
  ],
19842
19864
  "nullable": true
19843
19865
  },
19866
+ "team-organization": {
19867
+ "title": "Team Organization",
19868
+ "description": "Team Organization",
19869
+ "type": "object",
19870
+ "properties": {
19871
+ "login": {
19872
+ "type": "string",
19873
+ "example": "github"
19874
+ },
19875
+ "id": {
19876
+ "type": "integer",
19877
+ "example": 1
19878
+ },
19879
+ "node_id": {
19880
+ "type": "string",
19881
+ "example": "MDEyOk9yZ2FuaXphdGlvbjE="
19882
+ },
19883
+ "url": {
19884
+ "type": "string",
19885
+ "format": "uri",
19886
+ "example": "https://api.github.com/orgs/github"
19887
+ },
19888
+ "repos_url": {
19889
+ "type": "string",
19890
+ "format": "uri",
19891
+ "example": "https://api.github.com/orgs/github/repos"
19892
+ },
19893
+ "events_url": {
19894
+ "type": "string",
19895
+ "format": "uri",
19896
+ "example": "https://api.github.com/orgs/github/events"
19897
+ },
19898
+ "hooks_url": {
19899
+ "type": "string",
19900
+ "example": "https://api.github.com/orgs/github/hooks"
19901
+ },
19902
+ "issues_url": {
19903
+ "type": "string",
19904
+ "example": "https://api.github.com/orgs/github/issues"
19905
+ },
19906
+ "members_url": {
19907
+ "type": "string",
19908
+ "example": "https://api.github.com/orgs/github/members{/member}"
19909
+ },
19910
+ "public_members_url": {
19911
+ "type": "string",
19912
+ "example": "https://api.github.com/orgs/github/public_members{/member}"
19913
+ },
19914
+ "avatar_url": {
19915
+ "type": "string",
19916
+ "example": "https://github.com/images/error/octocat_happy.gif"
19917
+ },
19918
+ "description": {
19919
+ "type": "string",
19920
+ "example": "A great organization",
19921
+ "nullable": true
19922
+ },
19923
+ "name": {
19924
+ "type": "string",
19925
+ "example": "github"
19926
+ },
19927
+ "company": {
19928
+ "type": "string",
19929
+ "example": "GitHub"
19930
+ },
19931
+ "blog": {
19932
+ "type": "string",
19933
+ "format": "uri",
19934
+ "example": "https://github.com/blog"
19935
+ },
19936
+ "location": {
19937
+ "type": "string",
19938
+ "example": "San Francisco"
19939
+ },
19940
+ "email": {
19941
+ "type": "string",
19942
+ "format": "email",
19943
+ "example": "octocat@github.com"
19944
+ },
19945
+ "twitter_username": {
19946
+ "type": "string",
19947
+ "example": "github",
19948
+ "nullable": true
19949
+ },
19950
+ "is_verified": {
19951
+ "type": "boolean",
19952
+ "example": true
19953
+ },
19954
+ "has_organization_projects": {
19955
+ "type": "boolean",
19956
+ "example": true
19957
+ },
19958
+ "has_repository_projects": {
19959
+ "type": "boolean",
19960
+ "example": true
19961
+ },
19962
+ "public_repos": {
19963
+ "type": "integer",
19964
+ "example": 2
19965
+ },
19966
+ "public_gists": {
19967
+ "type": "integer",
19968
+ "example": 1
19969
+ },
19970
+ "followers": {
19971
+ "type": "integer",
19972
+ "example": 20
19973
+ },
19974
+ "following": {
19975
+ "type": "integer",
19976
+ "example": 0
19977
+ },
19978
+ "html_url": {
19979
+ "type": "string",
19980
+ "format": "uri",
19981
+ "example": "https://github.com/octocat"
19982
+ },
19983
+ "created_at": {
19984
+ "type": "string",
19985
+ "format": "date-time",
19986
+ "example": "2008-01-14T04:33:35Z"
19987
+ },
19988
+ "type": {
19989
+ "type": "string",
19990
+ "example": "Organization"
19991
+ },
19992
+ "total_private_repos": {
19993
+ "type": "integer",
19994
+ "example": 100
19995
+ },
19996
+ "owned_private_repos": {
19997
+ "type": "integer",
19998
+ "example": 100
19999
+ },
20000
+ "private_gists": {
20001
+ "type": "integer",
20002
+ "example": 81,
20003
+ "nullable": true
20004
+ },
20005
+ "disk_usage": {
20006
+ "type": "integer",
20007
+ "example": 10000,
20008
+ "nullable": true
20009
+ },
20010
+ "collaborators": {
20011
+ "type": "integer",
20012
+ "example": 8,
20013
+ "nullable": true
20014
+ },
20015
+ "billing_email": {
20016
+ "type": "string",
20017
+ "format": "email",
20018
+ "example": "org@example.com",
20019
+ "nullable": true
20020
+ },
20021
+ "plan": {
20022
+ "type": "object",
20023
+ "properties": {
20024
+ "name": {
20025
+ "type": "string"
20026
+ },
20027
+ "space": {
20028
+ "type": "integer"
20029
+ },
20030
+ "private_repos": {
20031
+ "type": "integer"
20032
+ },
20033
+ "filled_seats": {
20034
+ "type": "integer"
20035
+ },
20036
+ "seats": {
20037
+ "type": "integer"
20038
+ }
20039
+ },
20040
+ "required": [
20041
+ "name",
20042
+ "space",
20043
+ "private_repos"
20044
+ ]
20045
+ },
20046
+ "default_repository_permission": {
20047
+ "type": "string",
20048
+ "nullable": true
20049
+ },
20050
+ "members_can_create_repositories": {
20051
+ "type": "boolean",
20052
+ "example": true,
20053
+ "nullable": true
20054
+ },
20055
+ "two_factor_requirement_enabled": {
20056
+ "type": "boolean",
20057
+ "example": true,
20058
+ "nullable": true
20059
+ },
20060
+ "members_allowed_repository_creation_type": {
20061
+ "type": "string",
20062
+ "example": "all"
20063
+ },
20064
+ "members_can_create_public_repositories": {
20065
+ "type": "boolean",
20066
+ "example": true
20067
+ },
20068
+ "members_can_create_private_repositories": {
20069
+ "type": "boolean",
20070
+ "example": true
20071
+ },
20072
+ "members_can_create_internal_repositories": {
20073
+ "type": "boolean",
20074
+ "example": true
20075
+ },
20076
+ "members_can_create_pages": {
20077
+ "type": "boolean",
20078
+ "example": true
20079
+ },
20080
+ "members_can_create_public_pages": {
20081
+ "type": "boolean",
20082
+ "example": true
20083
+ },
20084
+ "members_can_create_private_pages": {
20085
+ "type": "boolean",
20086
+ "example": true
20087
+ },
20088
+ "members_can_fork_private_repositories": {
20089
+ "type": "boolean",
20090
+ "example": false,
20091
+ "nullable": true
20092
+ },
20093
+ "updated_at": {
20094
+ "type": "string",
20095
+ "format": "date-time"
20096
+ }
20097
+ },
20098
+ "required": [
20099
+ "login",
20100
+ "url",
20101
+ "id",
20102
+ "node_id",
20103
+ "repos_url",
20104
+ "events_url",
20105
+ "hooks_url",
20106
+ "issues_url",
20107
+ "members_url",
20108
+ "public_members_url",
20109
+ "avatar_url",
20110
+ "description",
20111
+ "html_url",
20112
+ "has_organization_projects",
20113
+ "has_repository_projects",
20114
+ "public_repos",
20115
+ "public_gists",
20116
+ "followers",
20117
+ "following",
20118
+ "type",
20119
+ "created_at",
20120
+ "updated_at"
20121
+ ]
20122
+ },
19844
20123
  "code-of-conduct-simple": {
19845
20124
  "title": "Code Of Conduct Simple",
19846
20125
  "description": "Code of Conduct Simple",
@@ -25926,7 +26205,8 @@
25926
26205
  "security",
25927
26206
  "external/cwe/cwe-022"
25928
26207
  ],
25929
- "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..."
26208
+ "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...",
26209
+ "help_uri": "https://codeql.github.com/"
25930
26210
  },
25931
26211
  "tool": {
25932
26212
  "name": "CodeQL",
@@ -25996,7 +26276,8 @@
25996
26276
  "security",
25997
26277
  "external/cwe/cwe-022"
25998
26278
  ],
25999
- "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..."
26279
+ "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...",
26280
+ "help_uri": "https://codeql.github.com/"
26000
26281
  },
26001
26282
  "tool": {
26002
26283
  "name": "CodeQL",
@@ -27537,7 +27818,8 @@
27537
27818
  "type": "User",
27538
27819
  "site_admin": false
27539
27820
  },
27540
- "author_association": "COLLABORATOR"
27821
+ "author_association": "COLLABORATOR",
27822
+ "state_reason": "completed"
27541
27823
  }
27542
27824
  ]
27543
27825
  },
@@ -27697,7 +27979,8 @@
27697
27979
  "type": "User",
27698
27980
  "site_admin": false
27699
27981
  },
27700
- "author_association": "COLLABORATOR"
27982
+ "author_association": "COLLABORATOR",
27983
+ "state_reason": "completed"
27701
27984
  }
27702
27985
  },
27703
27986
  "issue-event-items": {
@@ -27865,7 +28148,8 @@
27865
28148
  "closed_at": null,
27866
28149
  "created_at": "2011-04-22T13:33:48Z",
27867
28150
  "updated_at": "2011-04-22T13:33:48Z",
27868
- "author_association": "COLLABORATOR"
28151
+ "author_association": "COLLABORATOR",
28152
+ "state_reason": "completed"
27869
28153
  }
27870
28154
  }
27871
28155
  ]
@@ -28074,7 +28358,8 @@
28074
28358
  "closed_at": null,
28075
28359
  "created_at": "2011-04-22T13:33:48Z",
28076
28360
  "updated_at": "2011-04-22T13:33:48Z",
28077
- "author_association": "COLLABORATOR"
28361
+ "author_association": "COLLABORATOR",
28362
+ "state_reason": "completed"
28078
28363
  }
28079
28364
  }
28080
28365
  },
@@ -30002,7 +30287,8 @@
30002
30287
  "body": "...",
30003
30288
  "score": 1,
30004
30289
  "locked": true,
30005
- "author_association": "COLLABORATOR"
30290
+ "author_association": "COLLABORATOR",
30291
+ "state_reason": "completed"
30006
30292
  }
30007
30293
  ]
30008
30294
  }