@octokit/openapi 14.0.0 → 14.1.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.
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "14.0.0",
4
+ "version": "14.1.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": {
@@ -8365,7 +8365,7 @@
8365
8365
  "/feeds": {
8366
8366
  "get": {
8367
8367
  "summary": "Get feeds",
8368
- "description": "GitHub Enterprise Server provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:\n\n* **Timeline**: The GitHub Enterprise Server global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server.\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.",
8368
+ "description": "Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.\n\n* **Timeline**: The GitHub Enterprise Server global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server.\n\nBy default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.",
8369
8369
  "tags": [
8370
8370
  "activity"
8371
8371
  ],
@@ -11085,7 +11085,7 @@
11085
11085
  "/organizations": {
11086
11086
  "get": {
11087
11087
  "summary": "List organizations",
11088
- "description": "Lists all organizations, in the order that they were created on GitHub Enterprise Server.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.",
11088
+ "description": "Lists all organizations, in the order that they were created.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.",
11089
11089
  "tags": [
11090
11090
  "orgs"
11091
11091
  ],
@@ -31437,11 +31437,14 @@
31437
31437
  },
31438
31438
  "status": {
31439
31439
  "type": "string",
31440
- "description": "The current status.",
31440
+ "description": "The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.",
31441
31441
  "enum": [
31442
31442
  "queued",
31443
31443
  "in_progress",
31444
- "completed"
31444
+ "completed",
31445
+ "waiting",
31446
+ "requested",
31447
+ "pending"
31445
31448
  ]
31446
31449
  },
31447
31450
  "conclusion": {
@@ -34088,6 +34091,9 @@
34088
34091
  }
34089
34092
  }
34090
34093
  },
34094
+ "409": {
34095
+ "$ref": "#/components/responses/conflict"
34096
+ },
34091
34097
  "422": {
34092
34098
  "$ref": "#/components/responses/validation_failed"
34093
34099
  }
@@ -34319,6 +34325,9 @@
34319
34325
  "$ref": "#/components/headers/link"
34320
34326
  }
34321
34327
  }
34328
+ },
34329
+ "409": {
34330
+ "$ref": "#/components/responses/conflict"
34322
34331
  }
34323
34332
  },
