@octokit/openapi 6.1.4 → 6.3.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 (29) hide show
  1. package/generated/api.github.com.deref.json +12366 -10615
  2. package/generated/api.github.com.json +3916 -3453
  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 +1 -1
  6. package/generated/ghes-3.2-diff-to-ghes-3.3.json +1 -1
  7. package/generated/ghes-3.2.deref.json +187 -7
  8. package/generated/ghes-3.2.json +190 -29
  9. package/generated/ghes-3.3-anicca-diff-to-ghes-3.4.deref.json +23 -0
  10. package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json +96 -1
  11. package/generated/ghes-3.3-diff-to-ghes-3.4.json +92 -1
  12. package/generated/ghes-3.3.deref.json +371 -1395
  13. package/generated/ghes-3.3.json +491 -315
  14. package/generated/ghes-3.4-anicca-diff-to-ghes-3.5.deref.json +0 -14
  15. package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json +7801 -10209
  16. package/generated/ghes-3.4-diff-to-ghes-3.5.json +341 -326
  17. package/generated/ghes-3.4.deref.json +1434 -3653
  18. package/generated/ghes-3.4.json +1184 -1001
  19. package/generated/ghes-3.5-anicca-diff-to-api.github.com.deref.json +69 -73
  20. package/generated/ghes-3.5-diff-to-api.github.com.deref.json +28230 -31386
  21. package/generated/ghes-3.5-diff-to-api.github.com.json +813 -744
  22. package/generated/ghes-3.5.deref.json +1692 -4983
  23. package/generated/ghes-3.5.json +2093 -2049
  24. package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +92 -0
  25. package/generated/github.ae-diff-to-api.github.com.deref.json +488 -1
  26. package/generated/github.ae-diff-to-api.github.com.json +362 -12
  27. package/generated/github.ae.deref.json +253 -104
  28. package/generated/github.ae.json +263 -81
  29. package/package.json +1 -1
@@ -5524,6 +5524,29 @@
5524
5524
  }
5525
5525
  }
5526
5526
  },
5527
+ "/orgs/{org}/actions/secrets/{secret_name}": {
5528
+ "put": {
5529
+ "request_body": {
5530
+ "content_changed": {
5531
+ "changed": {
5532
+ "application/json": {
5533
+ "schema_changed": {
5534
+ "properties_changed": {
5535
+ "changed": {
5536
+ "selected_repository_ids": {
5537
+ "items_changed": {
5538
+ "type_changed": { "to": "integer" }
5539
+ }
5540
+ }
5541
+ }
5542
+ }
5543
+ }
5544
+ }
5545
+ }
5546
+ }
5547
+ }
5548
+ }
5549
+ },
5527
5550
  "/orgs/{org}/actions/secrets/{secret_name}/repositories": {
5528
5551
  "get": {
5529
5552
  "responses": {
@@ -6424,6 +6447,65 @@
6424
6447
  }
6425
6448
  }
6426
6449
  },
