From 55526903ebf6802a9cd37ca0f5a82f2175affbd4 Mon Sep 17 00:00:00 2001 From: Thomas Tendyck Date: Mon, 26 Aug 2024 17:29:10 +0200 Subject: [PATCH] docs: add note that sign-quote endpoint isn't enabled by default --- coordinator/server/v2/v2.go | 2 +- docs/docs/reference/coordinator.md | 7 +++++++ docs/versioned_docs/version-1.5/reference/coordinator.md | 7 +++++++ 3 files changed, 15 insertions(+), 1 deletion(-) diff --git a/coordinator/server/v2/v2.go b/coordinator/server/v2/v2.go index 6fb2e72c..d072e724 100644 --- a/coordinator/server/v2/v2.go +++ b/coordinator/server/v2/v2.go @@ -193,7 +193,7 @@ func (s *ClientAPIServer) StatusGet(w http.ResponseWriter, r *http.Request) { func (s *ClientAPIServer) SignQuotePost(w http.ResponseWriter, r *http.Request) { // Check if the current manifest allows signing quotes if !s.api.FeatureEnabled(r.Context(), manifest.FeatureSignQuoteEndpoint) { - handler.WriteJSONError(w, "sign-quote endpoint is not enabled", http.StatusForbidden) + handler.WriteJSONError(w, "SignQuoteEndpoint feature is not enabled in the manifest", http.StatusForbidden) return } diff --git a/docs/docs/reference/coordinator.md b/docs/docs/reference/coordinator.md index 63608722..45a527e3 100644 --- a/docs/docs/reference/coordinator.md +++ b/docs/docs/reference/coordinator.md @@ -709,6 +709,13 @@ Only `key`, or `cert` and `public` may be set for a given secret. ## Verify and sign an SGX quote +:::note + +This endpoint is disabled by default. +You can [enable it in the manifest](../workflows/define-manifest.md#config). + +::: + diff --git a/docs/versioned_docs/version-1.5/reference/coordinator.md b/docs/versioned_docs/version-1.5/reference/coordinator.md index 63608722..45a527e3 100644 --- a/docs/versioned_docs/version-1.5/reference/coordinator.md +++ b/docs/versioned_docs/version-1.5/reference/coordinator.md @@ -709,6 +709,13 @@ Only `key`, or `cert` and `public` may be set for a given secret. ## Verify and sign an SGX quote +:::note + +This endpoint is disabled by default. +You can [enable it in the manifest](../workflows/define-manifest.md#config). + +::: +