From cc3d7db16f9f4cce4dec8078bd2d5e798e82800d Mon Sep 17 00:00:00 2001 From: Pranav Singh Date: Fri, 3 Nov 2023 16:12:53 +0530 Subject: [PATCH 1/5] add missing authorization block Signed-off-by: Pranav Singh --- content/en/cloud/reference/_index.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/content/en/cloud/reference/_index.md b/content/en/cloud/reference/_index.md index 93d7e0bf..da2c3975 100644 --- a/content/en/cloud/reference/_index.md +++ b/content/en/cloud/reference/_index.md @@ -20,9 +20,17 @@ To authenticate with the API, pass the token as a bearer token in the `Authoriza ```bash +curl protocol:/// \ +-H "Authorization: Bearer " ``` +{{< alert title="Note" >}} +Replace `` with the hostname or IP address of your hosted Layer5 Cloud instance. For example, [`https://cloud.layer5.io`](https://cloud.layer5.io). + +Replace `` with the API endpoint you want to access. For example, [`/api/identity/users/profile`](https://cloud.layer5.io/api/identity/users/profile). +{{< /alert >}} + ### API Endpoints See all the API endpoints in the [API Reference](https://meshery.layer5.io/system/api/docs). From 7b672dfb983e74bfbe7e144dcab73077a12c5d0c Mon Sep 17 00:00:00 2001 From: Pranav Singh Date: Fri, 3 Nov 2023 16:13:01 +0530 Subject: [PATCH 2/5] add example Signed-off-by: Pranav Singh --- content/en/cloud/reference/_index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/content/en/cloud/reference/_index.md b/content/en/cloud/reference/_index.md index da2c3975..a2e94e92 100644 --- a/content/en/cloud/reference/_index.md +++ b/content/en/cloud/reference/_index.md @@ -29,6 +29,8 @@ curl protocol:/// \ Replace `` with the hostname or IP address of your hosted Layer5 Cloud instance. For example, [`https://cloud.layer5.io`](https://cloud.layer5.io). Replace `` with the API endpoint you want to access. For example, [`/api/identity/users/profile`](https://cloud.layer5.io/api/identity/users/profile). + +Replace `` with the security token you generated. {{< /alert >}} ### API Endpoints From c1c1e5ee142c753d50c454b6e338ed0d8b843186 Mon Sep 17 00:00:00 2001 From: Pranav Singh Date: Fri, 3 Nov 2023 16:16:25 +0530 Subject: [PATCH 3/5] fix protocol Signed-off-by: Pranav Singh --- content/en/cloud/reference/_index.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/content/en/cloud/reference/_index.md b/content/en/cloud/reference/_index.md index a2e94e92..d9178425 100644 --- a/content/en/cloud/reference/_index.md +++ b/content/en/cloud/reference/_index.md @@ -20,17 +20,21 @@ To authenticate with the API, pass the token as a bearer token in the `Authoriza ```bash -curl protocol:/// \ +curl :/// \ -H "Authorization: Bearer " ``` {{< alert title="Note" >}} + +Replace `` with `http` or `https` based on your Layer5 Cloud instance, if its on-prem or exposed on web. + Replace `` with the hostname or IP address of your hosted Layer5 Cloud instance. For example, [`https://cloud.layer5.io`](https://cloud.layer5.io). Replace `` with the API endpoint you want to access. For example, [`/api/identity/users/profile`](https://cloud.layer5.io/api/identity/users/profile). Replace `` with the security token you generated. + {{< /alert >}} ### API Endpoints From 9a29991f98ae7d67705db65b3277f5eb90086340 Mon Sep 17 00:00:00 2001 From: Pranav Singh Date: Fri, 3 Nov 2023 16:19:53 +0530 Subject: [PATCH 4/5] grammar Signed-off-by: Pranav Singh --- content/en/cloud/reference/_index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/cloud/reference/_index.md b/content/en/cloud/reference/_index.md index d9178425..e0188055 100644 --- a/content/en/cloud/reference/_index.md +++ b/content/en/cloud/reference/_index.md @@ -27,11 +27,11 @@ curl :/// \ {{< alert title="Note" >}} -Replace `` with `http` or `https` based on your Layer5 Cloud instance, if its on-prem or exposed on web. +Replace `` with `http` or `https` depending on your Layer5 Cloud instance - whether it's on-premises or accessible online. Replace `` with the hostname or IP address of your hosted Layer5 Cloud instance. For example, [`https://cloud.layer5.io`](https://cloud.layer5.io). -Replace `` with the API endpoint you want to access. For example, [`/api/identity/users/profile`](https://cloud.layer5.io/api/identity/users/profile). +Replace `` with the API endpoint you want to access. For example, `/api/identity/users/profile`. Replace `` with the security token you generated. From 2944321710e25f1da7fa88eaf1b6cb3b0e645414 Mon Sep 17 00:00:00 2001 From: Pranav Singh Date: Fri, 3 Nov 2023 16:22:18 +0530 Subject: [PATCH 5/5] update Signed-off-by: Pranav Singh --- content/en/cloud/reference/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/cloud/reference/_index.md b/content/en/cloud/reference/_index.md index e0188055..7ea1287e 100644 --- a/content/en/cloud/reference/_index.md +++ b/content/en/cloud/reference/_index.md @@ -27,7 +27,7 @@ curl :/// \ {{< alert title="Note" >}} -Replace `` with `http` or `https` depending on your Layer5 Cloud instance - whether it's on-premises or accessible online. +Replace `` with `http` or `https` depending on your Layer5 Cloud instance. Replace `` with the hostname or IP address of your hosted Layer5 Cloud instance. For example, [`https://cloud.layer5.io`](https://cloud.layer5.io).