From c6b076ec4e76ac3eedeeadf054e9e4b61efabd93 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Wei=C3=9Fe?= Date: Mon, 10 Jun 2024 16:15:05 +0200 Subject: [PATCH] Review suggestions MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Daniel Weiße --- docs/docs/reference/coordinator.md | 6 +++--- docs/styles/config/vocabularies/edgeless/accept.txt | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/docs/reference/coordinator.md b/docs/docs/reference/coordinator.md index ded4531a..a8e43a4e 100644 --- a/docs/docs/reference/coordinator.md +++ b/docs/docs/reference/coordinator.md @@ -5,12 +5,12 @@ The Coordinator exposes an HTTP-REST interface, referred to as the Client API. Responses of the API follow the [JSend specification](https://github.com/omniti-labs/jsend). This means all endpoints return a JSON object with a `status` field that's either `success`, `fail`, or `error`: -* In case of `success`, the response will contain a `data` field with the actual response data. -* In case of `error`, the response will contain a `message` field with an error message. +* In case of `success`, the response contains a `data` field with the actual response data. +* In case of `error`, the response contains a `message` field with an error message. * In case of `fail`, the response may contain a `message` field with a human readable message, as well as a `data` field with additional information. * `fail` is only used in API version 2, and is returned on invalid requests by the client. -The Client API is used by the MarbleRun CLI and by [the MarbleRun Go SDK](https://pkg.go.dev/github.com/edgelesssys/marblerun/api) to interact with the Coordinator. +The MarbleRun CLI and [the MarbleRun Go SDK](https://pkg.go.dev/github.com/edgelesssys/marblerun/api) use the Client API to interact with the Coordinator. It may also be used directly by applications for programmatic access. ## Retrieve the Coordinator's manifest diff --git a/docs/styles/config/vocabularies/edgeless/accept.txt b/docs/styles/config/vocabularies/edgeless/accept.txt index bc44dfd7..a7afa52b 100644 --- a/docs/styles/config/vocabularies/edgeless/accept.txt +++ b/docs/styles/config/vocabularies/edgeless/accept.txt @@ -19,6 +19,7 @@ helloworld hostname IP Istio +JSend kubectl Linkerd MarbleRun @@ -42,4 +43,3 @@ vSphere walkthrough Xeon XORed -JSend