@octokit/openapi 6.4.0 → 6.6.1

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 (28) hide show
  1. package/generated/api.github.com.deref.json +23 -3
  2. package/generated/api.github.com.json +16 -4
  3. package/generated/ghes-3.2-anicca-diff-to-ghes-3.3.deref.json +3232 -174
  4. package/generated/ghes-3.2-diff-to-api.github.com.deref.json +1 -1
  5. package/generated/ghes-3.2-diff-to-api.github.com.json +1 -1
  6. package/generated/ghes-3.2-diff-to-ghes-3.3.deref.json +148129 -3632
  7. package/generated/ghes-3.2-diff-to-ghes-3.3.json +19589 -2088
  8. package/generated/ghes-3.2.deref.json +110 -790
  9. package/generated/ghes-3.2.json +143 -185
  10. package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json +2 -2
  11. package/generated/ghes-3.3-diff-to-ghes-3.4.json +52 -52
  12. package/generated/ghes-3.3.deref.json +45 -45
  13. package/generated/ghes-3.3.json +136 -136
  14. package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json +1 -1
  15. package/generated/ghes-3.4-diff-to-ghes-3.5.json +49 -49
  16. package/generated/ghes-3.4.deref.json +35 -26
  17. package/generated/ghes-3.4.json +105 -96
  18. package/generated/ghes-3.5-anicca-diff-to-api.github.com.deref.json +27 -0
  19. package/generated/ghes-3.5-diff-to-api.github.com.deref.json +230 -2
  20. package/generated/ghes-3.5-diff-to-api.github.com.json +348 -419
  21. package/generated/ghes-3.5.deref.json +185 -176
  22. package/generated/ghes-3.5.json +549 -764
  23. package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +27 -0
  24. package/generated/github.ae-diff-to-api.github.com.deref.json +229 -1
  25. package/generated/github.ae-diff-to-api.github.com.json +296 -335
  26. package/generated/github.ae.deref.json +268 -259
  27. package/generated/github.ae.json +667 -850
  28. package/package.json +7 -4
@@ -9227,6 +9227,33 @@
9227
9227
  }
9228
9228
  }
9229
9229
  },
9230
+ "/rate_limit": {
9231
+ "get": {
9232
+ "responses": {
9233
+ "changed": {
9234
+ "200": {
9235
+ "content": {
9236
+ "changed": {
9237
+ "application/json": {
9238
+ "schema_changed": {
9239
+ "properties_changed": {
9240
+ "changed": {
9241
+ "resources": {
9242
+ "properties_changed": {
9243
+ "removed": ["dependency_snapshots"]
9244
+ }
9245
+ }
9246
+ }
9247
+ }
9248
+ }
9249
+ }
9250
+ }
9251
+ }
9252
+ }
9253
+ }
9254
+ }
9255
+ }
9256
+ },
9230
9257
  "/repos/{owner}/{repo}": {
9231
9258
  "get": {
9232
9259
  "responses": {
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "6.4.0",
4
+ "version": "6.6.1",
5
5
  "title": "GitHub's official OpenAPI spec + Octokit extension",
6
6
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
7
7
  "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -22078,7 +22078,7 @@
22078
22078
  },
22079
22079
  "members_allowed_repository_creation_type": {
22080
22080
  "type": "string",
22081
- "description": "Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.",
22081
+ "description": "Specifies which types of repositories non-admin organization members can create. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.",
22082
22082
  "enum": ["all", "private", "none"]
22083
22083
  },
22084
22084
  "members_can_create_pages": {
@@ -37724,6 +37724,7 @@
37724
37724
  },
37725
37725
  "exclude": {
37726
37726
  "type": "array",
37727
+ "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.",
37727
37728
  "items": { "type": "string", "enum": ["repositories"] }
37728
37729
  }
37729
37730
  },
@@ -47707,6 +47708,225 @@
47707
47708
  "x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
47708
47709
  }
47709
47710
  },
