diff --git a/docs/api-content/api-docs/2-samples.mdx b/docs/api-content/api-docs/2-samples.md similarity index 99% rename from docs/api-content/api-docs/2-samples.mdx rename to docs/api-content/api-docs/2-samples.md index d1b78d4efa..da4a65e672 100644 --- a/docs/api-content/api-docs/2-samples.mdx +++ b/docs/api-content/api-docs/2-samples.md @@ -3,13 +3,10 @@ title: "Example Usage" sidebar_label: "Example Usage" description: "Learn how to use the Spectro Cloud API through examples." icon: "" -hide_table_of_contents: true - +hide_table_of_contents: false hiddenFromNav: false --- -# Overview - This workflow demonstrates how to use Spectro Cloud API. You can use the API to automate the provisioning of Kubernetes clusters and applications on Spectro Cloud. @@ -18,8 +15,6 @@ authentication. The API is available at `https://api.spectrocloud.com`. Use the following examples to familiarize yourself with the API. -
- :::warning The following samples are for demonstration purposes only and may lack all the required payload values. They are not @@ -29,9 +24,7 @@ more about the Postman collection. ::: -
- -# Prerequisites +## Prerequisites - You must have a Spectro Cloud account. If you do not have an account, you can create one at [https://console.spectrocloud.com](https://console.spectrocloud.com). @@ -69,7 +62,7 @@ If you do not provide the projectUid header, then the assumed scope is of the te ::: -# Deploy a Cluster +## Deploy a Cluster You can use the following endpoint to deploy a cluster. The provider value represents the cloud provider on which you want to deploy the cluster, such as public cloud or on-prem. @@ -535,7 +528,7 @@ async fn main() -> Result<(), Box> { -# Cluster Nodes and Node Status +## Cluster Nodes and Node Status You can use the following endpoint to retrieve the list of nodes in a cluster and their status. @@ -993,7 +986,7 @@ async fn main() -> Result<(), reqwest::Error> { -# Cluster Workloads +## Cluster Workloads You can retrieve information about the active workloads on a cluster, such as the number of pods, nodes, and containers. Use the namespace filter to retrieve information about workloads in specific namespaces. @@ -1249,7 +1242,7 @@ async fn main() -> Result<(), Box> { -# Filter Clusters +## Filter Clusters You can filter host clusters by specifying the tags you want to filter on. @@ -1634,7 +1627,7 @@ async fn main() -> Result<(), Box> { -# Download Cluster Kubeconfig +## Download Cluster Kubeconfig You can download the kubeconfig file of a host cluster. To download the kubeconfig file, you need to provide the cluster UID. diff --git a/docs/api-content/api-docs/3-postman-collection.md b/docs/api-content/api-docs/3-postman-collection.md index d38ddb6da6..50ee21979a 100644 --- a/docs/api-content/api-docs/3-postman-collection.md +++ b/docs/api-content/api-docs/3-postman-collection.md @@ -47,7 +47,7 @@ https://raw.githubusercontent.com/spectrocloud/librarium/master/docs/api-content Postman imports your collection and lists it under Import Complete.
-![Copy/paste the URL in the **Import** dialog as a link.](URL-as-a-link.webp) +![Copy/paste the URL in the **Import** dialog as a link.](/URL-as-a-link.webp) Find details about importing in Postman's [import/export](https://learning.postman.com/docs/getting-started/importing-and-exporting-data/) tutorial. diff --git a/docs/api-content/api-docs/URL-as-a-link.webp b/static/assets/docs/images/URL-as-a-link.webp similarity index 100% rename from docs/api-content/api-docs/URL-as-a-link.webp rename to static/assets/docs/images/URL-as-a-link.webp