Merge pull request #4456 from github/openapi-update-b144bc2916df8ce6629565b83ba81ebd94af1092fcc73e96e44d8f5dcdcbf274

Update OpenAPI 3.0 Descriptions

1 files changed, 547 insertions, 2 deletions

diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json
index 43cb07125..79cddb95e 100644
--- a/descriptions/api.github.com/api.github.com.json
+++ b/descriptions/api.github.com/api.github.com.json
@@ -175,6 +175,10 @@
     {
       "name": "private-registries",
       "description": "Manage private registry configurations."
+    },
+    {
+      "name": "hosted-compute",
+      "description": "Manage hosted compute networking resources."
     }
   ],
   "servers": [
@@ -2998,6 +3002,9 @@
             "$ref": "#/components/parameters/dependabot-alert-comma-separated-packages"
           },
           {
+            "$ref": "#/components/parameters/dependabot-alert-comma-separated-epss"
+          },
+          {
             "$ref": "#/components/parameters/dependabot-alert-scope"
           },
           {
@@ -13392,6 +13399,9 @@
             "$ref": "#/components/parameters/dependabot-alert-comma-separated-packages"
           },
           {
+            "$ref": "#/components/parameters/dependabot-alert-comma-separated-epss"
+          },
+          {
             "$ref": "#/components/parameters/dependabot-alert-scope"
           },
           {
@@ -21377,6 +21387,380 @@
         }
       }
     },
