From e9628c133dfa712aa977d0c361c06828f590cfb6 Mon Sep 17 00:00:00 2001 From: Moby von Briesen Date: Fri, 3 Mar 2023 09:29:11 -0500 Subject: [PATCH] satellite/console: Add comments to generated api Clarify that this functionality is not currently implemented within the Satellite UI Change-Id: I94096ab9b4d8f00195b55f5e875d76930de848e4 --- satellite/console/consoleweb/consoleapi/gen/README.md | 4 +++- satellite/console/consoleweb/consoleapi/gen/main.go | 2 ++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/satellite/console/consoleweb/consoleapi/gen/README.md b/satellite/console/consoleweb/consoleapi/gen/README.md index 5d0ae801b..95bcf13d0 100644 --- a/satellite/console/consoleweb/consoleapi/gen/README.md +++ b/satellite/console/consoleweb/consoleapi/gen/README.md @@ -1,4 +1,6 @@ -# Generated REST API design +# Generated REST API documentation + +These endpoints are not currently used from within the Satellite UI. Requires setting 'Authorization' header for requests. diff --git a/satellite/console/consoleweb/consoleapi/gen/main.go b/satellite/console/consoleweb/consoleapi/gen/main.go index 72500bb45..b4307e400 100644 --- a/satellite/console/consoleweb/consoleapi/gen/main.go +++ b/satellite/console/consoleweb/consoleapi/gen/main.go @@ -16,6 +16,8 @@ import ( "storj.io/storj/satellite/console" ) +// main defines the structure of the API and generates its associated frontend and backend code. +// These API endpoints are not currently used from inside the Satellite UI. func main() { // definition for REST API a := &apigen.API{