34324
34333
  "x-github": {
@@ -34378,6 +34387,9 @@
34378
34387
  "404": {
34379
34388
  "$ref": "#/components/responses/not_found"
34380
34389
  },
34390
+ "409": {
34391
+ "$ref": "#/components/responses/conflict"
34392
+ },
34381
34393
  "422": {
34382
34394
  "$ref": "#/components/responses/validation_failed"
34383
34395
  },
@@ -34715,7 +34727,7 @@
34715
34727
  "/repos/{owner}/{repo}/compare/{basehead}": {
34716
34728
  "get": {
34717
34729
  "summary": "Compare two commits",
34718
- "description": "Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.9/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\nWhen calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
34730
+ "description": "Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.9/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\nWhen calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
34719
34731
  "tags": [
34720
34732
  "repos"
34721
34733
  ],
@@ -37322,6 +37334,616 @@
37322
37334
  "x-octokit": {}
37323
37335
  }
37324
37336
  },
37337
+ "/repos/{owner}/{repo}/environments/{environment_name}/secrets": {
37338
+ "get": {
37339
+ "summary": "List environment secrets",
37340
+ "description": "Lists all secrets available in an environment without revealing their\nencrypted values.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
37341
+ "tags": [
37342
+ "actions"
37343
+ ],
37344
+ "operationId": "actions/list-environment-secrets",
37345
+ "externalDocs": {
37346
+ "description": "API method documentation",
37347
+ "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#list-environment-secrets"
37348
+ },
37349
+ "parameters": [
37350
+ {
37351
+ "$ref": "#/components/parameters/owner"
37352
+ },
37353
+ {
37354
+ "$ref": "#/components/parameters/repo"
37355
+ },
37356
+ {
37357
+ "$ref": "#/components/parameters/environment-name"
37358
+ },
37359
+ {
37360
+ "$ref": "#/components/parameters/per-page"
37361
+ },
37362
+ {
37363
+ "$ref": "#/components/parameters/page"
37364
+ }
37365
+ ],
37366
+ "responses": {
37367
+ "200": {
37368
+ "description": "Response",
37369
+ "content": {
37370
+ "application/json": {
37371
+ "schema": {
37372
+ "type": "object",
37373
+ "required": [
37374
+ "total_count",
37375
+ "secrets"
37376
+ ],
37377
+ "properties": {
37378
+ "total_count": {
37379
+ "type": "integer"
37380
+ },
37381
+ "secrets": {
37382
+ "type": "array",
37383
+ "items": {
37384
+ "$ref": "#/components/schemas/actions-secret"
37385
+ }
37386
+ }
37387
+ }
37388
+ },
37389
+ "examples": {
37390
+ "default": {
37391
+ "$ref": "#/components/examples/actions-secret-paginated"
37392
+ }
37393
+ }
37394
+ }
37395
+ },
37396
+ "headers": {
37397
+ "Link": {
37398
+ "$ref": "#/components/headers/link"
37399
+ }
37400
+ }
37401
+ }
37402
+ },
37403
+ "x-github": {
37404
+ "githubCloudOnly": false,
37405
+ "enabledForGitHubApps": true,
37406
+ "category": "actions",
37407
+ "subcategory": "secrets"
37408
+ },
37409
+ "x-octokit": {}
37410
+ }
37411
+ },
37412
+ "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": {
37413
+ "get": {
37414
+ "summary": "Get an environment public key",
37415
+ "description": "Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
37416
+ "tags": [
37417
+ "actions"
37418
+ ],
37419
+ "operationId": "actions/get-environment-public-key",
37420
+ "externalDocs": {
37421
+ "description": "API method documentation",
37422
+ "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-an-environment-public-key"
37423
+ },
37424
+ "parameters": [
37425
+ {
37426
+ "$ref": "#/components/parameters/owner"
37427
+ },
37428
+ {
37429
+ "$ref": "#/components/parameters/repo"
37430
+ },
37431
+ {
37432
+ "$ref": "#/components/parameters/environment-name"
37433
+ }
37434
+ ],
37435
+ "responses": {
37436
+ "200": {
37437
+ "description": "Response",
37438
+ "content": {
37439
+ "application/json": {
37440
+ "schema": {
37441
+ "$ref": "#/components/schemas/actions-public-key"
37442
+ },
37443
+ "examples": {
37444
+ "default": {
37445
+ "$ref": "#/components/examples/actions-public-key"
37446
+ }
37447
+ }
37448
+ }
37449
+ }
37450
+ }
37451
+ },
37452
+ "x-github": {
37453
+ "githubCloudOnly": false,
37454
+ "enabledForGitHubApps": true,
37455
+ "category": "actions",
37456
+ "subcategory": "secrets"
37457
+ },
37458
+ "x-octokit": {}
37459
+ }
37460
+ },
37461
+ "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": {
37462
+ "get": {
37463
+ "summary": "Get an environment secret",
37464
+ "description": "Gets a single environment secret without revealing its encrypted value.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
37465
+ "tags": [
37466
+ "actions"
37467
+ ],
37468
+ "operationId": "actions/get-environment-secret",
37469
+ "externalDocs": {
37470
+ "description": "API method documentation",
37471
+ "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-an-environment-secret"
37472
+ },
37473
+ "parameters": [
37474
+ {
37475
+ "$ref": "#/components/parameters/owner"
37476
+ },
37477
+ {
37478
+ "$ref": "#/components/parameters/repo"
37479
+ },
37480
+ {
37481
+ "$ref": "#/components/parameters/environment-name"
37482
+ },
37483
+ {
37484
+ "$ref": "#/components/parameters/secret-name"
37485
+ }
37486
+ ],
37487
+ "responses": {
37488
+ "200": {
37489
+ "description": "Response",
37490
+ "content": {
37491
+ "application/json": {
37492
+ "schema": {
37493
+ "$ref": "#/components/schemas/actions-secret"
37494
+ },
37495
+ "examples": {
37496
+ "default": {
37497
+ "$ref": "#/components/examples/actions-secret"
37498
+ }
37499
+ }
37500
+ }
37501
+ }
37502
+ }
37503
+ },
37504
+ "x-github": {
37505
+ "githubCloudOnly": false,
37506
+ "enabledForGitHubApps": true,
37507
+ "category": "actions",
37508
+ "subcategory": "secrets"
37509
+ },
37510
+ "x-octokit": {}
37511
+ },
37512
+ "put": {
37513
+ "summary": "Create or update an environment secret",
37514
+ "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
37515
+ "tags": [
37516
+ "actions"
37517
+ ],
37518
+ "operationId": "actions/create-or-update-environment-secret",
37519
+ "externalDocs": {
37520
+ "description": "API method documentation",
37521
+ "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-environment-secret"
37522
+ },
37523
+ "parameters": [
37524
+ {
37525
+ "$ref": "#/components/parameters/owner"
37526
+ },
37527
+ {
37528
+ "$ref": "#/components/parameters/repo"
37529
+ },
37530
+ {
37531
+ "$ref": "#/components/parameters/environment-name"
37532
+ },
37533
+ {
37534
+ "$ref": "#/components/parameters/secret-name"
37535
+ }
37536
+ ],
37537
+ "requestBody": {
37538
+ "required": true,
37539
+ "content": {
37540
+ "application/json": {
37541
+ "schema": {
37542
+ "type": "object",
37543
+ "properties": {
37544
+ "encrypted_value": {
37545
+ "type": "string",
37546
+ "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 environment public key](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-an-environment-public-key) endpoint.",
37547
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
37548
+ },
37549
+ "key_id": {
37550
+ "type": "string",
37551
+ "description": "ID of the key you used to encrypt the secret."
37552
+ }
37553
+ },
37554
+ "required": [
37555
+ "encrypted_value",
37556
+ "key_id"
37557
+ ]
37558
+ },
37559
+ "examples": {
37560
+ "default": {
37561
+ "value": {
37562
+ "encrypted_value": "c2VjcmV0",
37563
+ "key_id": "012345678912345678"
37564
+ }
37565
+ }
37566
+ }
37567
+ }
37568
+ }
37569
+ },
37570
+ "responses": {
37571
+ "201": {
37572
+ "description": "Response when creating a secret",
37573
+ "content": {
37574
+ "application/json": {
37575
+ "schema": {
37576
+ "$ref": "#/components/schemas/empty-object"
37577
+ },
37578
+ "examples": {
37579
+ "default": {
37580
+ "value": null
37581
+ }
37582
+ }
37583
+ }
37584
+ }
37585
+ },
37586
+ "204": {
37587
+ "description": "Response when updating a secret"
37588
+ }
37589
+ },
37590
+ "x-github": {
37591
+ "githubCloudOnly": false,
37592
+ "enabledForGitHubApps": true,
37593
+ "category": "actions",
37594
+ "subcategory": "secrets"
37595
+ },
37596
+ "x-octokit": {}
37597
+ },
37598
+ "delete": {
37599
+ "summary": "Delete an environment secret",
37600
+ "description": "Deletes a secret in an environment using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
37601
+ "tags": [
37602
+ "actions"
37603
+ ],
37604
+ "operationId": "actions/delete-environment-secret",
37605
+ "externalDocs": {
37606
+ "description": "API method documentation",
37607
+ "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#delete-an-environment-secret"
37608
+ },
37609
+ "parameters": [
37610
+ {
37611
+ "$ref": "#/components/parameters/owner"
37612
+ },
37613
+ {
37614
+ "$ref": "#/components/parameters/repo"
37615
+ },
37616
+ {
37617
+ "$ref": "#/components/parameters/environment-name"
37618
+ },
37619
+ {
37620
+ "$ref": "#/components/parameters/secret-name"
37621
+ }
37622
+ ],
37623
+ "responses": {
37624
+ "204": {
37625
+ "description": "Default response"
37626
+ }
37627
+ },
37628
+ "x-github": {
37629
+ "githubCloudOnly": false,
37630
+ "enabledForGitHubApps": true,
37631
+ "category": "actions",
37632
+ "subcategory": "secrets"
37633
+ },
37634
+ "x-octokit": {}
37635
+ }
37636
+ },
37637
+ "/repos/{owner}/{repo}/environments/{environment_name}/variables": {
37638
+ "get": {
37639
+ "summary": "List environment variables",
37640
+ "description": "Lists all environment variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
37641
+ "tags": [
37642
+ "actions"
37643
+ ],
37644
+ "operationId": "actions/list-environment-variables",
37645
+ "externalDocs": {
37646
+ "description": "API method documentation",
37647
+ "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#list-environment-variables"
37648
+ },
37649
+ "parameters": [
37650
+ {
37651
+ "$ref": "#/components/parameters/owner"
37652
+ },
37653
+ {
37654
+ "$ref": "#/components/parameters/repo"
37655
+ },
37656
+ {
37657
+ "$ref": "#/components/parameters/environment-name"
37658
+ },
37659
+ {
37660
+ "$ref": "#/components/parameters/variables-per-page"
37661
+ },
37662
+ {
37663
+ "$ref": "#/components/parameters/page"
37664
+ }
37665
+ ],
37666
+ "responses": {
37667
+ "200": {
37668
+ "description": "Response",
37669
+ "content": {
37670
+ "application/json": {
37671
+ "schema": {
37672
+ "type": "object",
37673
+ "required": [
37674
+ "total_count",
37675
+ "variables"
37676
+ ],
37677
+ "properties": {
37678
+ "total_count": {
37679
+ "type": "integer"
37680
+ },
37681
+ "variables": {
37682
+ "type": "array",
37683
+ "items": {
37684
+ "$ref": "#/components/schemas/actions-variable"
37685
+ }
37686
+ }
37687
+ }
37688
+ },
37689
+ "examples": {
37690
+ "default": {
37691
+ "$ref": "#/components/examples/actions-variables-paginated"
37692
+ }
37693
+ }
37694
+ }
37695
+ },
37696
+ "headers": {
37697
+ "Link": {
37698
+ "$ref": "#/components/headers/link"
37699
+ }
37700
+ }
37701
+ }
37702
+ },
37703
+ "x-github": {
37704
+ "githubCloudOnly": false,
37705
+ "enabledForGitHubApps": true,
37706
+ "category": "actions",
37707
+ "subcategory": "variables"
37708
+ },
37709
+ "x-octokit": {}
37710
+ },
37711
+ "post": {
37712
+ "summary": "Create an environment variable",
37713
+ "description": "Create an environment variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
37714
+ "tags": [
37715
+ "actions"
37716
+ ],
37717
+ "operationId": "actions/create-environment-variable",
37718
+ "externalDocs": {
37719
+ "description": "API method documentation",
37720
+ "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#create-an-environment-variable"
37721
+ },
37722
+ "parameters": [
37723
+ {
37724
+ "$ref": "#/components/parameters/owner"
37725
+ },
37726
+ {
37727
+ "$ref": "#/components/parameters/repo"
37728
+ },
37729
+ {
37730
+ "$ref": "#/components/parameters/environment-name"
37731
+ }
37732
+ ],
37733
+ "requestBody": {
37734
+ "required": true,
37735
+ "content": {
37736
+ "application/json": {
37737
+ "schema": {
37738
+ "type": "object",
37739
+ "properties": {
37740
+ "name": {
37741
+ "type": "string",
37742
+ "description": "The name of the variable."
37743
+ },
37744
+ "value": {
37745
+ "type": "string",
37746
+ "description": "The value of the variable."
37747
+ }
37748
+ },
37749
+ "required": [
37750
+ "name",
37751
+ "value"
37752
+ ]
37753
+ },
37754
+ "examples": {
37755
+ "default": {
37756
+ "value": {
37757
+ "name": "USERNAME",
37758
+ "value": "octocat"
37759
+ }
37760
+ }
37761
+ }
37762
+ }
37763
+ }
37764
+ },
37765
+ "responses": {
37766
+ "201": {
37767
+ "description": "Response",
37768
+ "content": {
37769
+ "application/json": {
37770
+ "schema": {
37771
+ "$ref": "#/components/schemas/empty-object"
37772
+ },
37773
+ "examples": {
37774
+ "default": {
37775
+ "value": null
37776
+ }
37777
+ }
37778
+ }
37779
+ }
37780
+ }
37781
+ },
37782
+ "x-github": {
37783
+ "githubCloudOnly": false,
37784
+ "enabledForGitHubApps": true,
37785
+ "category": "actions",
37786
+ "subcategory": "variables"
37787
+ },
37788
+ "x-octokit": {}
37789
+ }
37790
+ },
37791
+ "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": {
37792
+ "get": {
37793
+ "summary": "Get an environment variable",
37794
+ "description": "Gets a specific variable in an environment.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
37795
+ "tags": [
37796
+ "actions"
37797
+ ],
37798
+ "operationId": "actions/get-environment-variable",
37799
+ "externalDocs": {
37800
+ "description": "API method documentation",
37801
+ "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#get-an-environment-variable"
37802
+ },
37803
+ "parameters": [
37804
+ {
37805
+ "$ref": "#/components/parameters/owner"
37806
+ },
37807
+ {
37808
+ "$ref": "#/components/parameters/repo"
37809
+ },
37810
+ {
37811
+ "$ref": "#/components/parameters/environment-name"
37812
+ },
37813
+ {
37814
+ "$ref": "#/components/parameters/variable-name"
37815
+ }
37816
+ ],
37817
+ "responses": {
37818
+ "200": {
37819
+ "description": "Response",
37820
+ "content": {
37821
+ "application/json": {
37822
+ "schema": {
37823
+ "$ref": "#/components/schemas/actions-variable"
37824
+ },
37825
+ "examples": {
37826
+ "default": {
37827
+ "$ref": "#/components/examples/actions-variable"
37828
+ }
37829
+ }
37830
+ }
37831
+ }
37832
+ }
37833
+ },
37834
+ "x-github": {
37835
+ "githubCloudOnly": false,
37836
+ "enabledForGitHubApps": true,
37837
+ "category": "actions",
37838
+ "subcategory": "variables"
37839
+ },
37840
+ "x-octokit": {}
37841
+ },
37842
+ "patch": {
37843
+ "summary": "Update an environment variable",
37844
+ "description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
37845
+ "tags": [
37846
+ "actions"
37847
+ ],
37848
+ "operationId": "actions/update-environment-variable",
37849
+ "externalDocs": {
37850
+ "description": "API method documentation",
37851
+ "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#update-an-environment-variable"
37852
+ },
37853
+ "parameters": [
37854
+ {
37855
+ "$ref": "#/components/parameters/owner"
37856
+ },
37857
+ {
37858
+ "$ref": "#/components/parameters/repo"
37859
+ },
37860
+ {
37861
+ "$ref": "#/components/parameters/variable-name"
37862
+ },
37863
+ {
37864
+ "$ref": "#/components/parameters/environment-name"
37865
+ }
37866
+ ],
37867
+ "requestBody": {
37868
+ "required": true,
37869
+ "content": {
37870
+ "application/json": {
37871
+ "schema": {
37872
+ "type": "object",
37873
+ "properties": {
37874
+ "name": {
37875
+ "type": "string",
37876
+ "description": "The name of the variable."
37877
+ },
37878
+ "value": {
37879
+ "type": "string",
37880
+ "description": "The value of the variable."
37881
+ }
37882
+ }
37883
+ },
37884
+ "examples": {
37885
+ "default": {
37886
+ "value": {
37887
+ "name": "USERNAME",
37888
+ "value": "octocat"
37889
+ }
37890
+ }
37891
+ }
37892
+ }
37893
+ }
37894
+ },
37895
+ "responses": {
37896
+ "204": {
37897
+ "description": "Response"
37898
+ }
37899
+ },
37900
+ "x-github": {
37901
+ "githubCloudOnly": false,
37902
+ "enabledForGitHubApps": true,
37903
+ "category": "actions",
37904
+ "subcategory": "variables"
37905
+ },
37906
+ "x-octokit": {}
37907
+ },
37908
+ "delete": {
37909
+ "summary": "Delete an environment variable",
37910
+ "description": "Deletes an environment variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
37911
+ "tags": [
37912
+ "actions"
37913
+ ],
37914
+ "operationId": "actions/delete-environment-variable",
37915
+ "externalDocs": {
37916
+ "description": "API method documentation",
37917
+ "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#delete-an-environment-variable"
37918
+ },
37919
+ "parameters": [
37920
+ {
37921
+ "$ref": "#/components/parameters/owner"
37922
+ },
37923
+ {
37924
+ "$ref": "#/components/parameters/repo"
37925
+ },
37926
+ {
37927
+ "$ref": "#/components/parameters/variable-name"
37928
+ },
37929
+ {
37930
+ "$ref": "#/components/parameters/environment-name"
37931
+ }
37932
+ ],
37933
+ "responses": {
37934
+ "204": {
37935
+ "description": "Response"
37936
+ }
37937
+ },
37938
+ "x-github": {
37939
+ "githubCloudOnly": false,
37940
+ "enabledForGitHubApps": true,
37941
+ "category": "actions",
37942
+ "subcategory": "variables"
37943
+ },
37944
+ "x-octokit": {}
37945
+ }
37946
+ },
37325
37947
  "/repos/{owner}/{repo}/events": {
37326
37948
  "get": {
37327
37949
  "summary": "List repository events",
@@ -37694,6 +38316,9 @@
37694
38316
  "404": {
37695
38317
  "$ref": "#/components/responses/not_found"
37696
38318
  },
38319
+ "409": {
38320
+ "$ref": "#/components/responses/conflict"
38321
+ },
37697
38322
  "422": {
37698
38323
  "$ref": "#/components/responses/validation_failed"
37699
38324
  }
@@ -37848,6 +38473,9 @@
37848
38473
  "404": {
37849
38474
  "$ref": "#/components/responses/not_found"
37850
38475
  },
38476
+ "409": {
38477
+ "$ref": "#/components/responses/conflict"
38478
+ },
37851
38479
  "422": {
37852
38480
  "$ref": "#/components/responses/validation_failed"
37853
38481
  }
@@ -37902,6 +38530,9 @@
37902
38530
  },
37903
38531
  "404": {
37904
38532
  "$ref": "#/components/responses/not_found"
38533
+ },
38534
+ "409": {
38535
+ "$ref": "#/components/responses/conflict"
37905
38536
  }
37906
38537
  },
37907
38538
  "x-github": {
@@ -37933,7 +38564,7 @@
37933
38564
  "$ref": "#/components/parameters/repo"
37934
38565
  },
37935
38566
  {
37936
- "$ref": "#/components/parameters/commit-ref"
38567
+ "$ref": "#/components/parameters/git-ref-only"
37937
38568
  }
37938
38569
  ],
