satellite/console: Add comments to generated api
Clarify that this functionality is not currently implemented within the Satellite UI Change-Id: I94096ab9b4d8f00195b55f5e875d76930de848e4
This commit is contained in:
parent
5a9577bb43
commit
e9628c133d
@ -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.
|
||||
|
||||
|
@ -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{
|
||||
|
Loading…
Reference in New Issue
Block a user