diff --git a/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.json b/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.json index 360ea85a1..6bd90a701 100644 --- a/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.json +++ b/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.json @@ -68503,15 +68503,15 @@ }, "/manage/v1/config/init": { "post": { - "summary": "Initialize instance configuration with license upload", - "description": "When you boot a GitHub instance for the first time, you can use this endpoint to upload a license.\n\nNote that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process.\n\nThis endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "summary": "Initialize instance configuration with license and password", + "description": "When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.\n\n> [!IMPORTANT]\n> To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process)\n\nThe root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/initialize-instance-configuration", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload" + "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password" }, "servers": [ { @@ -68554,7 +68554,7 @@ "default": { "value": { "license": "@enterprise.ghl", - "password": "secret-password!" + "password": "provide-password-here!" } } } @@ -68749,7 +68749,7 @@ }, "put": { "summary": "Upload an enterprise license", - "description": "Uploads an enterprise license. This operation does not automatically activate the license.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "description": "Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/license-upload", "tags": [ "enterprise-admin" diff --git a/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.yaml b/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.yaml index 8829a8498..d28c8e58b 100644 --- a/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.yaml +++ b/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.yaml @@ -19011,13 +19011,14 @@ paths: subcategory: manage-ghes "/manage/v1/config/init": post: - summary: Initialize instance configuration with license upload + summary: Initialize instance configuration with license and password description: |- - When you boot a GitHub instance for the first time, you can use this endpoint to upload a license. + When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password. - Note that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process. + > [!IMPORTANT] + > To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) - This endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console. + The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). @@ -19026,7 +19027,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload + url: https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password servers: - url: "{protocol}://{hostname}" variables: @@ -19057,7 +19058,7 @@ paths: default: value: license: "@enterprise.ghl" - password: secret-password! + password: provide-password-here! responses: '202': description: Response @@ -19202,7 +19203,7 @@ paths: put: summary: Upload an enterprise license description: |- - Uploads an enterprise license. This operation does not automatically activate the license. + Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). diff --git a/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.deref.json b/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.deref.json index 360ea85a1..6bd90a701 100644 --- a/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.deref.json +++ b/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.deref.json @@ -68503,15 +68503,15 @@ }, "/manage/v1/config/init": { "post": { - "summary": "Initialize instance configuration with license upload", - "description": "When you boot a GitHub instance for the first time, you can use this endpoint to upload a license.\n\nNote that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process.\n\nThis endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "summary": "Initialize instance configuration with license and password", + "description": "When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.\n\n> [!IMPORTANT]\n> To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process)\n\nThe root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/initialize-instance-configuration", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload" + "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password" }, "servers": [ { @@ -68554,7 +68554,7 @@ "default": { "value": { "license": "@enterprise.ghl", - "password": "secret-password!" + "password": "provide-password-here!" } } } @@ -68749,7 +68749,7 @@ }, "put": { "summary": "Upload an enterprise license", - "description": "Uploads an enterprise license. This operation does not automatically activate the license.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "description": "Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/license-upload", "tags": [ "enterprise-admin" diff --git a/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.deref.yaml b/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.deref.yaml index 8829a8498..d28c8e58b 100644 --- a/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.deref.yaml +++ b/descriptions-next/ghes-3.12/dereferenced/ghes-3.12.deref.yaml @@ -19011,13 +19011,14 @@ paths: subcategory: manage-ghes "/manage/v1/config/init": post: - summary: Initialize instance configuration with license upload + summary: Initialize instance configuration with license and password description: |- - When you boot a GitHub instance for the first time, you can use this endpoint to upload a license. + When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password. - Note that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process. + > [!IMPORTANT] + > To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) - This endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console. + The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). @@ -19026,7 +19027,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload + url: https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password servers: - url: "{protocol}://{hostname}" variables: @@ -19057,7 +19058,7 @@ paths: default: value: license: "@enterprise.ghl" - password: secret-password! + password: provide-password-here! responses: '202': description: Response @@ -19202,7 +19203,7 @@ paths: put: summary: Upload an enterprise license description: |- - Uploads an enterprise license. This operation does not automatically activate the license. + Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). diff --git a/descriptions-next/ghes-3.12/ghes-3.12.2022-11-28.json b/descriptions-next/ghes-3.12/ghes-3.12.2022-11-28.json index 021cd6caf..bf8b78d6d 100644 --- a/descriptions-next/ghes-3.12/ghes-3.12.2022-11-28.json +++ b/descriptions-next/ghes-3.12/ghes-3.12.2022-11-28.json @@ -10427,15 +10427,15 @@ }, "/manage/v1/config/init": { "post": { - "summary": "Initialize instance configuration with license upload", - "description": "When you boot a GitHub instance for the first time, you can use this endpoint to upload a license.\n\nNote that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process.\n\nThis endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "summary": "Initialize instance configuration with license and password", + "description": "When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.\n\n> [!IMPORTANT]\n> To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process)\n\nThe root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/initialize-instance-configuration", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload" + "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password" }, "servers": [ { @@ -10463,7 +10463,7 @@ "default": { "value": { "license": "@enterprise.ghl", - "password": "secret-password!" + "password": "provide-password-here!" } } } @@ -10551,7 +10551,7 @@ }, "put": { "summary": "Upload an enterprise license", - "description": "Uploads an enterprise license. This operation does not automatically activate the license.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "description": "Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/license-upload", "tags": [ "enterprise-admin" diff --git a/descriptions-next/ghes-3.12/ghes-3.12.2022-11-28.yaml b/descriptions-next/ghes-3.12/ghes-3.12.2022-11-28.yaml index 8f543d6f7..3a9600bd8 100644 --- a/descriptions-next/ghes-3.12/ghes-3.12.2022-11-28.yaml +++ b/descriptions-next/ghes-3.12/ghes-3.12.2022-11-28.yaml @@ -7300,13 +7300,14 @@ paths: subcategory: manage-ghes "/manage/v1/config/init": post: - summary: Initialize instance configuration with license upload + summary: Initialize instance configuration with license and password description: |- - When you boot a GitHub instance for the first time, you can use this endpoint to upload a license. + When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password. - Note that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process. + > [!IMPORTANT] + > To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) - This endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console. + The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). @@ -7315,7 +7316,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload + url: https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password servers: - url: "{protocol}://{hostname}" variables: @@ -7335,7 +7336,7 @@ paths: default: value: license: "@enterprise.ghl" - password: secret-password! + password: provide-password-here! responses: '202': description: Response @@ -7392,7 +7393,7 @@ paths: put: summary: Upload an enterprise license description: |- - Uploads an enterprise license. This operation does not automatically activate the license. + Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). diff --git a/descriptions-next/ghes-3.12/ghes-3.12.json b/descriptions-next/ghes-3.12/ghes-3.12.json index 021cd6caf..bf8b78d6d 100644 --- a/descriptions-next/ghes-3.12/ghes-3.12.json +++ b/descriptions-next/ghes-3.12/ghes-3.12.json @@ -10427,15 +10427,15 @@ }, "/manage/v1/config/init": { "post": { - "summary": "Initialize instance configuration with license upload", - "description": "When you boot a GitHub instance for the first time, you can use this endpoint to upload a license.\n\nNote that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process.\n\nThis endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "summary": "Initialize instance configuration with license and password", + "description": "When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.\n\n> [!IMPORTANT]\n> To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process)\n\nThe root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/initialize-instance-configuration", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload" + "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password" }, "servers": [ { @@ -10463,7 +10463,7 @@ "default": { "value": { "license": "@enterprise.ghl", - "password": "secret-password!" + "password": "provide-password-here!" } } } @@ -10551,7 +10551,7 @@ }, "put": { "summary": "Upload an enterprise license", - "description": "Uploads an enterprise license. This operation does not automatically activate the license.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "description": "Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/license-upload", "tags": [ "enterprise-admin" diff --git a/descriptions-next/ghes-3.12/ghes-3.12.yaml b/descriptions-next/ghes-3.12/ghes-3.12.yaml index 8f543d6f7..3a9600bd8 100644 --- a/descriptions-next/ghes-3.12/ghes-3.12.yaml +++ b/descriptions-next/ghes-3.12/ghes-3.12.yaml @@ -7300,13 +7300,14 @@ paths: subcategory: manage-ghes "/manage/v1/config/init": post: - summary: Initialize instance configuration with license upload + summary: Initialize instance configuration with license and password description: |- - When you boot a GitHub instance for the first time, you can use this endpoint to upload a license. + When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password. - Note that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process. + > [!IMPORTANT] + > To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) - This endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console. + The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). @@ -7315,7 +7316,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload + url: https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password servers: - url: "{protocol}://{hostname}" variables: @@ -7335,7 +7336,7 @@ paths: default: value: license: "@enterprise.ghl" - password: secret-password! + password: provide-password-here! responses: '202': description: Response @@ -7392,7 +7393,7 @@ paths: put: summary: Upload an enterprise license description: |- - Uploads an enterprise license. This operation does not automatically activate the license. + Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). diff --git a/descriptions-next/ghes-3.13/dereferenced/ghes-3.13.2022-11-28.deref.json b/descriptions-next/ghes-3.13/dereferenced/ghes-3.13.2022-11-28.deref.json index 2fdd764dc..806a9da8f 100644 --- a/descriptions-next/ghes-3.13/dereferenced/ghes-3.13.2022-11-28.deref.json +++ b/descriptions-next/ghes-3.13/dereferenced/ghes-3.13.2022-11-28.deref.json @@ -68642,15 +68642,15 @@ }, "/manage/v1/config/init": { "post": { - "summary": "Initialize instance configuration with license upload", - "description": "When you boot a GitHub instance for the first time, you can use this endpoint to upload a license.\n\nNote that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process.\n\nThis endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "summary": "Initialize instance configuration with license and password", + "description": "When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.\n\n> [!IMPORTANT]\n> To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process)\n\nThe root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/initialize-instance-configuration", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password" }, "servers": [ { @@ -68693,7 +68693,7 @@ "default": { "value": { "license": "@enterprise.ghl", - "password": "secret-password!" + "password": "provide-password-here!" } } } @@ -68888,7 +68888,7 @@ }, "put": { "summary": "Upload an enterprise license", - "description": "Uploads an enterprise license. This operation does not automatically activate the license.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "description": "Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/license-upload", "tags": [ "enterprise-admin" @@ -68915,7 +68915,7 @@ "parameters": [ { "name": "apply", - "description": "Whether to apply changes from the license. Uploading a license does not automatically apply changes. To make the changes effective, you can specify to apply the license too.", + "description": "Whether to instantly apply changes from the license. Otherwise the new license can be applied using the [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) endpoint.", "in": "query", "required": false, "schema": { diff --git a/descriptions-next/ghes-3.13/dereferenced/ghes-3.13.2022-11-28.deref.yaml b/descriptions-next/ghes-3.13/dereferenced/ghes-3.13.2022-11-28.deref.yaml index b5cfe7e02..85a12c673 100644 --- a/descriptions-next/ghes-3.13/dereferenced/ghes-3.13.2022-11-28.deref.yaml +++ b/descriptions-next/ghes-3.13/dereferenced/ghes-3.13.2022-11-28.deref.yaml @@ -19025,13 +19025,14 @@ paths: subcategory: manage-ghes "/manage/v1/config/init": post: - summary: Initialize instance configuration with license upload + summary: Initialize instance configuration with license and password description: |- - When you boot a GitHub instance for the first time, you can use this endpoint to upload a license. + When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password. - Note that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process. + > [!IMPORTANT] + > To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) - This endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console. + The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). @@ -19040,7 +19041,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password servers: - url: "{protocol}://{hostname}" variables: @@ -19071,7 +19072,7 @@ paths: default: value: license: "@enterprise.ghl" - password: secret-password! + password: provide-password-here! responses: '202': description: Response @@ -19216,7 +19217,7 @@ paths: put: summary: Upload an enterprise license description: |- - Uploads an enterprise license. This operation does not automatically activate the license. + Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). @@ -19237,9 +19238,9 @@ paths: description: Self-hosted Enterprise Server protocol parameters: - name: apply - description: Whether to apply changes from the license. Uploading a license - does not automatically apply changes. To make the changes effective, you - can specify to apply the license too. + description: Whether to instantly apply changes from the license. Otherwise + the new license can be applied using the [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) + endpoint. in: query required: false schema: diff --git a/descriptions-next/ghes-3.13/dereferenced/ghes-3.13.deref.json b/descriptions-next/ghes-3.13/dereferenced/ghes-3.13.deref.json index 2fdd764dc..806a9da8f 100644 --- a/descriptions-next/ghes-3.13/dereferenced/ghes-3.13.deref.json +++ b/descriptions-next/ghes-3.13/dereferenced/ghes-3.13.deref.json @@ -68642,15 +68642,15 @@ }, "/manage/v1/config/init": { "post": { - "summary": "Initialize instance configuration with license upload", - "description": "When you boot a GitHub instance for the first time, you can use this endpoint to upload a license.\n\nNote that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process.\n\nThis endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "summary": "Initialize instance configuration with license and password", + "description": "When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.\n\n> [!IMPORTANT]\n> To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process)\n\nThe root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/initialize-instance-configuration", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password" }, "servers": [ { @@ -68693,7 +68693,7 @@ "default": { "value": { "license": "@enterprise.ghl", - "password": "secret-password!" + "password": "provide-password-here!" } } } @@ -68888,7 +68888,7 @@ }, "put": { "summary": "Upload an enterprise license", - "description": "Uploads an enterprise license. This operation does not automatically activate the license.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "description": "Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/license-upload", "tags": [ "enterprise-admin" @@ -68915,7 +68915,7 @@ "parameters": [ { "name": "apply", - "description": "Whether to apply changes from the license. Uploading a license does not automatically apply changes. To make the changes effective, you can specify to apply the license too.", + "description": "Whether to instantly apply changes from the license. Otherwise the new license can be applied using the [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) endpoint.", "in": "query", "required": false, "schema": { diff --git a/descriptions-next/ghes-3.13/dereferenced/ghes-3.13.deref.yaml b/descriptions-next/ghes-3.13/dereferenced/ghes-3.13.deref.yaml index b5cfe7e02..85a12c673 100644 --- a/descriptions-next/ghes-3.13/dereferenced/ghes-3.13.deref.yaml +++ b/descriptions-next/ghes-3.13/dereferenced/ghes-3.13.deref.yaml @@ -19025,13 +19025,14 @@ paths: subcategory: manage-ghes "/manage/v1/config/init": post: - summary: Initialize instance configuration with license upload + summary: Initialize instance configuration with license and password description: |- - When you boot a GitHub instance for the first time, you can use this endpoint to upload a license. + When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password. - Note that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process. + > [!IMPORTANT] + > To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) - This endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console. + The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). @@ -19040,7 +19041,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password servers: - url: "{protocol}://{hostname}" variables: @@ -19071,7 +19072,7 @@ paths: default: value: license: "@enterprise.ghl" - password: secret-password! + password: provide-password-here! responses: '202': description: Response @@ -19216,7 +19217,7 @@ paths: put: summary: Upload an enterprise license description: |- - Uploads an enterprise license. This operation does not automatically activate the license. + Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). @@ -19237,9 +19238,9 @@ paths: description: Self-hosted Enterprise Server protocol parameters: - name: apply - description: Whether to apply changes from the license. Uploading a license - does not automatically apply changes. To make the changes effective, you - can specify to apply the license too. + description: Whether to instantly apply changes from the license. Otherwise + the new license can be applied using the [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) + endpoint. in: query required: false schema: diff --git a/descriptions-next/ghes-3.13/ghes-3.13.2022-11-28.json b/descriptions-next/ghes-3.13/ghes-3.13.2022-11-28.json index 156dbbdca..31548169f 100644 --- a/descriptions-next/ghes-3.13/ghes-3.13.2022-11-28.json +++ b/descriptions-next/ghes-3.13/ghes-3.13.2022-11-28.json @@ -10429,15 +10429,15 @@ }, "/manage/v1/config/init": { "post": { - "summary": "Initialize instance configuration with license upload", - "description": "When you boot a GitHub instance for the first time, you can use this endpoint to upload a license.\n\nNote that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process.\n\nThis endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "summary": "Initialize instance configuration with license and password", + "description": "When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.\n\n> [!IMPORTANT]\n> To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process)\n\nThe root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/initialize-instance-configuration", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password" }, "servers": [ { @@ -10465,7 +10465,7 @@ "default": { "value": { "license": "@enterprise.ghl", - "password": "secret-password!" + "password": "provide-password-here!" } } } @@ -10553,7 +10553,7 @@ }, "put": { "summary": "Upload an enterprise license", - "description": "Uploads an enterprise license. This operation does not automatically activate the license.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "description": "Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/license-upload", "tags": [ "enterprise-admin" @@ -288402,7 +288402,7 @@ }, "license-apply": { "name": "apply", - "description": "Whether to apply changes from the license. Uploading a license does not automatically apply changes. To make the changes effective, you can specify to apply the license too.", + "description": "Whether to instantly apply changes from the license. Otherwise the new license can be applied using the [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) endpoint.", "in": "query", "required": false, "schema": { diff --git a/descriptions-next/ghes-3.13/ghes-3.13.2022-11-28.yaml b/descriptions-next/ghes-3.13/ghes-3.13.2022-11-28.yaml index 86d96ad28..5214390b1 100644 --- a/descriptions-next/ghes-3.13/ghes-3.13.2022-11-28.yaml +++ b/descriptions-next/ghes-3.13/ghes-3.13.2022-11-28.yaml @@ -7304,13 +7304,14 @@ paths: subcategory: manage-ghes "/manage/v1/config/init": post: - summary: Initialize instance configuration with license upload + summary: Initialize instance configuration with license and password description: |- - When you boot a GitHub instance for the first time, you can use this endpoint to upload a license. + When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password. - Note that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process. + > [!IMPORTANT] + > To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) - This endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console. + The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). @@ -7319,7 +7320,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password servers: - url: "{protocol}://{hostname}" variables: @@ -7339,7 +7340,7 @@ paths: default: value: license: "@enterprise.ghl" - password: secret-password! + password: provide-password-here! responses: '202': description: Response @@ -7396,7 +7397,7 @@ paths: put: summary: Upload an enterprise license description: |- - Uploads an enterprise license. This operation does not automatically activate the license. + Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). @@ -214641,9 +214642,9 @@ components: type: string license-apply: name: apply - description: Whether to apply changes from the license. Uploading a license - does not automatically apply changes. To make the changes effective, you can - specify to apply the license too. + description: Whether to instantly apply changes from the license. Otherwise + the new license can be applied using the [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) + endpoint. in: query required: false schema: diff --git a/descriptions-next/ghes-3.13/ghes-3.13.json b/descriptions-next/ghes-3.13/ghes-3.13.json index 156dbbdca..31548169f 100644 --- a/descriptions-next/ghes-3.13/ghes-3.13.json +++ b/descriptions-next/ghes-3.13/ghes-3.13.json @@ -10429,15 +10429,15 @@ }, "/manage/v1/config/init": { "post": { - "summary": "Initialize instance configuration with license upload", - "description": "When you boot a GitHub instance for the first time, you can use this endpoint to upload a license.\n\nNote that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process.\n\nThis endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "summary": "Initialize instance configuration with license and password", + "description": "When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.\n\n> [!IMPORTANT]\n> To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process)\n\nThe root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/initialize-instance-configuration", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password" }, "servers": [ { @@ -10465,7 +10465,7 @@ "default": { "value": { "license": "@enterprise.ghl", - "password": "secret-password!" + "password": "provide-password-here!" } } } @@ -10553,7 +10553,7 @@ }, "put": { "summary": "Upload an enterprise license", - "description": "Uploads an enterprise license. This operation does not automatically activate the license.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "description": "Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/license-upload", "tags": [ "enterprise-admin" @@ -288402,7 +288402,7 @@ }, "license-apply": { "name": "apply", - "description": "Whether to apply changes from the license. Uploading a license does not automatically apply changes. To make the changes effective, you can specify to apply the license too.", + "description": "Whether to instantly apply changes from the license. Otherwise the new license can be applied using the [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) endpoint.", "in": "query", "required": false, "schema": { diff --git a/descriptions-next/ghes-3.13/ghes-3.13.yaml b/descriptions-next/ghes-3.13/ghes-3.13.yaml index 86d96ad28..5214390b1 100644 --- a/descriptions-next/ghes-3.13/ghes-3.13.yaml +++ b/descriptions-next/ghes-3.13/ghes-3.13.yaml @@ -7304,13 +7304,14 @@ paths: subcategory: manage-ghes "/manage/v1/config/init": post: - summary: Initialize instance configuration with license upload + summary: Initialize instance configuration with license and password description: |- - When you boot a GitHub instance for the first time, you can use this endpoint to upload a license. + When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password. - Note that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process. + > [!IMPORTANT] + > To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) - This endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console. + The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). @@ -7319,7 +7320,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password servers: - url: "{protocol}://{hostname}" variables: @@ -7339,7 +7340,7 @@ paths: default: value: license: "@enterprise.ghl" - password: secret-password! + password: provide-password-here! responses: '202': description: Response @@ -7396,7 +7397,7 @@ paths: put: summary: Upload an enterprise license description: |- - Uploads an enterprise license. This operation does not automatically activate the license. + Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). @@ -214641,9 +214642,9 @@ components: type: string license-apply: name: apply - description: Whether to apply changes from the license. Uploading a license - does not automatically apply changes. To make the changes effective, you can - specify to apply the license too. + description: Whether to instantly apply changes from the license. Otherwise + the new license can be applied using the [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) + endpoint. in: query required: false schema: diff --git a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json index 6a8343deb..d9cded6e7 100644 --- a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json +++ b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json @@ -68642,15 +68642,15 @@ }, "/manage/v1/config/init": { "post": { - "summary": "Initialize instance configuration with license upload", - "description": "When you boot a GitHub instance for the first time, you can use this endpoint to upload a license.\n\nNote that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process.\n\nThis endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "summary": "Initialize instance configuration with license and password", + "description": "When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.\n\n> [!IMPORTANT]\n> To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#start-configuration-apply-process)\n\nThe root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/initialize-instance-configuration", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password" }, "servers": [ { @@ -68693,7 +68693,7 @@ "default": { "value": { "license": "@enterprise.ghl", - "password": "secret-password!" + "password": "provide-password-here!" } } } @@ -68888,7 +68888,7 @@ }, "put": { "summary": "Upload an enterprise license", - "description": "Uploads an enterprise license. This operation does not automatically activate the license.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "description": "Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/license-upload", "tags": [ "enterprise-admin" @@ -68915,7 +68915,7 @@ "parameters": [ { "name": "apply", - "description": "Whether to apply changes from the license. Uploading a license does not automatically apply changes. To make the changes effective, you can specify to apply the license too.", + "description": "Whether to instantly apply changes from the license. Otherwise the new license can be applied using the [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) endpoint.", "in": "query", "required": false, "schema": { diff --git a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml index abeaf4c66..e0b923596 100644 --- a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml +++ b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml @@ -19044,13 +19044,14 @@ paths: subcategory: manage-ghes "/manage/v1/config/init": post: - summary: Initialize instance configuration with license upload + summary: Initialize instance configuration with license and password description: |- - When you boot a GitHub instance for the first time, you can use this endpoint to upload a license. + When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password. - Note that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process. + > [!IMPORTANT] + > To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) - This endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console. + The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). @@ -19059,7 +19060,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password servers: - url: "{protocol}://{hostname}" variables: @@ -19090,7 +19091,7 @@ paths: default: value: license: "@enterprise.ghl" - password: secret-password! + password: provide-password-here! responses: '202': {"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}