37939
38570
  "responses": {
@@ -37959,6 +38590,9 @@
37959
38590
  "$ref": "#/components/headers/link"
37960
38591
  }
37961
38592
  }
38593
+ },
38594
+ "409": {
38595
+ "$ref": "#/components/responses/conflict"
37962
38596
  }
37963
38597
  },
37964
38598
  "x-github": {
@@ -37990,7 +38624,7 @@
37990
38624
  "$ref": "#/components/parameters/repo"
37991
38625
  },
37992
38626
  {
37993
- "$ref": "#/components/parameters/commit-ref"
38627
+ "$ref": "#/components/parameters/git-ref-only"
37994
38628
  }
37995
38629
  ],
37996
38630
  "responses": {
@@ -38011,6 +38645,9 @@
38011
38645
  },
38012
38646
  "404": {
38013
38647
  "$ref": "#/components/responses/not_found"
38648
+ },
38649
+ "409": {
38650
+ "$ref": "#/components/responses/conflict"
38014
38651
  }
38015
38652
  },
38016
38653
  "x-github": {
@@ -38098,6 +38735,9 @@
38098
38735
  }
38099
38736
  }
38100
38737
  },
38738
+ "409": {
38739
+ "$ref": "#/components/responses/conflict"
38740
+ },
38101
38741
  "422": {
38102
38742
  "$ref": "#/components/responses/validation_failed"
38103
38743
  }
