docs: add note that sign-quote endpoint isn't enabled by default

edgelesssys · Aug 27, 2024 · 5552690 · 5552690
1 parent 1b7e4f4
commit 5552690
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 1 deletion.
diff --git 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
@@ -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).
+
+:::
+
 <Tabs groupId="apiVersion">
 <TabItem value="v2" label="v2">
 

diff --git 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).
+
+:::
+
 <Tabs groupId="apiVersion">
 <TabItem value="v2" label="v2">