Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: rename local mgmt api #2845

Merged
merged 4 commits into from
May 15, 2024
Merged

docs: rename local mgmt api #2845

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
162dac0
docs: rename local mgmt api
lennessyy May 14, 2024
c1f22c2
Merge branch 'master' into edge-mgmt-api
lennessyy May 14, 2024
0b78f13
docs: incorprate feedback
lennessyy May 15, 2024
f033bc1
Merge branch 'master' into edge-mgmt-api
lennessyy May 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 13 additions & 10 deletions docs/api-content/api-docs/1-introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Introduction"
title: "Introduction - APIs"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to add - APIs? This will create a difference between the current version and backports that I'm not sure is needed? But I can be convinced 😅

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I only added it because i was thinking of Kristin's SEO advice, but you are right that this is not the right place to do it as it can introduce inconsistency.

sidebar_label: "Introduction"
description: "Palette API Introduction"
hide_table_of_contents: false
Expand All @@ -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
lennessyy marked this conversation as resolved.
Show resolved Hide resolved
endpoints are Tech Preview features and should not be used in production workloads.

## Palette API

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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' \
Expand Down