@@ -38114,7 +38754,7 @@
38114
38754
  "/repos/{owner}/{repo}/git/refs/{ref}": {
38115
38755
  "patch": {
38116
38756
  "summary": "Update a reference",
38117
- "description": "",
38757
+ "description": "Updates the provided reference to point to a new SHA. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.",
38118
38758
  "tags": [
38119
38759
  "git"
38120
38760
  ],
@@ -38131,15 +38771,7 @@
38131
38771
  "$ref": "#/components/parameters/repo"
38132
38772
  },
38133
38773
  {
38134
- "name": "ref",
38135
- "description": "The name of the reference to update (for example, `heads/featureA`). Can be a branch name (`heads/BRANCH_NAME`) or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.",
38136
- "in": "path",
38137
- "required": true,
38138
- "example": "heads/featureA",
38139
- "schema": {
38140
- "type": "string"
38141
- },
38142
- "x-multi-segment": true
38774
+ "$ref": "#/components/parameters/git-ref-only"
38143
38775
  }
38144
38776
  ],
38145
38777
  "requestBody": {
@@ -38190,6 +38822,9 @@
38190
38822
  }
38191
38823
  }
38192
38824
  },
38825
+ "409": {
38826
+ "$ref": "#/components/responses/conflict"
38827
+ },
38193
38828
  "422": {
38194
38829
  "$ref": "#/components/responses/validation_failed"
38195
38830
  }
@@ -38204,7 +38839,7 @@
38204
38839
  },
38205
38840
  "delete": {
38206
38841
  "summary": "Delete a reference",
38207
- "description": "",
38842
+ "description": "Deletes the provided reference.",
38208
38843
  "tags": [
38209
38844
  "git"
38210
38845
  ],
@@ -38221,13 +38856,16 @@
38221
38856
  "$ref": "#/components/parameters/repo"
38222
38857
  },
38223
38858
  {
38224
- "$ref": "#/components/parameters/commit-ref"
38859
+ "$ref": "#/components/parameters/git-ref-only"
38225
38860
  }
38226
38861
  ],
38227
38862
  "responses": {
38228
38863
  "204": {
38229
38864
  "description": "Response"
38230
38865
  },
38866
+ "409": {
38867
+ "$ref": "#/components/responses/conflict"
38868
+ },
38231
38869
  "422": {
38232
38870
  "$ref": "#/components/responses/validation_failed"
38233
38871
  }
@@ -38362,6 +39000,9 @@
38362
39000
  }
38363
39001
  }
38364
39002
  },
39003
+ "409": {
39004
+ "$ref": "#/components/responses/conflict"
39005
+ },
38365
39006
  "422": {
38366
39007
  "$ref": "#/components/responses/validation_failed"
38367
39008
  }
@@ -38421,6 +39062,9 @@
38421
39062
  },
