From 0b9435982199ee6e3bc243611e52ae13322b3aaf Mon Sep 17 00:00:00 2001 From: Sunil Singh Date: Wed, 27 Dec 2023 07:56:04 -0800 Subject: [PATCH 1/7] Updating Capturing API section with intructions on enabling the View in API button. Signed-off-by: Sunil Singh --- docs/pages-for-subheaders/about-the-api.md | 2 ++ .../version-2.7/pages-for-subheaders/about-the-api.md | 2 ++ .../version-2.8/pages-for-subheaders/about-the-api.md | 2 ++ 3 files changed, 6 insertions(+) diff --git a/docs/pages-for-subheaders/about-the-api.md b/docs/pages-for-subheaders/about-the-api.md index 3b39d7c2717..93b6b15c85d 100644 --- a/docs/pages-for-subheaders/about-the-api.md +++ b/docs/pages-for-subheaders/about-the-api.md @@ -82,3 +82,5 @@ You can use browser developer tools to capture how the Rancher API is called. Fo 1. In the Rancher UI, click **Create**. In the developer tools, you should see a new network request with the name `cluster?_replace=true`. 1. Right-click `cluster?_replace=true` and click **Copy > Copy as cURL.** 1. Paste the result into any text editor. You will be able to see the POST request, including the URL it was sent to, all of the headers, and the full body of the request. This command can be used to create a cluster from the command line. Note: The request should be stored in a safe place because it contains credentials. + +Additionally, you can use the **View in API** link to view captured Rancher API calls for your respective clusters and resources located in the clickable `⋮` from the UI. This feature is not enabled by default. In order to enable, click on your **User Tile** in the top right corner of the UI and from the dropdown click on **Preferences**. Once on the page, navigate to the `Advanced Features` section and click the **Enable "View in API"** button. Once checked, the **View in API** link will now appear under the `⋮` sub-menu on resource pages in the UI. diff --git a/versioned_docs/version-2.7/pages-for-subheaders/about-the-api.md b/versioned_docs/version-2.7/pages-for-subheaders/about-the-api.md index 3b39d7c2717..93b6b15c85d 100644 --- a/versioned_docs/version-2.7/pages-for-subheaders/about-the-api.md +++ b/versioned_docs/version-2.7/pages-for-subheaders/about-the-api.md @@ -82,3 +82,5 @@ You can use browser developer tools to capture how the Rancher API is called. Fo 1. In the Rancher UI, click **Create**. In the developer tools, you should see a new network request with the name `cluster?_replace=true`. 1. Right-click `cluster?_replace=true` and click **Copy > Copy as cURL.** 1. Paste the result into any text editor. You will be able to see the POST request, including the URL it was sent to, all of the headers, and the full body of the request. This command can be used to create a cluster from the command line. Note: The request should be stored in a safe place because it contains credentials. + +Additionally, you can use the **View in API** link to view captured Rancher API calls for your respective clusters and resources located in the clickable `⋮` from the UI. This feature is not enabled by default. In order to enable, click on your **User Tile** in the top right corner of the UI and from the dropdown click on **Preferences**. Once on the page, navigate to the `Advanced Features` section and click the **Enable "View in API"** button. Once checked, the **View in API** link will now appear under the `⋮` sub-menu on resource pages in the UI. diff --git a/versioned_docs/version-2.8/pages-for-subheaders/about-the-api.md b/versioned_docs/version-2.8/pages-for-subheaders/about-the-api.md index 3b39d7c2717..93b6b15c85d 100644 --- a/versioned_docs/version-2.8/pages-for-subheaders/about-the-api.md +++ b/versioned_docs/version-2.8/pages-for-subheaders/about-the-api.md @@ -82,3 +82,5 @@ You can use browser developer tools to capture how the Rancher API is called. Fo 1. In the Rancher UI, click **Create**. In the developer tools, you should see a new network request with the name `cluster?_replace=true`. 1. Right-click `cluster?_replace=true` and click **Copy > Copy as cURL.** 1. Paste the result into any text editor. You will be able to see the POST request, including the URL it was sent to, all of the headers, and the full body of the request. This command can be used to create a cluster from the command line. Note: The request should be stored in a safe place because it contains credentials. + +Additionally, you can use the **View in API** link to view captured Rancher API calls for your respective clusters and resources located in the clickable `⋮` from the UI. This feature is not enabled by default. In order to enable, click on your **User Tile** in the top right corner of the UI and from the dropdown click on **Preferences**. Once on the page, navigate to the `Advanced Features` section and click the **Enable "View in API"** button. Once checked, the **View in API** link will now appear under the `⋮` sub-menu on resource pages in the UI. From 1b89d377dfe97fdfe1b3b4f720f819da1eaee098 Mon Sep 17 00:00:00 2001 From: Sunil Singh Date: Wed, 27 Dec 2023 10:47:25 -0800 Subject: [PATCH 2/7] Update docs/pages-for-subheaders/about-the-api.md Co-authored-by: Marty Hernandez Avedon --- docs/pages-for-subheaders/about-the-api.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/pages-for-subheaders/about-the-api.md b/docs/pages-for-subheaders/about-the-api.md index 93b6b15c85d..d9d881bdea5 100644 --- a/docs/pages-for-subheaders/about-the-api.md +++ b/docs/pages-for-subheaders/about-the-api.md @@ -83,4 +83,11 @@ You can use browser developer tools to capture how the Rancher API is called. Fo 1. Right-click `cluster?_replace=true` and click **Copy > Copy as cURL.** 1. Paste the result into any text editor. You will be able to see the POST request, including the URL it was sent to, all of the headers, and the full body of the request. This command can be used to create a cluster from the command line. Note: The request should be stored in a safe place because it contains credentials. -Additionally, you can use the **View in API** link to view captured Rancher API calls for your respective clusters and resources located in the clickable `⋮` from the UI. This feature is not enabled by default. In order to enable, click on your **User Tile** in the top right corner of the UI and from the dropdown click on **Preferences**. Once on the page, navigate to the `Advanced Features` section and click the **Enable "View in API"** button. Once checked, the **View in API** link will now appear under the `⋮` sub-menu on resource pages in the UI. +### Enable View in API + +You can also view captured Rancher API calls for your respective clusters and resources. This feature is not enabled by default. To enable it: + +1. Click on your **User Tile** in the top right corner of the UI and select **Preferences** from the dropdown menu. +2. Under the **Advanced Features** section, click **Enable "View in API"** + +Once checked, the **View in API** link will now appear under the **⋮** sub-menu on resource pages in the UI. From 86e4d503a363d61cb94521319482acee88b3634b Mon Sep 17 00:00:00 2001 From: Sunil Singh Date: Wed, 27 Dec 2023 10:47:38 -0800 Subject: [PATCH 3/7] Update versioned_docs/version-2.7/pages-for-subheaders/about-the-api.md Co-authored-by: Marty Hernandez Avedon --- .../version-2.7/pages-for-subheaders/about-the-api.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/versioned_docs/version-2.7/pages-for-subheaders/about-the-api.md b/versioned_docs/version-2.7/pages-for-subheaders/about-the-api.md index 93b6b15c85d..847875decf6 100644 --- a/versioned_docs/version-2.7/pages-for-subheaders/about-the-api.md +++ b/versioned_docs/version-2.7/pages-for-subheaders/about-the-api.md @@ -83,4 +83,9 @@ You can use browser developer tools to capture how the Rancher API is called. Fo 1. Right-click `cluster?_replace=true` and click **Copy > Copy as cURL.** 1. Paste the result into any text editor. You will be able to see the POST request, including the URL it was sent to, all of the headers, and the full body of the request. This command can be used to create a cluster from the command line. Note: The request should be stored in a safe place because it contains credentials. -Additionally, you can use the **View in API** link to view captured Rancher API calls for your respective clusters and resources located in the clickable `⋮` from the UI. This feature is not enabled by default. In order to enable, click on your **User Tile** in the top right corner of the UI and from the dropdown click on **Preferences**. Once on the page, navigate to the `Advanced Features` section and click the **Enable "View in API"** button. Once checked, the **View in API** link will now appear under the `⋮` sub-menu on resource pages in the UI. +### Enable View in API +You can also view captured Rancher API calls for your respective clusters and resources. This feature is not enabled by default. To enable it: +1. Click on your **User Tile** in the top right corner of the UI and select **Preferences** from the dropdown menu. +2. Under the **Advanced Features** section, click **Enable "View in API"** + +Once checked, the **View in API** link will now appear under the **⋮** sub-menu on resource pages in the UI. From ae6a4b43b67e7244b475a6b3f1f2def7e157ea74 Mon Sep 17 00:00:00 2001 From: Sunil Singh Date: Wed, 27 Dec 2023 10:47:44 -0800 Subject: [PATCH 4/7] Update versioned_docs/version-2.8/pages-for-subheaders/about-the-api.md Co-authored-by: Marty Hernandez Avedon --- .../version-2.8/pages-for-subheaders/about-the-api.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/versioned_docs/version-2.8/pages-for-subheaders/about-the-api.md b/versioned_docs/version-2.8/pages-for-subheaders/about-the-api.md index 93b6b15c85d..847875decf6 100644 --- a/versioned_docs/version-2.8/pages-for-subheaders/about-the-api.md +++ b/versioned_docs/version-2.8/pages-for-subheaders/about-the-api.md @@ -83,4 +83,9 @@ You can use browser developer tools to capture how the Rancher API is called. Fo 1. Right-click `cluster?_replace=true` and click **Copy > Copy as cURL.** 1. Paste the result into any text editor. You will be able to see the POST request, including the URL it was sent to, all of the headers, and the full body of the request. This command can be used to create a cluster from the command line. Note: The request should be stored in a safe place because it contains credentials. -Additionally, you can use the **View in API** link to view captured Rancher API calls for your respective clusters and resources located in the clickable `⋮` from the UI. This feature is not enabled by default. In order to enable, click on your **User Tile** in the top right corner of the UI and from the dropdown click on **Preferences**. Once on the page, navigate to the `Advanced Features` section and click the **Enable "View in API"** button. Once checked, the **View in API** link will now appear under the `⋮` sub-menu on resource pages in the UI. +### Enable View in API +You can also view captured Rancher API calls for your respective clusters and resources. This feature is not enabled by default. To enable it: +1. Click on your **User Tile** in the top right corner of the UI and select **Preferences** from the dropdown menu. +2. Under the **Advanced Features** section, click **Enable "View in API"** + +Once checked, the **View in API** link will now appear under the **⋮** sub-menu on resource pages in the UI. From 2221c5adebe265e235f094a7d2fb6a5b4e827de7 Mon Sep 17 00:00:00 2001 From: Sunil Singh Date: Thu, 28 Dec 2023 10:35:03 -0800 Subject: [PATCH 5/7] Update versioned_docs/version-2.7/pages-for-subheaders/about-the-api.md Co-authored-by: Lucas Saintarbor --- versioned_docs/version-2.7/pages-for-subheaders/about-the-api.md | 1 + 1 file changed, 1 insertion(+) diff --git a/versioned_docs/version-2.7/pages-for-subheaders/about-the-api.md b/versioned_docs/version-2.7/pages-for-subheaders/about-the-api.md index 847875decf6..9923066ab31 100644 --- a/versioned_docs/version-2.7/pages-for-subheaders/about-the-api.md +++ b/versioned_docs/version-2.7/pages-for-subheaders/about-the-api.md @@ -85,6 +85,7 @@ You can use browser developer tools to capture how the Rancher API is called. Fo ### Enable View in API You can also view captured Rancher API calls for your respective clusters and resources. This feature is not enabled by default. To enable it: + 1. Click on your **User Tile** in the top right corner of the UI and select **Preferences** from the dropdown menu. 2. Under the **Advanced Features** section, click **Enable "View in API"** From 4de6dec7cdb77dc75666e0f34a710c024e3d61d1 Mon Sep 17 00:00:00 2001 From: Sunil Singh Date: Thu, 28 Dec 2023 10:35:08 -0800 Subject: [PATCH 6/7] Update versioned_docs/version-2.8/pages-for-subheaders/about-the-api.md Co-authored-by: Lucas Saintarbor --- versioned_docs/version-2.8/pages-for-subheaders/about-the-api.md | 1 + 1 file changed, 1 insertion(+) diff --git a/versioned_docs/version-2.8/pages-for-subheaders/about-the-api.md b/versioned_docs/version-2.8/pages-for-subheaders/about-the-api.md index 847875decf6..9923066ab31 100644 --- a/versioned_docs/version-2.8/pages-for-subheaders/about-the-api.md +++ b/versioned_docs/version-2.8/pages-for-subheaders/about-the-api.md @@ -85,6 +85,7 @@ You can use browser developer tools to capture how the Rancher API is called. Fo ### Enable View in API You can also view captured Rancher API calls for your respective clusters and resources. This feature is not enabled by default. To enable it: + 1. Click on your **User Tile** in the top right corner of the UI and select **Preferences** from the dropdown menu. 2. Under the **Advanced Features** section, click **Enable "View in API"** From dce604dc004acde1b94e4cbcde5356b9af328aee Mon Sep 17 00:00:00 2001 From: Sunil Singh Date: Thu, 28 Dec 2023 10:38:07 -0800 Subject: [PATCH 7/7] Cleaning up the markdown whitespace. Signed-off-by: Sunil Singh --- docs/pages-for-subheaders/about-the-api.md | 6 +++--- .../version-2.7/pages-for-subheaders/about-the-api.md | 2 +- .../version-2.8/pages-for-subheaders/about-the-api.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/pages-for-subheaders/about-the-api.md b/docs/pages-for-subheaders/about-the-api.md index d9d881bdea5..43e58a0429d 100644 --- a/docs/pages-for-subheaders/about-the-api.md +++ b/docs/pages-for-subheaders/about-the-api.md @@ -85,9 +85,9 @@ You can use browser developer tools to capture how the Rancher API is called. Fo ### Enable View in API -You can also view captured Rancher API calls for your respective clusters and resources. This feature is not enabled by default. To enable it: +You can also view captured Rancher API calls for your respective clusters and resources. This feature is not enabled by default. To enable it: -1. Click on your **User Tile** in the top right corner of the UI and select **Preferences** from the dropdown menu. +1. Click on your **User Tile** in the top right corner of the UI and select **Preferences** from the dropdown menu. 2. Under the **Advanced Features** section, click **Enable "View in API"** - + Once checked, the **View in API** link will now appear under the **⋮** sub-menu on resource pages in the UI. diff --git a/versioned_docs/version-2.7/pages-for-subheaders/about-the-api.md b/versioned_docs/version-2.7/pages-for-subheaders/about-the-api.md index 9923066ab31..8ae08ab09f0 100644 --- a/versioned_docs/version-2.7/pages-for-subheaders/about-the-api.md +++ b/versioned_docs/version-2.7/pages-for-subheaders/about-the-api.md @@ -88,5 +88,5 @@ You can also view captured Rancher API calls for your respective clusters and re 1. Click on your **User Tile** in the top right corner of the UI and select **Preferences** from the dropdown menu. 2. Under the **Advanced Features** section, click **Enable "View in API"** - + Once checked, the **View in API** link will now appear under the **⋮** sub-menu on resource pages in the UI. diff --git a/versioned_docs/version-2.8/pages-for-subheaders/about-the-api.md b/versioned_docs/version-2.8/pages-for-subheaders/about-the-api.md index 9923066ab31..8ae08ab09f0 100644 --- a/versioned_docs/version-2.8/pages-for-subheaders/about-the-api.md +++ b/versioned_docs/version-2.8/pages-for-subheaders/about-the-api.md @@ -88,5 +88,5 @@ You can also view captured Rancher API calls for your respective clusters and re 1. Click on your **User Tile** in the top right corner of the UI and select **Preferences** from the dropdown menu. 2. Under the **Advanced Features** section, click **Enable "View in API"** - + Once checked, the **View in API** link will now appear under the **⋮** sub-menu on resource pages in the UI.