6450
+ "/repos/{owner}/{repo}/autolinks": {
6451
+ "get": {
6452
+ "responses": {
6453
+ "changed": {
6454
+ "200": {
6455
+ "content": {
6456
+ "changed": {
6457
+ "application/json": {
6458
+ "schema_changed": {
6459
+ "items_changed": {
6460
+ "properties_changed": {
6461
+ "removed": ["is_alphanumeric"]
6462
+ }
6463
+ }
6464
+ }
6465
+ }
6466
+ }
6467
+ }
6468
+ }
6469
+ }
6470
+ }
6471
+ },
6472
+ "post": {
6473
+ "responses": {
6474
+ "changed": {
6475
+ "201": {
6476
+ "content": {
6477
+ "changed": {
6478
+ "application/json": {
6479
+ "schema_changed": {
6480
+ "properties_changed": { "removed": ["is_alphanumeric"] }
6481
+ }
6482
+ }
6483
+ }
6484
+ }
6485
+ }
6486
+ }
6487
+ }
6488
+ }
6489
+ },
6490
+ "/repos/{owner}/{repo}/autolinks/{autolink_id}": {
6491
+ "get": {
6492
+ "responses": {
6493
+ "changed": {
6494
+ "200": {
6495
+ "content": {
6496
+ "changed": {
6497
+ "application/json": {
6498
+ "schema_changed": {
6499
+ "properties_changed": { "removed": ["is_alphanumeric"] }
6500
+ }
6501
+ }
6502
+ }
6503
+ }
6504
+ }
6505
+ }
6506
+ }
6507
+ }
6508
+ },
6427
6509
  "/repos/{owner}/{repo}/check-suites": {
6428
6510
  "post": {
6429
6511
  "responses": {
@@ -8892,6 +8974,7 @@
8892
8974
  "/authorizations/{authorization_id}": ["get", "delete", "patch"],
8893
8975
  "/enterprise-installation/{enterprise_or_org}/server-statistics": ["get"],
8894
8976
  "/enterprises/{enterprise}/actions/cache/usage": ["get"],
8977
+ "/enterprises/{enterprise}/actions/oidc/customization/issuer": ["put"],
8895
8978
  "/enterprises/{enterprise}/actions/permissions/workflow": ["get", "put"],
8896
8979
  "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": [
8897
8980
  "get",
@@ -8926,6 +9009,7 @@
8926
9009
  "/organizations/{organization_id}/custom_roles": ["get"],
8927
9010
  "/orgs/{org}/actions/cache/usage": ["get"],
8928
9011
  "/orgs/{org}/actions/cache/usage-by-repository": ["get"],
9012
+ "/orgs/{org}/actions/oidc/customization/sub": ["get", "put"],
8929
9013
  "/orgs/{org}/actions/permissions/workflow": ["get", "put"],
8930
9014
  "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": [
8931
9015
  "get",
@@ -8949,6 +9033,7 @@
8949
9033
  "/orgs/{org}/blocks": ["get"],
8950
9034
  "/orgs/{org}/blocks/{username}": ["get", "put", "delete"],
8951
9035
  "/orgs/{org}/code-scanning/alerts": ["get"],
9036
+ "/orgs/{org}/codespaces": ["get"],
8952
9037
  "/orgs/{org}/credential-authorizations": ["get"],
8953
9038
  "/orgs/{org}/credential-authorizations/{credential_id}": ["delete"],
8954
9039
  "/orgs/{org}/dependabot/secrets": ["get"],
@@ -8968,6 +9053,10 @@
8968
9053
  "/orgs/{org}/invitations": ["get", "post"],
8969
9054
  "/orgs/{org}/invitations/{invitation_id}": ["delete"],
8970
9055
  "/orgs/{org}/invitations/{invitation_id}/teams": ["get"],
9056
+ "/orgs/{org}/members/{username}/codespaces/{codespace_name}": ["delete"],
9057
+ "/orgs/{org}/members/{username}/codespaces/{codespace_name}/stop": [
9058
+ "post"
9059
+ ],
8971
9060
  "/orgs/{org}/migrations/{migration_id}/archive": ["get", "delete"],
8972
9061
  "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": [
8973
9062
  "delete"
@@ -8998,7 +9087,10 @@
8998
9087
  "patch"
8999
9088
  ],
9000
9089
  "/repos/{owner}/{repo}/actions/cache/usage": ["get"],
9090
+ "/repos/{owner}/{repo}/actions/caches": ["get", "delete"],
9091
+ "/repos/{owner}/{repo}/actions/caches/{cache_id}": ["delete"],
9001
9092
  "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": ["post"],
9093
+ "/repos/{owner}/{repo}/actions/oidc/customization/sub": ["get", "put"],
9002
9094
  "/repos/{owner}/{repo}/actions/permissions/access": ["get", "put"],
9003
9095
  "/repos/{owner}/{repo}/actions/permissions/workflow": ["get", "put"],
9004
9096
  "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": [
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "6.1.4",
4
+ "version": "6.3.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -18593,6 +18593,101 @@
18593
18593
  "x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
18594
18594
  }
18595
18595
  },
18596
+ "/orgs/{org}/actions/secrets/{secret_name}": {
18597
+ "put": {
18598
+ "summary": "Create or update an organization secret",
18599
+ "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to\nuse this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```",
18600
+ "tags": ["actions"],
18601
+ "operationId": "actions/create-or-update-org-secret",
18602
+ "externalDocs": {
18603
+ "description": "API method documentation",
18604
+ "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#create-or-update-an-organization-secret"
18605
+ },
18606
+ "parameters": [
18607
+ {
18608
+ "name": "org",
18609
+ "description": "The organization name. The name is not case sensitive.",
18610
+ "in": "path",
18611
+ "required": true,
18612
+ "schema": { "type": "string" }
18613
+ },
18614
+ {
18615
+ "name": "secret_name",
18616
+ "description": "The name of the secret.",
18617
+ "in": "path",
18618
+ "required": true,
18619
+ "schema": { "type": "string" }
18620
+ }
18621
+ ],
18622
+ "requestBody": {
18623
+ "required": true,
18624
+ "content": {
18625
+ "application/json": {
18626
+ "schema": {
18627
+ "type": "object",
18628
+ "properties": {
18629
+ "encrypted_value": {
18630
+ "type": "string",
18631
+ "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-organization-public-key) endpoint.",
18632
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
18633
+ },
18634
+ "key_id": {
18635
+ "type": "string",
18636
+ "description": "ID of the key you used to encrypt the secret."
18637
+ },
18638
+ "visibility": {
18639
+ "type": "string",
18640
+ "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.",
18641
+ "enum": ["all", "private", "selected"]
18642
+ },
18643
+ "selected_repository_ids": {
18644
+ "type": "array",
18645
+ "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.",
18646
+ "items": { "type": "integer" }
18647
+ }
18648
+ },
18649
+ "required": ["visibility"]
18650
+ },
18651
+ "examples": {
18652
+ "default": {
18653
+ "value": {
18654
+ "encrypted_value": "c2VjcmV0",
18655
+ "key_id": "012345678912345678",
18656
+ "visibility": "selected",
18657
+ "selected_repository_ids": [1296269, 1296280]
18658
+ }
18659
+ }
18660
+ }
18661
+ }
18662
+ }
18663
+ },
18664
+ "responses": {
18665
+ "201": {
18666
+ "description": "Response when creating a secret",
18667
+ "content": {
18668
+ "application/json": {
18669
+ "schema": {
18670
+ "title": "Empty Object",
18671
+ "description": "An object without any properties.",
18672
+ "type": "object",
18673
+ "properties": {},
18674
+ "additionalProperties": false
18675
+ },
18676
+ "examples": { "default": { "value": null } }
18677
+ }
18678
+ }
18679
+ },
18680
+ "204": { "description": "Response when updating a secret" }
18681
+ },
18682
+ "x-github": {
18683
+ "githubCloudOnly": false,
18684
+ "enabledForGitHubApps": true,
18685
+ "category": "actions",
18686
+ "subcategory": "secrets"
18687
+ },
18688
+ "x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
18689
+ }
18690
+ },
18596
18691
  "/orgs/{org}/actions/secrets/{secret_name}/repositories": {
18597
18692
  "get": {
18598
18693
  "summary": "List selected repositories for an organization secret",
@@ -55354,6 +55449,333 @@
55354
55449
  "x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
55355
55450
  }
55356
55451
  },
55452
+ "/repos/{owner}/{repo}/autolinks": {
55453
+ "get": {
55454
+ "summary": "List all autolinks of a repository",
55455
+ "description": "This returns a list of autolinks configured for the given repository.\n\nInformation about autolinks are only available to repository administrators.",
55456
+ "tags": ["repos"],
55457
+ "operationId": "repos/list-autolinks",
55458
+ "externalDocs": {
55459
+ "description": "API method documentation",
55460
+ "url": "https://docs.github.com/github-ae@latest/v3/repos#list-autolinks"
55461
+ },
55462
+ "parameters": [
55463
+ {
55464
+ "name": "owner",
55465
+ "description": "The account owner of the repository. The name is not case sensitive.",
55466
+ "in": "path",
55467
+ "required": true,
55468
+ "schema": { "type": "string" }
55469
+ },
55470
+ {
55471
+ "name": "repo",
55472
+ "description": "The name of the repository. The name is not case sensitive.",
55473
+ "in": "path",
55474
+ "required": true,
55475
+ "schema": { "type": "string" }
55476
+ },
55477
+ {
55478
+ "name": "page",
55479
+ "description": "Page number of the results to fetch.",
55480
+ "in": "query",
55481
+ "schema": { "type": "integer", "default": 1 }
55482
+ }
55483
+ ],
55484
+ "responses": {
55485
+ "200": {
55486
+ "description": "Response",
55487
+ "content": {
55488
+ "application/json": {
55489
+ "schema": {
55490
+ "type": "array",
55491
+ "items": {
55492
+ "title": "Autolink reference",
55493
+ "description": "An autolink reference.",
55494
+ "type": "object",
55495
+ "properties": {
55496
+ "id": { "type": "integer", "example": 3 },
55497
+ "key_prefix": {
55498
+ "description": "The prefix of a key that is linkified.",
55499
+ "example": "TICKET-",
55500
+ "type": "string"
55501
+ },
55502
+ "url_template": {
55503
+ "description": "A template for the target URL that is generated if a key was found.",
55504
+ "example": "https://example.com/TICKET?query=<num>",
55505
+ "type": "string"
55506
+ }
55507
+ },
55508
+ "required": ["id", "key_prefix", "url_template"]
55509
+ }
55510
+ },
55511
+ "examples": {
55512
+ "default": {
55513
+ "value": [
55514
+ {
55515
+ "id": 1,
55516
+ "key_prefix": "TICKET-",
55517
+ "url_template": "https://example.com/TICKET?query=<num>"
55518
+ }
55519
+ ]
55520
+ }
55521
+ }
55522
+ }
55523
+ }
55524
+ }
55525
+ },
55526
+ "x-github": {
55527
+ "githubCloudOnly": false,
55528
+ "enabledForGitHubApps": true,
55529
+ "category": "repos",
55530
+ "subcategory": "autolinks"
55531
+ },
55532
+ "x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
55533
+ },
55534
+ "post": {
55535
+ "summary": "Create an autolink reference for a repository",
55536
+ "description": "Users with admin access to the repository can create an autolink.",
55537
+ "tags": ["repos"],
55538
+ "operationId": "repos/create-autolink",
55539
+ "externalDocs": {
55540
+ "description": "API method documentation",
55541
+ "url": "https://docs.github.com/github-ae@latest/v3/repos#create-an-autolink"
55542
+ },
55543
+ "parameters": [
55544
+ {
55545
+ "name": "owner",
55546
+ "description": "The account owner of the repository. The name is not case sensitive.",
55547
+ "in": "path",
55548
+ "required": true,
55549
+ "schema": { "type": "string" }
55550
+ },
55551
+ {
55552
+ "name": "repo",
55553
+ "description": "The name of the repository. The name is not case sensitive.",
55554
+ "in": "path",
55555
+ "required": true,
55556
+ "schema": { "type": "string" }
55557
+ }
55558
+ ],
55559
+ "requestBody": {
55560
+ "required": true,
55561
+ "content": {
55562
+ "application/json": {
55563
+ "schema": {
55564
+ "type": "object",
55565
+ "properties": {
55566
+ "key_prefix": {
55567
+ "type": "string",
55568
+ "description": "The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit."
55569
+ },
55570
+ "url_template": {
55571
+ "type": "string",
55572
+ "description": "The URL must contain `<num>` for the reference number."
55573
+ }
55574
+ },
55575
+ "required": ["key_prefix", "url_template"]
55576
+ },
55577
+ "examples": {
55578
+ "default": {
55579
+ "value": {
55580
+ "key_prefix": "TICKET-",
55581
+ "url_template": "https://example.com/TICKET?query=<num>"
55582
+ }
55583
+ }
55584
+ }
55585
+ }
55586
+ }
55587
+ },
55588
+ "responses": {
55589
+ "201": {
55590
+ "description": "response",
55591
+ "content": {
55592
+ "application/json": {
55593
+ "schema": {
55594
+ "title": "Autolink reference",
55595
+ "description": "An autolink reference.",
55596
+ "type": "object",
55597
+ "properties": {
55598
+ "id": { "type": "integer", "example": 3 },
55599
+ "key_prefix": {
55600
+ "description": "The prefix of a key that is linkified.",
55601
+ "example": "TICKET-",
55602
+ "type": "string"
55603
+ },
55604
+ "url_template": {
55605
+ "description": "A template for the target URL that is generated if a key was found.",
55606
+ "example": "https://example.com/TICKET?query=<num>",
55607
+ "type": "string"
55608
+ }
55609
+ },
55610
+ "required": ["id", "key_prefix", "url_template"]
55611
+ },
55612
+ "examples": {
55613
+ "default": {
55614
+ "value": {
55615
+ "id": 1,
55616
+ "key_prefix": "TICKET-",
55617
+ "url_template": "https://example.com/TICKET?query=<num>"
55618
+ }
55619
+ }
55620
+ }
55621
+ }
55622
+ },
55623
+ "headers": {
55624
+ "Location": {
55625
+ "example": "https://api.github.com/repos/octocat/Hello-World/autolinks/1",
55626
+ "schema": { "type": "string" }
55627
+ }
55628
+ }
55629
+ },
55630
+ "422": {
55631
+ "description": "Validation failed",
55632
+ "content": {
55633
+ "application/json": {
55634
+ "schema": {
55635
+ "title": "Validation Error",
55636
+ "description": "Validation Error",
55637
+ "type": "object",
55638
+ "required": ["message", "documentation_url"],
55639
+ "properties": {
55640
+ "message": { "type": "string" },
55641
+ "documentation_url": { "type": "string" },
55642
+ "errors": {
55643
+ "type": "array",
55644
+ "items": {
55645
+ "type": "object",
55646
+ "required": ["code"],
55647
+ "properties": {
55648
+ "resource": { "type": "string" },
55649
+ "field": { "type": "string" },
55650
+ "message": { "type": "string" },
55651
+ "code": { "type": "string" },
55652
+ "index": { "type": "integer" },
55653
+ "value": {
55654
+ "oneOf": [
55655
+ { "type": "string", "nullable": true },
55656
+ { "type": "integer", "nullable": true },
55657
+ {
55658
+ "type": "array",
55659
+ "nullable": true,
55660
+ "items": { "type": "string" }
55661
+ }
55662
+ ]
55663
+ }
55664
+ }
55665
+ }
55666
+ }
55667
+ }
55668
+ }
55669
+ }
55670
+ }
55671
+ }
55672
+ },
55673
+ "x-github": {
55674
+ "githubCloudOnly": false,
55675
+ "enabledForGitHubApps": true,
55676
+ "category": "repos",
55677
+ "subcategory": "autolinks"
55678
+ },
55679
+ "x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
55680
+ }
55681
+ },
55682
+ "/repos/{owner}/{repo}/autolinks/{autolink_id}": {
55683
+ "get": {
55684
+ "summary": "Get an autolink reference of a repository",
55685
+ "description": "This returns a single autolink reference by ID that was configured for the given repository.\n\nInformation about autolinks are only available to repository administrators.",
55686
+ "tags": ["repos"],
55687
+ "operationId": "repos/get-autolink",
55688
+ "externalDocs": {
55689
+ "description": "API method documentation",
55690
+ "url": "https://docs.github.com/github-ae@latest/v3/repos#get-autolink"
55691
+ },
55692
+ "parameters": [
55693
+ {
55694
+ "name": "owner",
55695
+ "description": "The account owner of the repository. The name is not case sensitive.",
55696
+ "in": "path",
55697
+ "required": true,
55698
+ "schema": { "type": "string" }
55699
+ },
55700
+ {
55701
+ "name": "repo",
55702
+ "description": "The name of the repository. The name is not case sensitive.",
55703
+ "in": "path",
55704
+ "required": true,
55705
+ "schema": { "type": "string" }
55706
+ },
55707
+ {
55708
+ "name": "autolink_id",
55709
+ "description": "The unique identifier of the autolink.",
55710
+ "in": "path",
55711
+ "required": true,
55712
+ "schema": { "type": "integer" }
55713
+ }
55714
+ ],
55715
+ "responses": {
55716
+ "200": {
55717
+ "description": "Response",
55718
+ "content": {
55719
+ "application/json": {
55720
+ "schema": {
55721
+ "title": "Autolink reference",
55722
+ "description": "An autolink reference.",
55723
+ "type": "object",
55724
+ "properties": {
55725
+ "id": { "type": "integer", "example": 3 },
55726
+ "key_prefix": {
55727
+ "description": "The prefix of a key that is linkified.",
55728
+ "example": "TICKET-",
55729
+ "type": "string"
55730
+ },
55731
+ "url_template": {
55732
+ "description": "A template for the target URL that is generated if a key was found.",
55733
+ "example": "https://example.com/TICKET?query=<num>",
55734
+ "type": "string"
55735
+ }
55736
+ },
55737
+ "required": ["id", "key_prefix", "url_template"]
55738
+ },
55739
+ "examples": {
55740
+ "default": {
55741
+ "value": {
55742
+ "id": 1,
55743
+ "key_prefix": "TICKET-",
55744
+ "url_template": "https://example.com/TICKET?query=<num>"
55745
+ }
55746
+ }
55747
+ }
55748
+ }
55749
+ }
55750
+ },
55751
+ "404": {
55752
+ "description": "Resource not found",
55753
+ "content": {
55754
+ "application/json": {
55755
+ "schema": {
55756
+ "title": "Basic Error",
55757
+ "description": "Basic Error",
55758
+ "type": "object",
55759
+ "properties": {
55760
+ "message": { "type": "string" },
55761
+ "documentation_url": { "type": "string" },
55762
+ "url": { "type": "string" },
55763
+ "status": { "type": "string" }
55764
+ }
55765
+ }
55766
+ }
55767
+ }
55768
+ }
55769
+ },
55770
+ "x-github": {
55771
+ "githubCloudOnly": false,
55772
+ "enabledForGitHubApps": true,
55773
+ "category": "repos",
55774
+ "subcategory": "autolinks"
55775
+ },
55776
+ "x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
55777
+ }
55778
+ },
55357
55779
  "/repos/{owner}/{repo}/check-suites": {
55358
55780
  "post": {
55359
55781
  "summary": "Create a check suite",
@@ -76982,6 +77404,71 @@
76982
77404
  "created_at"
76983
77405
  ]
76984
77406
  }
77407
+ },
77408
+ "examples": {
77409
+ "200-response": {
77410
+ "value": [
77411
+ {
77412
+ "id": "22249084964",
77413
+ "type": "PushEvent",
77414
+ "actor": {
77415
+ "id": 583231,
77416
+ "login": "octocat",
77417
+ "display_login": "octocat",
77418
+ "gravatar_id": "",
77419
+ "url": "https://api.github.com/users/octocat",
77420
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
77421
+ },
77422
+ "repo": {
77423
+ "id": 1296269,
77424
+ "name": "octocat/Hello-World",
77425
+ "url": "https://api.github.com/repos/octocat/Hello-World"
77426
+ },
77427
+ "payload": {
77428
+ "push_id": 10115855396,
77429
+ "size": 1,
77430
+ "distinct_size": 1,
77431
+ "ref": "refs/heads/master",
77432
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
77433
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
77434
+ "commits": [
77435
+ {
77436
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
77437
+ "author": {
77438
+ "email": "octocat@github.com",
77439
+ "name": "Monalisa Octocat"
77440
+ },
77441
+ "message": "commit",
77442
+ "distinct": true,
77443
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
77444
+ }
77445
+ ]
77446
+ },
77447
+ "public": true,
77448
+ "created_at": "2022-06-09T12:47:28Z"
77449
+ },
77450
+ {
77451
+ "id": "22237752260",
77452
+ "type": "WatchEvent",
77453
+ "actor": {
77454
+ "id": 583231,
77455
+ "login": "octocat",
77456
+ "display_login": "octocat",
77457
+ "gravatar_id": "",
77458
+ "url": "https://api.github.com/users/octocat",
77459
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
77460
+ },
77461
+ "repo": {
77462
+ "id": 1296269,
77463
+ "name": "octocat/Hello-World",
77464
+ "url": "https://api.github.com/repos/octocat/Hello-World"
77465
+ },
77466
+ "payload": { "action": "started" },
77467
+ "public": true,
77468
+ "created_at": "2022-06-08T23:29:25Z"
77469
+ }
77470
+ ]
77471
+ }
76985
77472
  }
76986
77473
  }
76987
77474
  }