38422
39063
  "404": {
38423
39064
  "$ref": "#/components/responses/not_found"
39065
+ },
39066
+ "409": {
39067
+ "$ref": "#/components/responses/conflict"
38424
39068
  }
38425
39069
  },
38426
39070
  "x-github": {
@@ -38558,6 +39202,9 @@
38558
39202
  "404": {
38559
39203
  "$ref": "#/components/responses/not_found"
38560
39204
  },
39205
+ "409": {
39206
+ "$ref": "#/components/responses/conflict"
39207
+ },
38561
39208
  "422": {
38562
39209
  "$ref": "#/components/responses/validation_failed"
38563
39210
  }
@@ -38632,6 +39279,9 @@
38632
39279
  "404": {
38633
39280
  "$ref": "#/components/responses/not_found"
38634
39281
  },
39282
+ "409": {
39283
+ "$ref": "#/components/responses/conflict"
39284
+ },
38635
39285
  "422": {
38636
39286
  "$ref": "#/components/responses/validation_failed"
38637
39287
  }
@@ -50495,587 +51145,7 @@
50495
51145
  "x-octokit": {}
50496
51146
  }
50497
51147
  },
50498
- "/repositories/{repository_id}/environments/{environment_name}/secrets": {
50499
- "get": {
50500
- "summary": "List environment secrets",
50501
- "description": "Lists all secrets available in an environment without revealing their\nencrypted values.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
50502
- "tags": [
50503
- "actions"
50504
- ],
50505
- "operationId": "actions/list-environment-secrets",
50506
- "externalDocs": {
50507
- "description": "API method documentation",
50508
- "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#list-environment-secrets"
50509
- },
50510
- "parameters": [
50511
- {
50512
- "$ref": "#/components/parameters/repository-id"
50513
- },
50514
- {
50515
- "$ref": "#/components/parameters/environment-name"
50516
- },
50517
- {
50518
- "$ref": "#/components/parameters/per-page"
50519
- },
50520
- {
50521
- "$ref": "#/components/parameters/page"
50522
- }
50523
- ],
50524
- "responses": {
50525
- "200": {
50526
- "description": "Response",
50527
- "content": {
50528
- "application/json": {
50529
- "schema": {
50530
- "type": "object",
50531
- "required": [
50532
- "total_count",
50533
- "secrets"
50534
- ],
50535
- "properties": {
50536
- "total_count": {
50537
- "type": "integer"
50538
- },
50539
- "secrets": {
50540
- "type": "array",
50541
- "items": {
50542
- "$ref": "#/components/schemas/actions-secret"
50543
- }
50544
- }
50545
- }
50546
- },
50547
- "examples": {
50548
- "default": {
50549
- "$ref": "#/components/examples/actions-secret-paginated"
50550
- }
50551
- }
50552
- }
50553
- },
50554
- "headers": {
50555
- "Link": {
50556
- "$ref": "#/components/headers/link"
50557
- }
50558
- }
50559
- }
50560
- },
50561
- "x-github": {
50562
- "githubCloudOnly": false,
50563
- "enabledForGitHubApps": true,
50564
- "category": "actions",
50565
- "subcategory": "secrets"
50566
- },
50567
- "x-octokit": {}
50568
- }
50569
- },
50570
- "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": {
50571
- "get": {
50572
- "summary": "Get an environment public key",
50573
- "description": "Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
50574
- "tags": [
50575
- "actions"
50576
- ],
50577
- "operationId": "actions/get-environment-public-key",
50578
- "externalDocs": {
50579
- "description": "API method documentation",
50580
- "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-an-environment-public-key"
50581
- },
50582
- "parameters": [
50583
- {
50584
- "$ref": "#/components/parameters/repository-id"
50585
- },
50586
- {
50587
- "$ref": "#/components/parameters/environment-name"
50588
- }
50589
- ],
50590
- "responses": {
50591
- "200": {
50592
- "description": "Response",
50593
- "content": {
50594
- "application/json": {
50595
- "schema": {
50596
- "$ref": "#/components/schemas/actions-public-key"
50597
- },
50598
- "examples": {
50599
- "default": {
50600
- "$ref": "#/components/examples/actions-public-key"
50601
- }
50602
- }
50603
- }
50604
- }
50605
- }
50606
- },
50607
- "x-github": {
50608
- "githubCloudOnly": false,
50609
- "enabledForGitHubApps": true,
50610
- "category": "actions",
50611
- "subcategory": "secrets"
50612
- },
50613
- "x-octokit": {}
50614
- }
50615
- },
50616
- "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": {
50617
- "get": {
50618
- "summary": "Get an environment secret",
50619
- "description": "Gets a single environment secret without revealing its encrypted value.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
50620
- "tags": [
50621
- "actions"
50622
- ],
50623
- "operationId": "actions/get-environment-secret",
50624
- "externalDocs": {
50625
- "description": "API method documentation",
50626
- "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-an-environment-secret"
50627
- },
50628
- "parameters": [
50629
- {
50630
- "$ref": "#/components/parameters/repository-id"
50631
- },
50632
- {
50633
- "$ref": "#/components/parameters/environment-name"
50634
- },
50635
- {
50636
- "$ref": "#/components/parameters/secret-name"
50637
- }
50638
- ],
50639
- "responses": {
50640
- "200": {
50641
- "description": "Response",
50642
- "content": {
50643
- "application/json": {
50644
- "schema": {
50645
- "$ref": "#/components/schemas/actions-secret"
50646
- },
50647
- "examples": {
50648
- "default": {
50649
- "$ref": "#/components/examples/actions-secret"
50650
- }
50651
- }
50652
- }
50653
- }
50654
- }
50655
- },
50656
- "x-github": {
50657
- "githubCloudOnly": false,
50658
- "enabledForGitHubApps": true,
50659
- "category": "actions",
50660
- "subcategory": "secrets"
50661
- },
50662
- "x-octokit": {}
50663
- },
50664
- "put": {
50665
- "summary": "Create or update an environment secret",
50666
- "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
50667
- "tags": [
50668
- "actions"
50669
- ],
50670
- "operationId": "actions/create-or-update-environment-secret",
50671
- "externalDocs": {
50672
- "description": "API method documentation",
50673
- "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-environment-secret"
50674
- },
50675
- "parameters": [
50676
- {
50677
- "$ref": "#/components/parameters/repository-id"
50678
- },
50679
- {
50680
- "$ref": "#/components/parameters/environment-name"
50681
- },
50682
- {
50683
- "$ref": "#/components/parameters/secret-name"
50684
- }
50685
- ],
50686
- "requestBody": {
50687
- "required": true,
50688
- "content": {
50689
- "application/json": {
50690
- "schema": {
50691
- "type": "object",
50692
- "properties": {
50693
- "encrypted_value": {
50694
- "type": "string",
50695
- "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 environment public key](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-an-environment-public-key) endpoint.",
50696
- "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
50697
- },
50698
- "key_id": {
50699
- "type": "string",
50700
- "description": "ID of the key you used to encrypt the secret."
50701
- }
50702
- },
50703
- "required": [
50704
- "encrypted_value",
50705
- "key_id"
50706
- ]
50707
- },
50708
- "examples": {
50709
- "default": {
50710
- "value": {
50711
- "encrypted_value": "c2VjcmV0",
50712
- "key_id": "012345678912345678"
50713
- }
50714
- }
50715
- }
50716
- }
50717
- }
50718
- },
50719
- "responses": {
50720
- "201": {
50721
- "description": "Response when creating a secret",
50722
- "content": {
50723
- "application/json": {
50724
- "schema": {
50725
- "$ref": "#/components/schemas/empty-object"
50726
- },
50727
- "examples": {
50728
- "default": {
50729
- "value": null
50730
- }
50731
- }
50732
- }
50733
- }
50734
- },
50735
- "204": {
50736
- "description": "Response when updating a secret"
50737
- }
50738
- },
50739
- "x-github": {
50740
- "githubCloudOnly": false,
50741
- "enabledForGitHubApps": true,
50742
- "category": "actions",
50743
- "subcategory": "secrets"
50744
- },
50745
- "x-octokit": {}
50746
- },
50747
- "delete": {
50748
- "summary": "Delete an environment secret",
50749
- "description": "Deletes a secret in an environment using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
50750
- "tags": [
50751
- "actions"
50752
- ],
50753
- "operationId": "actions/delete-environment-secret",
50754
- "externalDocs": {
50755
- "description": "API method documentation",
50756
- "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#delete-an-environment-secret"
50757
- },
50758
- "parameters": [
50759
- {
50760
- "$ref": "#/components/parameters/repository-id"
50761
- },
50762
- {
50763
- "$ref": "#/components/parameters/environment-name"
50764
- },
50765
- {
50766
- "$ref": "#/components/parameters/secret-name"
50767
- }
50768
- ],
50769
- "responses": {
50770
- "204": {
50771
- "description": "Default response"
50772
- }
50773
- },
50774
- "x-github": {
50775
- "githubCloudOnly": false,
50776
- "enabledForGitHubApps": true,
50777
- "category": "actions",
50778
- "subcategory": "secrets"
50779
- },
50780
- "x-octokit": {}
50781
- }
50782
- },
50783
- "/repositories/{repository_id}/environments/{environment_name}/variables": {
50784
- "get": {
50785
- "summary": "List environment variables",
50786
- "description": "Lists all environment variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
50787
- "tags": [
50788
- "actions"
50789
- ],
50790
- "operationId": "actions/list-environment-variables",
50791
- "externalDocs": {
50792
- "description": "API method documentation",
50793
- "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#list-environment-variables"
50794
- },
50795
- "parameters": [
50796
- {
50797
- "$ref": "#/components/parameters/repository-id"
50798
- },
50799
- {
50800
- "$ref": "#/components/parameters/environment-name"
50801
- },
50802
- {
50803
- "$ref": "#/components/parameters/variables-per-page"
50804
- },
50805
- {
50806
- "$ref": "#/components/parameters/page"
50807
- }
50808
- ],
50809
- "responses": {
50810
- "200": {
50811
- "description": "Response",
50812
- "content": {
50813
- "application/json": {
50814
- "schema": {
50815
- "type": "object",
50816
- "required": [
50817
- "total_count",
50818
- "variables"
50819
- ],
50820
- "properties": {
50821
- "total_count": {
50822
- "type": "integer"
50823
- },
50824
- "variables": {
50825
- "type": "array",
50826
- "items": {
50827
- "$ref": "#/components/schemas/actions-variable"
50828
- }
50829
- }
50830
- }
50831
- },
50832
- "examples": {
50833
- "default": {
50834
- "$ref": "#/components/examples/actions-variables-paginated"
50835
- }
50836
- }
50837
- }
50838
- },
50839
- "headers": {
50840
- "Link": {
50841
- "$ref": "#/components/headers/link"
50842
- }
50843
- }
50844
- }
50845
- },
50846
- "x-github": {
50847
- "githubCloudOnly": false,
50848
- "enabledForGitHubApps": true,
50849
- "category": "actions",
50850
- "subcategory": "variables"
50851
- },
50852
- "x-octokit": {}
50853
- },
50854
- "post": {
50855
- "summary": "Create an environment variable",
50856
- "description": "Create an environment variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
50857
- "tags": [
50858
- "actions"
50859
- ],
50860
- "operationId": "actions/create-environment-variable",
50861
- "externalDocs": {
50862
- "description": "API method documentation",
50863
- "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#create-an-environment-variable"
50864
- },
50865
- "parameters": [
50866
- {
50867
- "$ref": "#/components/parameters/repository-id"
50868
- },
50869
- {
50870
- "$ref": "#/components/parameters/environment-name"
50871
- }
50872
- ],
50873
- "requestBody": {
50874
- "required": true,
50875
- "content": {
50876
- "application/json": {
50877
- "schema": {
50878
- "type": "object",
50879
- "properties": {
50880
- "name": {
50881
- "type": "string",
50882
- "description": "The name of the variable."
50883
- },
50884
- "value": {
50885
- "type": "string",
50886
- "description": "The value of the variable."
50887
- }
50888
- },
50889
- "required": [
50890
- "name",
50891
- "value"
50892
- ]
50893
- },
50894
- "examples": {
50895
- "default": {
50896
- "value": {
50897
- "name": "USERNAME",
50898
- "value": "octocat"
50899
- }
50900
- }
50901
- }
50902
- }
50903
- }
50904
- },
50905
- "responses": {
50906
- "201": {
50907
- "description": "Response",
50908
- "content": {
50909
- "application/json": {
50910
- "schema": {
50911
- "$ref": "#/components/schemas/empty-object"
50912
- },
50913
- "examples": {
50914
- "default": {
50915
- "value": null
50916
- }
50917
- }
50918
- }
50919
- }
50920
- }
50921
- },
50922
- "x-github": {
50923
- "githubCloudOnly": false,
50924
- "enabledForGitHubApps": true,
50925
- "category": "actions",
50926
- "subcategory": "variables"
50927
- },
50928
- "x-octokit": {}
50929
- }
50930
- },
50931
- "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": {
50932
- "get": {
50933
- "summary": "Get an environment variable",
50934
- "description": "Gets a specific variable in an environment.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
50935
- "tags": [
50936
- "actions"
50937
- ],
50938
- "operationId": "actions/get-environment-variable",
50939
- "externalDocs": {
50940
- "description": "API method documentation",
50941
- "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#get-an-environment-variable"
50942
- },
50943
- "parameters": [
50944
- {
50945
- "$ref": "#/components/parameters/repository-id"
50946
- },
50947
- {
50948
- "$ref": "#/components/parameters/environment-name"
50949
- },
50950
- {
50951
- "$ref": "#/components/parameters/variable-name"
50952
- }
50953
- ],
50954
- "responses": {
50955
- "200": {
50956
- "description": "Response",
50957
- "content": {
50958
- "application/json": {
50959
- "schema": {
50960
- "$ref": "#/components/schemas/actions-variable"
50961
- },
50962
- "examples": {
50963
- "default": {
50964
- "$ref": "#/components/examples/actions-variable"
50965
- }
50966
- }
50967
- }
50968
- }
50969
- }
50970
- },
50971
- "x-github": {
50972
- "githubCloudOnly": false,
50973
- "enabledForGitHubApps": true,
50974
- "category": "actions",
50975
- "subcategory": "variables"
50976
- },
50977
- "x-octokit": {}
50978
- },
50979
- "patch": {
50980
- "summary": "Update an environment variable",
50981
- "description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
50982
- "tags": [
50983
- "actions"
50984
- ],
50985
- "operationId": "actions/update-environment-variable",
50986
- "externalDocs": {
50987
- "description": "API method documentation",
50988
- "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#update-an-environment-variable"
50989
- },
50990
- "parameters": [
50991
- {
50992
- "$ref": "#/components/parameters/repository-id"
50993
- },
50994
- {
50995
- "$ref": "#/components/parameters/variable-name"
50996
- },
50997
- {
50998
- "$ref": "#/components/parameters/environment-name"
50999
- }
51000
- ],
51001
- "requestBody": {
51002
- "required": true,
51003
- "content": {
51004
- "application/json": {
51005
- "schema": {
51006
- "type": "object",
51007
- "properties": {
51008
- "name": {
51009
- "type": "string",
51010
- "description": "The name of the variable."
51011
- },
51012
- "value": {
51013
- "type": "string",
51014
- "description": "The value of the variable."
51015
- }
51016
- }
51017
- },
51018
- "examples": {
51019
- "default": {
51020
- "value": {
51021
- "name": "USERNAME",
51022
- "value": "octocat"
51023
- }
51024
- }
51025
- }
51026
- }
51027
- }
51028
- },
51029
- "responses": {
51030
- "204": {
51031
- "description": "Response"
51032
- }
51033
- },
51034
- "x-github": {
51035
- "githubCloudOnly": false,
51036
- "enabledForGitHubApps": true,
51037
- "category": "actions",
51038
- "subcategory": "variables"
51039
- },
51040
- "x-octokit": {}
51041
- },
51042
- "delete": {
51043
- "summary": "Delete an environment variable",
51044
- "description": "Deletes an environment variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
51045
- "tags": [
51046
- "actions"
51047
- ],
51048
- "operationId": "actions/delete-environment-variable",
51049
- "externalDocs": {
51050
- "description": "API method documentation",
51051
- "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#delete-an-environment-variable"
51052
- },
51053
- "parameters": [
51054
- {
51055
- "$ref": "#/components/parameters/repository-id"
51056
- },
51057
- {
51058
- "$ref": "#/components/parameters/variable-name"
51059
- },
51060
- {
51061
- "$ref": "#/components/parameters/environment-name"
51062
- }
51063
- ],
51064
- "responses": {
51065
- "204": {
51066
- "description": "Response"
51067
- }
51068
- },
51069
- "x-github": {
51070
- "githubCloudOnly": false,
51071
- "enabledForGitHubApps": true,
51072
- "category": "actions",
51073
- "subcategory": "variables"
51074
- },
51075
- "x-octokit": {}
51076
- }
51077
- },
51078
- "/scim/v2/Groups": {
51148
+ "/scim/v2/enterprises/{enterprise}/Groups": {
51079
51149
  "get": {
51080
51150
  "summary": "List provisioned SCIM groups for an enterprise",
51081
51151
  "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nLists provisioned SCIM groups in an enterprise.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response.",
@@ -51114,6 +51184,9 @@
51114
51184
  },
51115
51185
  {
51116
51186
  "$ref": "#/components/parameters/count"
51187
+ },
51188
+ {
51189
+ "$ref": "#/components/parameters/enterprise"
51117
51190
  }
51118
51191
  ],
51119
51192
  "responses": {
@@ -51167,6 +51240,11 @@
51167
51240
  "description": "API method documentation",
51168
51241
  "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#provision-a-scim-enterprise-group"
51169
51242
  },
51243
+ "parameters": [
51244
+ {
51245
+ "$ref": "#/components/parameters/enterprise"
51246
+ }
51247
+ ],
51170
51248
  "requestBody": {
51171
51249
  "required": true,
51172
51250
  "content": {
@@ -51232,7 +51310,7 @@
51232
51310
  "x-octokit": {}
51233
51311
  }
51234
51312
  },
51235
- "/scim/v2/Groups/{scim_group_id}": {
51313
+ "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": {
51236
51314
  "get": {
51237
51315
  "summary": "Get SCIM provisioning information for an enterprise group",
51238
51316
  "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nGets information about a SCIM group.",
@@ -51250,6 +51328,9 @@
51250
51328
  },
51251
51329
  {
51252
51330
  "$ref": "#/components/parameters/excluded-attributes"
51331
+ },
51332
+ {
51333
+ "$ref": "#/components/parameters/enterprise"
51253
51334
  }
51254
51335
  ],
51255
51336
  "responses": {
@@ -51309,6 +51390,9 @@
51309
51390
  "parameters": [
51310
51391
  {
51311
51392
  "$ref": "#/components/parameters/scim-group-id"
51393
+ },
51394
+ {
51395
+ "$ref": "#/components/parameters/enterprise"
51312
51396
  }
51313
51397
  ],
51314
51398
  "requestBody": {
@@ -51416,6 +51500,9 @@
51416
51500
  "parameters": [
51417
51501
  {
51418
51502
  "$ref": "#/components/parameters/scim-group-id"
51503
+ },
51504
+ {
51505
+ "$ref": "#/components/parameters/enterprise"
51419
51506
  }
51420
51507
  ],
51421
51508
  "requestBody": {
@@ -51533,6 +51620,9 @@
51533
51620
  "parameters": [
51534
51621
  {
51535
51622
  "$ref": "#/components/parameters/scim-group-id"
51623
+ },
51624
+ {
51625
+ "$ref": "#/components/parameters/enterprise"
51536
51626
  }
51537
51627
  ],
51538
51628
  "responses": {
@@ -51567,7 +51657,7 @@
51567
51657
  "x-octokit": {}
51568
51658
  }
51569
51659
  },
51570
- "/scim/v2/Users": {
51660
+ "/scim/v2/enterprises/{enterprise}/Users": {
51571
51661
  "get": {
51572
51662
  "summary": "List SCIM provisioned identities for an enterprise",
51573
51663
  "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nLists provisioned SCIM enterprise members.\n\nWhen a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the `delete` request. Users that were not permanently deleted will be visible in the returned results.",
@@ -51602,6 +51692,9 @@
51602
51692
  },
51603
51693
  {
51604
51694
  "$ref": "#/components/parameters/count"
51695
+ },
51696
+ {
51697
+ "$ref": "#/components/parameters/enterprise"
51605
51698
  }
51606
51699
  ],
51607
51700
  "responses": {
@@ -51655,6 +51748,11 @@
51655
51748
  "description": "API method documentation",
51656
51749
  "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#provision-a-scim-enterprise-user"
51657
51750
  },
51751
+ "parameters": [
51752
+ {
51753
+ "$ref": "#/components/parameters/enterprise"
51754
+ }
51755
+ ],
51658
51756
  "requestBody": {
51659
51757
  "required": true,
51660
51758
  "content": {
@@ -51720,7 +51818,7 @@
51720
51818
  "x-octokit": {}
51721
51819
  }
51722
51820
  },
51723
- "/scim/v2/Users/{scim_user_id}": {
51821
+ "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": {
51724
51822
  "get": {
51725
51823
  "summary": "Get SCIM provisioning information for an enterprise user",
51726
51824
  "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nGets information about a SCIM user.",
@@ -51735,6 +51833,9 @@
51735
51833
  "parameters": [
51736
51834
  {
51737
51835
  "$ref": "#/components/parameters/scim-user-id"
51836
+ },
51837
+ {
51838
+ "$ref": "#/components/parameters/enterprise"
51738
51839
  }
51739
51840
  ],
51740
51841
  "responses": {
@@ -51794,6 +51895,9 @@
51794
51895
  "parameters": [
51795
51896
  {
51796
51897
  "$ref": "#/components/parameters/scim-user-id"
51898
+ },
51899
+ {
51900
+ "$ref": "#/components/parameters/enterprise"
51797
51901
  }
51798
51902
  ],
51799
51903
  "requestBody": {
@@ -51871,6 +51975,9 @@
51871
51975
  "parameters": [
51872
51976
  {
51873
51977
  "$ref": "#/components/parameters/scim-user-id"
51978
+ },
51979
+ {
51980
+ "$ref": "#/components/parameters/enterprise"
51874
51981
  }
51875
51982
  ],
51876
51983
  "requestBody": {
@@ -52006,6 +52113,9 @@
52006
52113
  "parameters": [
52007
52114
  {
52008
52115
  "$ref": "#/components/parameters/scim-user-id"
52116
+ },
52117
+ {
52118
+ "$ref": "#/components/parameters/enterprise"
52009
52119
  }
52010
52120
  ],
52011
52121
  "responses": {
@@ -60436,7 +60546,7 @@
60436
60546
  "/users/{username}/hovercard": {
60437
60547
  "get": {
60438
60548
  "summary": "Get contextual information for a user",
60439
- "description": "Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.\n\nThe `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this:\n\n```shell\n curl -u username:token\n https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192\n```\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
60549
+ "description": "Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.\n\n The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
60440
60550
  "tags": [
60441
60551
  "users"
60442
60552
  ],
@@ -98628,7 +98738,9 @@
98628
98738
  "queued",
98629
98739
  "in_progress",
98630
98740
  "completed",
98631
- "waiting"
98741
+ "waiting",
98742
+ "requested",
98743
+ "pending"
98632
98744
  ]
98633
98745
  },
98634
98746
  "conclusion": {
@@ -101033,13 +101145,16 @@
101033
101145
  "nullable": true
101034
101146
  },
101035
101147
  "status": {
101036
- "description": "The phase of the lifecycle that the check is currently in.",
101148
+ "description": "The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs.",
101037
101149
  "example": "queued",
101038
101150
  "type": "string",
101039
101151
  "enum": [
101040
101152
  "queued",
101041
101153
  "in_progress",
101042
- "completed"
101154
+ "completed",
101155
+ "waiting",
101156
+ "requested",
101157
+ "pending"
101043
101158
  ]
101044
101159
  },
101045
101160
  "conclusion": {
@@ -101317,11 +101432,15 @@
101317
101432
  },
101318
101433
  "status": {
101319
101434
  "type": "string",
101435
+ "description": "The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites.",
101320
101436
  "example": "completed",
101321
101437
  "enum": [
101322
101438
  "queued",
101323
101439
  "in_progress",
101324
- "completed"
101440
+ "completed",
101441
+ "waiting",
101442
+ "requested",
101443
+ "pending"
101325
101444
  ],
101326
101445
  "nullable": true
101327
101446
  },
@@ -165006,6 +165125,7 @@
165006
165125
  "type": "object",
165007
165126
  "properties": {
165008
165127
  "permission": {
165128
+ "description": "This field is included for legacy purposes; use the `role_name` field instead. The `maintain`\nrole is mapped to `write` and the `triage` role is mapped to `read`. To determine the role\nassigned to the collaborator, use the `role_name` field instead, which will provide the full\nrole name, including custom roles.",
165009
165129
  "type": "object",
165010
165130
  "properties": {
165011
165131
  "to": {
@@ -165020,6 +165140,18 @@
165020
165140
  "required": [
165021
165141
  "to"
165022
165142
  ]
165143
+ },
165144
+ "role_name": {
165145
+ "description": "The role assigned to the collaborator.",
165146
+ "type": "object",
165147
+ "properties": {
165148
+ "to": {
165149
+ "type": "string"
165150
+ }
165151
+ },
165152
+ "required": [
165153
+ "to"
165154
+ ]
165023
165155
  }
165024
165156
  }
165025
165157
  },
@@ -243410,7 +243542,7 @@
243410
243542
  "type": "string"
243411
243543
  },
243412
243544
  "commits": {
243413
- "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-server@3.9/rest/commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.",
243545
+ "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-server@3.9/rest/commits) to fetch additional commits.",
243414
243546
  "type": "array",
243415
243547
  "items": {
243416
243548
  "title": "Commit",
@@ -292112,7 +292244,7 @@
292112
292244
  },
292113
292245
  "workflow-run-status": {
292114
292246
  "name": "status",
292115
- "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`.",
292247
+ "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.",
292116
292248
  "in": "query",
292117
292249
  "required": false,
292118
292250
  "schema": {
@@ -292357,6 +292489,17 @@
292357
292489
  "type": "integer"
292358
292490
  }
292359
292491
  },
292492
+ "git-ref-only": {
292493
+ "name": "ref",
292494
+ "description": "The Git reference. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.",
292495
+ "in": "path",
292496
+ "required": true,
292497
+ "example": "heads/feature-a",
292498
+ "schema": {
292499
+ "type": "string"
292500
+ },
292501
+ "x-multi-segment": true
292502
+ },
292360
292503
  "invitation-id": {
292361
292504
  "name": "invitation_id",
292362
292505
  "description": "The unique identifier of the invitation.",