Skip to content

Commit

Permalink
docs: fix headings in API page (#2676)
Browse files Browse the repository at this point in the history
  • Loading branch information
karl-cardenas-coding authored Apr 17, 2024
1 parent 7fcfaa6 commit 4c5154a
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 15 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -18,8 +15,6 @@ authentication. The API is available at `https://api.spectrocloud.com`.

Use the following examples to familiarize yourself with the API.

<br />

:::warning

The following samples are for demonstration purposes only and may lack all the required payload values. They are not
Expand All @@ -29,9 +24,7 @@ more about the Postman collection.

:::

<br />

# 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).
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -535,7 +528,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {

</Tabs>

# 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.

Expand Down Expand Up @@ -993,7 +986,7 @@ async fn main() -> Result<(), reqwest::Error> {

</Tabs>

# 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.
Expand Down Expand Up @@ -1249,7 +1242,7 @@ async fn main() -> Result<(), Box<dyn Error>> {

</Tabs>

# Filter Clusters
## Filter Clusters

You can filter host clusters by specifying the tags you want to filter on.

Expand Down Expand Up @@ -1634,7 +1627,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {

</Tabs>

# 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.
Expand Down
2 changes: 1 addition & 1 deletion docs/api-content/api-docs/3-postman-collection.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ https://raw.githubusercontent.com/spectrocloud/librarium/master/docs/api-content

Postman imports your collection and lists it under Import Complete. <br />

![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.

0 comments on commit 4c5154a

Please sign in to comment.