From 162dac042f9d19d8e7549062817885d0d44a3d0d Mon Sep 17 00:00:00 2001 From: Lenny Chen Date: Tue, 14 May 2024 11:02:38 -0700 Subject: [PATCH 1/2] docs: rename local mgmt api --- docs/api-content/api-docs/1-introduction.md | 23 ++++++++++++--------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/docs/api-content/api-docs/1-introduction.md b/docs/api-content/api-docs/1-introduction.md index f182abddd6..a7c6ff08cc 100644 --- a/docs/api-content/api-docs/1-introduction.md +++ b/docs/api-content/api-docs/1-introduction.md @@ -1,5 +1,5 @@ --- -title: "Introduction" +title: "Introduction - APIs" sidebar_label: "Introduction" description: "Palette API Introduction" hide_table_of_contents: false @@ -8,8 +8,8 @@ sidebar_custom_props: icon: "graph" --- -The API documentation section includes documentation for Palette API and Edge Host API. Edge Host API endpoints are Tech -Preview features and should not be used in production workloads. +The API documentation section includes documentation for Palette API and Local Management API. Local Management API +endpoints are Tech Preview features and should not be used in production workloads. ## Palette API @@ -267,12 +267,15 @@ The API rate limits are as follows: | /v1/clusterprofiles/:uid/validate/packs | 50 | 5 | 250 | | /v1/spectroclusters/:uid/profiles | 50 | 5 | 250 | -## Edge Host API +## Local Management API An Edge host has its own set of API endpoints. These API endpoints are available on each Edge host instead of on a -Palette instance. You can use Edge Host API endpoints to programmatically perform tasks such as retrieve information -about Edge clusters, retrieve the list of available images on your Edge host, and create local clusters using embedded -cluster definitions. +Palette instance. You can use Local Management API endpoints to programmatically perform tasks such as retrieve +information about Edge clusters, retrieve the list of available images on your Edge host, and create local clusters +using embedded cluster definitions. + +You can find the Open API Swagger specification for the Local Management API at the following location: +https://raw.githubusercontent.com/spectrocloud/librarium/version-4-3/docs/api-content/api-docs/edge-v1/emc-api.json :::preview @@ -304,9 +307,9 @@ If your credentials are valid, you will receive a authorization token. ``` -Include this token in the header of your subsequent requests to the Edge Host API to authenticate your requests. For -example, the following request retrieves information about the Edge host such as the processor architecture and the host -name. +Include this token in the header of your subsequent requests to the Local Management API to authenticate your requests. +For example, the following request retrieves information about the Edge host such as the processor architecture and the +host name. ```shell curl --location 'https://10.10.135.182:5080/v1/edge-mgmt/edgehosts/current' \ From 0b78f13359f21ecc39419634b4156b3ef25054a9 Mon Sep 17 00:00:00 2001 From: Lenny Chen Date: Wed, 15 May 2024 15:31:13 -0700 Subject: [PATCH 2/2] docs: incorprate feedback --- docs/api-content/api-docs/1-introduction.md | 11 ++--------- 1 file changed, 2 insertions(+), 9 deletions(-) diff --git a/docs/api-content/api-docs/1-introduction.md b/docs/api-content/api-docs/1-introduction.md index a7c6ff08cc..0a29f20e61 100644 --- a/docs/api-content/api-docs/1-introduction.md +++ b/docs/api-content/api-docs/1-introduction.md @@ -1,5 +1,5 @@ --- -title: "Introduction - APIs" +title: "Introduction" sidebar_label: "Introduction" description: "Palette API Introduction" hide_table_of_contents: false @@ -8,8 +8,7 @@ sidebar_custom_props: icon: "graph" --- -The API documentation section includes documentation for Palette API and Local Management API. Local Management API -endpoints are Tech Preview features and should not be used in production workloads. +The API documentation section includes documentation for Palette API and Local Management API. ## Palette API @@ -155,8 +154,6 @@ The API response for the list includes the listMeta resource that contains the ` you need to check whether the `continue` token value is present in the API response. For subsequent requests, use the `continue` token as a query parameter to paginate the remaining resource items. -
- ```json hideClipboard "listmeta": { "continue": "eyJvZmZzZXQiOjUwLCJjb3VudCI6MTE3LCJ0b2tlbiI6IiJ9", @@ -166,12 +163,8 @@ you need to check whether the `continue` token value is present in the API respo } ``` -
- Example of a subsequent request using the `continue` token. -
- ```shell hideClipboard curl --location 'https://api.spectrocloud.com/v1/packs?continue=eyJvZmZzZXQiOjUwLCJjb3VudCI6MTE3LCJ0b2tlbiI6IiJ9' \ --header 'Accept: application/json' \