47711
+ "/rate_limit": {
47712
+ "get": {
47713
+ "summary": "Get rate limit status for the authenticated user",
47714
+ "description": "**Note:** Accessing this endpoint does not count against your REST API rate limit.\n\n**Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.",
47715
+ "tags": ["rate-limit"],
47716
+ "operationId": "rate-limit/get",
47717
+ "externalDocs": {
47718
+ "description": "API method documentation",
47719
+ "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/rate-limit#get-rate-limit-status-for-the-authenticated-user"
47720
+ },
47721
+ "parameters": [],
47722
+ "responses": {
47723
+ "200": {
47724
+ "description": "Response",
47725
+ "content": {
47726
+ "application/json": {
47727
+ "schema": {
47728
+ "title": "Rate Limit Overview",
47729
+ "description": "Rate Limit Overview",
47730
+ "type": "object",
47731
+ "properties": {
47732
+ "resources": {
47733
+ "type": "object",
47734
+ "properties": {
47735
+ "core": {
47736
+ "title": "Rate Limit",
47737
+ "type": "object",
47738
+ "properties": {
47739
+ "limit": { "type": "integer" },
47740
+ "remaining": { "type": "integer" },
47741
+ "reset": { "type": "integer" },
47742
+ "used": { "type": "integer" }
47743
+ },
47744
+ "required": ["limit", "remaining", "reset", "used"]
47745
+ },
47746
+ "graphql": {
47747
+ "title": "Rate Limit",
47748
+ "type": "object",
47749
+ "properties": {
47750
+ "limit": { "type": "integer" },
47751
+ "remaining": { "type": "integer" },
47752
+ "reset": { "type": "integer" },
47753
+ "used": { "type": "integer" }
47754
+ },
47755
+ "required": ["limit", "remaining", "reset", "used"]
47756
+ },
47757
+ "search": {
47758
+ "title": "Rate Limit",
47759
+ "type": "object",
47760
+ "properties": {
47761
+ "limit": { "type": "integer" },
47762
+ "remaining": { "type": "integer" },
47763
+ "reset": { "type": "integer" },
47764
+ "used": { "type": "integer" }
47765
+ },
47766
+ "required": ["limit", "remaining", "reset", "used"]
47767
+ },
47768
+ "source_import": {
47769
+ "title": "Rate Limit",
47770
+ "type": "object",
47771
+ "properties": {
47772
+ "limit": { "type": "integer" },
47773
+ "remaining": { "type": "integer" },
47774
+ "reset": { "type": "integer" },
47775
+ "used": { "type": "integer" }
47776
+ },
47777
+ "required": ["limit", "remaining", "reset", "used"]
47778
+ },
47779
+ "integration_manifest": {
47780
+ "title": "Rate Limit",
47781
+ "type": "object",
47782
+ "properties": {
47783
+ "limit": { "type": "integer" },
47784
+ "remaining": { "type": "integer" },
47785
+ "reset": { "type": "integer" },
47786
+ "used": { "type": "integer" }
47787
+ },
47788
+ "required": ["limit", "remaining", "reset", "used"]
47789
+ },
47790
+ "code_scanning_upload": {
47791
+ "title": "Rate Limit",
47792
+ "type": "object",
47793
+ "properties": {
47794
+ "limit": { "type": "integer" },
47795
+ "remaining": { "type": "integer" },
47796
+ "reset": { "type": "integer" },
47797
+ "used": { "type": "integer" }
47798
+ },
47799
+ "required": ["limit", "remaining", "reset", "used"]
47800
+ },
47801
+ "actions_runner_registration": {
47802
+ "title": "Rate Limit",
47803
+ "type": "object",
47804
+ "properties": {
47805
+ "limit": { "type": "integer" },
47806
+ "remaining": { "type": "integer" },
47807
+ "reset": { "type": "integer" },
47808
+ "used": { "type": "integer" }
47809
+ },
47810
+ "required": ["limit", "remaining", "reset", "used"]
47811
+ },
47812
+ "scim": {
47813
+ "title": "Rate Limit",
47814
+ "type": "object",
47815
+ "properties": {
47816
+ "limit": { "type": "integer" },
47817
+ "remaining": { "type": "integer" },
47818
+ "reset": { "type": "integer" },
47819
+ "used": { "type": "integer" }
47820
+ },
47821
+ "required": ["limit", "remaining", "reset", "used"]
47822
+ }
47823
+ },
47824
+ "required": ["core", "search"]
47825
+ },
47826
+ "rate": {
47827
+ "title": "Rate Limit",
47828
+ "type": "object",
47829
+ "properties": {
47830
+ "limit": { "type": "integer" },
47831
+ "remaining": { "type": "integer" },
47832
+ "reset": { "type": "integer" },
47833
+ "used": { "type": "integer" }
47834
+ },
47835
+ "required": ["limit", "remaining", "reset", "used"]
47836
+ }
47837
+ },
47838
+ "required": ["rate", "resources"]
47839
+ },
47840
+ "examples": {
47841
+ "default": {
47842
+ "value": {
47843
+ "resources": {
47844
+ "core": {
47845
+ "limit": 5000,
47846
+ "remaining": 4999,
47847
+ "reset": 1372700873,
47848
+ "used": 1
47849
+ },
47850
+ "search": {
47851
+ "limit": 30,
47852
+ "remaining": 18,
47853
+ "reset": 1372697452,
47854
+ "used": 12
47855
+ },
47856
+ "graphql": {
47857
+ "limit": 5000,
47858
+ "remaining": 4993,
47859
+ "reset": 1372700389,
47860
+ "used": 7
47861
+ },
47862
+ "integration_manifest": {
47863
+ "limit": 5000,
47864
+ "remaining": 4999,
47865
+ "reset": 1551806725,
47866
+ "used": 1
47867
+ },
47868
+ "code_scanning_upload": {
47869
+ "limit": 500,
47870
+ "remaining": 499,
47871
+ "reset": 1551806725,
47872
+ "used": 1
47873
+ }
47874
+ },
47875
+ "rate": {
47876
+ "limit": 5000,
47877
+ "remaining": 4999,
47878
+ "reset": 1372700873,
47879
+ "used": 1
47880
+ }
47881
+ }
47882
+ }
47883
+ }
47884
+ }
47885
+ },
47886
+ "headers": {
47887
+ "X-RateLimit-Limit": {
47888
+ "example": 5000,
47889
+ "schema": { "type": "integer" }
47890
+ },
47891
+ "X-RateLimit-Remaining": {
47892
+ "example": 4999,
47893
+ "schema": { "type": "integer" }
47894
+ },
47895
+ "X-RateLimit-Reset": {
47896
+ "example": 1590701888,
47897
+ "schema": { "type": "integer", "format": "timestamp" }
47898
+ }
47899
+ }
47900
+ },
47901
+ "304": { "description": "Not modified" },
47902
+ "404": {
47903
+ "description": "Resource not found",
47904
+ "content": {
47905
+ "application/json": {
47906
+ "schema": {
47907
+ "title": "Basic Error",
47908
+ "description": "Basic Error",
47909
+ "type": "object",
47910
+ "properties": {
47911
+ "message": { "type": "string" },
47912
+ "documentation_url": { "type": "string" },
47913
+ "url": { "type": "string" },
47914
+ "status": { "type": "string" }
47915
+ }
47916
+ }
47917
+ }
47918
+ }
47919
+ }
47920
+ },
47921
+ "x-github": {
47922
+ "githubCloudOnly": false,
47923
+ "enabledForGitHubApps": true,
47924
+ "category": "rate-limit",
47925
+ "subcategory": null
47926
+ },
47927
+ "x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
47928
+ }
47929
+ },
47710
47930
  "/repos/{owner}/{repo}": {
47711
47931
  "get": {
47712
47932
  "summary": "Get a repository",
@@ -151011,6 +151231,14 @@
151011
151231
  },
151012
151232
  "required": ["repositories"],
151013
151233
  "type": "object"
151234
+ },
151235
+ "examples": {
151236
+ "default": {
151237
+ "value": {
151238
+ "repositories": ["octocat/Hello-World"],
151239
+ "lock_repositories": true
151240
+ }
151241
+ }
151014
151242
  }
151015
151243
  }
151016
151244
  }