+    "/orgs/{org}/settings/network-configurations": {
+      "get": {
+        "summary": "List hosted compute network configurations for an organization",
+        "description": "Lists all hosted compute network configurations configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint.",
+        "tags": [
+          "hosted-compute"
+        ],
+        "operationId": "hosted-compute/list-network-configurations-for-org",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/settings/network-configurations#list-hosted-compute-network-configurations-for-an-organization"
+        },
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/org"
+          },
+          {
+            "$ref": "#/components/parameters/per-page"
+          },
+          {
+            "$ref": "#/components/parameters/page"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "required": [
+                    "total_count",
+                    "network_configurations"
+                  ],
+                  "properties": {
+                    "total_count": {
+                      "type": "integer"
+                    },
+                    "network_configurations": {
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/network-configuration"
+                      }
+                    }
+                  }
+                },
+                "examples": {
+                  "default": {
+                    "$ref": "#/components/examples/network-configurations-paginated"
+                  }
+                }
+              }
+            },
+            "headers": {
+              "Link": {
+                "$ref": "#/components/headers/link"
+              }
+            }
+          }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "category": "settings",
+          "subcategory": "network-configurations"
+        }
+      },
+      "post": {
+        "summary": "Create a hosted compute network configuration for an organization",
+        "description": "Creates a hosted compute network configuration for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint.",
+        "tags": [
+          "hosted-compute"
+        ],
+        "operationId": "hosted-compute/create-network-configuration-for-org",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/settings/network-configurations#create-a-hosted-compute-network-configuration-for-an-organization"
+        },
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/org"
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "description": "Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.",
+                    "type": "string"
+                  },
+                  "compute_service": {
+                    "description": "The hosted compute service to use for the network configuration.",
+                    "type": "string",
+                    "enum": [
+                      "none",
+                      "actions"
+                    ]
+                  },
+                  "network_settings_ids": {
+                    "type": "array",
+                    "minItems": 1,
+                    "maxItems": 1,
+                    "description": "The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified.",
+                    "items": {
+                      "type": "string"
+                    }
+                  }
+                },
+                "required": [
+                  "name",
+                  "network_settings_ids"
+                ]
+              },
+              "examples": {
+                "default": {
+                  "value": {
+                    "name": "my-network-configuration",
+                    "network_settings_ids": [
+                      "23456789ABDCEF1"
+                    ],
+                    "compute_service": "actions"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/network-configuration"
+                },
+                "examples": {
+                  "default": {
+                    "$ref": "#/components/examples/network-configuration"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "category": "settings",
+          "subcategory": "network-configurations"
+        }
+      }
+    },
+    "/orgs/{org}/settings/network-configurations/{network_configuration_id}": {
+      "get": {
+        "summary": "Get a hosted compute network configuration for an organization",
+        "description": "Gets a hosted compute network configuration configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint.",
+        "tags": [
+          "hosted-compute"
+        ],
+        "operationId": "hosted-compute/get-network-configuration-for-org",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/settings/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization"
+        },
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/org"
+          },
+          {
+            "$ref": "#/components/parameters/network-configuration-id"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/network-configuration"
+                },
+                "examples": {
+                  "default": {
+                    "$ref": "#/components/examples/network-configuration"
+                  }
+                }
+              }
+            },
+            "headers": {
+              "Link": {
+                "$ref": "#/components/headers/link"
+              }
+            }
+          }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "category": "settings",
+          "subcategory": "network-configurations"
+        }
+      },
+      "patch": {
+        "summary": "Update a hosted compute network configuration for an organization",
+        "description": "Updates a hosted compute network configuration for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint.",
+        "tags": [
+          "hosted-compute"
+        ],
+        "operationId": "hosted-compute/update-network-configuration-for-org",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/settings/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization"
+        },
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/org"
+          },
+          {
+            "$ref": "#/components/parameters/network-configuration-id"
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "description": "Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.",
+                    "type": "string"
+                  },
+                  "compute_service": {
+                    "description": "The hosted compute service to use for the network configuration.",
+                    "type": "string",
+                    "enum": [
+                      "none",
+                      "actions"
+                    ]
+                  },
+                  "network_settings_ids": {
+                    "type": "array",
+                    "minItems": 0,
+                    "maxItems": 1,
+                    "description": "The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified.",
+                    "items": {
+                      "type": "string"
+                    }
+                  }
+                }
+              },
+              "examples": {
+                "default": {
+                  "value": {
+                    "name": "my-network-configuration",
+                    "network_settings_ids": [
+                      "23456789ABDCEF1"
+                    ],
+                    "compute_service": "actions"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/network-configuration"
+                },
+                "examples": {
+                  "default": {
+                    "$ref": "#/components/examples/network-configuration"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "category": "settings",
+          "subcategory": "network-configurations"
+        }
+      },
+      "delete": {
+        "summary": "Delete a hosted compute network configuration from an organization",
+        "description": "Deletes a hosted compute network configuration from an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint.",
+        "tags": [
+          "hosted-compute"
+        ],
+        "operationId": "hosted-compute/delete-network-configuration-from-org",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/settings/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization"
+        },
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/org"
+          },
+          {
+            "$ref": "#/components/parameters/network-configuration-id"
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "Response"
+          }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "category": "settings",
+          "subcategory": "network-configurations"
+        }
+      }
+    },
+    "/orgs/{org}/settings/network-settings/{network_settings_id}": {
+      "get": {
+        "summary": "Get a hosted compute network settings resource for an organization",
+        "description": "Gets a hosted compute network settings resource configured for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint.",
+        "tags": [
+          "hosted-compute"
+        ],
+        "operationId": "hosted-compute/get-network-settings-for-org",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/settings/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization"
+        },
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/org"
+          },
+          {
+            "$ref": "#/components/parameters/network-settings-id"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/network-settings"
+                },
+                "examples": {
+                  "default": {
+                    "$ref": "#/components/examples/network-settings"
+                  }
+                }
+              }
+            },
+            "headers": {
+              "Link": {
+                "$ref": "#/components/headers/link"
+              }
+            }
+          }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "category": "settings",
+          "subcategory": "network-configurations"
+        }
+      }
+    },
     "/orgs/{org}/team/{team_slug}/copilot/metrics": {
       "get": {
         "summary": "Get Copilot metrics for a team",
@@ -39550,6 +39934,9 @@
             "$ref": "#/components/parameters/dependabot-alert-comma-separated-manifests"
           },
           {
+            "$ref": "#/components/parameters/dependabot-alert-comma-separated-epss"
+          },
+          {
             "$ref": "#/components/parameters/dependabot-alert-scope"
           },
           {
@@ -47972,7 +48359,7 @@
                 "properties": {
                   "sub_issue_id": {
                     "type": "integer",
-                    "description": "The sub-issue to remove"
+                    "description": "The id of the sub-issue to remove"
                   }
                 },
                 "required": [
@@ -48127,7 +48514,7 @@
                 "properties": {
                   "sub_issue_id": {
                     "type": "integer",
-                    "description": "The sub-issue to add"
+                    "description": "The id of the sub-issue to add. The sub-issue must belong to the same repository as the parent issue"
                   },
                   "replace_parent": {
                     "type": "boolean",
@@ -108446,6 +108833,90 @@
           "estimated_storage_for_month"
         ]
       },
+      "network-configuration": {
+        "title": "Hosted compute network configuration",
+        "description": "A hosted compute network configuration.",
+        "type": "object",
+        "properties": {
+          "id": {
+            "description": "The unique identifier of the network configuration.",
+            "type": "string",
+            "example": "123ABC456DEF789"
+          },
+          "name": {
+            "description": "The name of the network configuration.",
+            "type": "string",
+            "example": "my-network-configuration"
+          },
+          "compute_service": {
+            "description": "The hosted compute service the network configuration supports.",
+            "type": "string",
+            "enum": [
+              "none",
+              "actions",
+              "codespaces"
+            ]
+          },
+          "network_settings_ids": {
+            "description": "The unique identifier of each network settings in the configuration.",
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "example": "123ABC456DEF789"
+          },
+          "created_on": {
+            "description": "The time at which the network configuration was created, in ISO 8601 format.",
+            "type": "string",
+            "format": "date-time",
+            "example": "2024-04-26T11:31:07Z",
+            "nullable": true
+          }
+        },
+        "required": [
+          "id",
+          "name",
+          "created_on"
+        ]
+      },
+      "network-settings": {
+        "title": "Hosted compute network settings resource",
+        "description": "A hosted compute network settings resource.",
+        "type": "object",
+        "properties": {
+          "id": {
+            "description": "The unique identifier of the network settings resource.",
+            "type": "string",
+            "example": "220F78DACB92BBFBC5E6F22DE1CCF52309D"
+          },
+          "network_configuration_id": {
+            "description": "The identifier of the network configuration that is using this settings resource.",
+            "type": "string",
+            "example": "934E208B3EE0BD60CF5F752C426BFB53562"
+          },
+          "name": {
+            "description": "The name of the network settings resource.",
+            "type": "string",
+            "example": "my-network-settings"
+          },
+          "subnet_id": {
+            "description": "The subnet this network settings resource is configured for.",
+            "type": "string",
+            "example": "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet"
+          },
+          "region": {
+            "description": "The location of the subnet this network settings resource is configured for.",
+            "type": "string",
+            "example": "eastus"
+          }
+        },
+        "required": [
+          "id",
+          "name",
+          "subnet_id",
+          "region"
+        ]
+      },
       "team-organization": {
         "title": "Team Organization",
         "description": "Team Organization",
@@ -276086,6 +276557,54 @@
           "estimated_storage_for_month": 40
         }
       },
+      "network-configurations-paginated": {
+        "value": {
+          "total_count": 2,
+          "network_configurations": [
+            {
+              "id": "123456789ABCDEF",
+              "name": "My network configuration",
+              "compute_service": "actions",
+              "network_settings_ids": [
+                "23456789ABDCEF1",
+                "3456789ABDCEF12"
+              ],
+              "created_on": "2022-10-09T23:39:01Z"
+            },
+            {
+              "id": "456789ABDCEF123",
+              "name": "My other configuration",
+              "compute_service": "none",
+              "network_settings_ids": [
+                "56789ABDCEF1234",
+                "6789ABDCEF12345"
+              ],
+              "created_on": "2023-04-26T15:23:37Z"
+            }
+          ]
+        }
+      },
+      "network-configuration": {
+        "value": {
+          "id": "123456789ABCDEF",
+          "name": "My network configuration",
+          "compute_service": "actions",
+          "network_settings_ids": [
+            "23456789ABDCEF1",
+            "3456789ABDCEF12"
+          ],
+          "created_on": "2022-10-09T23:39:01Z"
+        }
+      },
+      "network-settings": {
+        "value": {
+          "id": "220F78DACB92BBFBC5E6F22DE1CCF52309D",
+          "network_configuration_id": "934E208B3EE0BD60CF5F752C426BFB53562",
+          "name": "my_network_settings",
+          "subnet_id": "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet",
+          "region": "eastus"
+        }
+      },
       "team-full": {
         "value": {
           "id": 1,
@@ -296733,6 +297252,14 @@
           "type": "string"
         }
       },
+      "dependabot-alert-comma-separated-epss": {
+        "name": "epss_percentage",
+        "in": "query",
+        "description": "CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:\n- An exact number (`n`)\n- Comparators such as `>n`, `<n`, `>=n`, `<=n`\n- A range like `n..n`, where `n` is a number from 0.0 to 1.0\n\nFilters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.",
+        "schema": {
+          "type": "string"
+        }
+      },
       "dependabot-alert-scope": {
         "name": "scope",
         "in": "query",
@@ -297554,6 +298081,24 @@
           "type": "string"
         }
       },
+      "network-configuration-id": {
+        "name": "network_configuration_id",
+        "description": "Unique identifier of the hosted compute network configuration.",
+        "in": "path",
+        "required": true,
+        "schema": {
+          "type": "string"
+        }
+      },
+      "network-settings-id": {
+        "name": "network_settings_id",
+        "description": "Unique identifier of the hosted compute network settings.",
+        "in": "path",
+        "required": true,
+        "schema": {
+          "type": "string"
+        }
+      },
       "discussion-number": {
         "name": "discussion_number",
         "description": "The number that identifies the discussion.",