731fecd96f
- Previously unused struct Endpoint.Request now defines the form
of the request body.
- Path parameters (e.g. "id" in "/delete/{id}") are defined in
the Endpoint.PathParams field.
- Endpoint.Params has been renamed to Endpoint.QueryParams to
eliminate confusion.
Change-Id: Ifef51ca2f362c33086f0e43e936d50b0fdd18aa1
114 lines
2.9 KiB
Go
114 lines
2.9 KiB
Go
// Copyright (C) 2022 Storj Labs, Inc.
|
|
// See LICENSE for copying information.
|
|
|
|
package main
|
|
|
|
//go:generate go run ./
|
|
|
|
import (
|
|
"time"
|
|
|
|
"storj.io/common/uuid"
|
|
"storj.io/storj/private/apigen"
|
|
"storj.io/storj/satellite/accounting"
|
|
"storj.io/storj/satellite/console"
|
|
)
|
|
|
|
func main() {
|
|
// definition for REST API
|
|
a := &apigen.API{
|
|
Version: "v0",
|
|
Description: "",
|
|
PackageName: "consoleapi",
|
|
}
|
|
|
|
{
|
|
g := a.Group("ProjectManagement", "projects")
|
|
|
|
g.Post("/create", &apigen.Endpoint{
|
|
Name: "Create new Project",
|
|
Description: "Creates new Project with given info",
|
|
MethodName: "GenCreateProject",
|
|
Response: &console.Project{},
|
|
Request: console.ProjectInfo{},
|
|
})
|
|
|
|
g.Patch("/update/{id}", &apigen.Endpoint{
|
|
Name: "Update Project",
|
|
Description: "Updates project with given info",
|
|
MethodName: "GenUpdateProject",
|
|
Response: console.Project{},
|
|
Request: console.ProjectInfo{},
|
|
PathParams: []apigen.Param{
|
|
apigen.NewParam("id", uuid.UUID{}),
|
|
},
|
|
})
|
|
|
|
g.Delete("/delete/{id}", &apigen.Endpoint{
|
|
Name: "Delete Project",
|
|
Description: "Deletes project by id",
|
|
MethodName: "GenDeleteProject",
|
|
PathParams: []apigen.Param{
|
|
apigen.NewParam("id", uuid.UUID{}),
|
|
},
|
|
})
|
|
|
|
g.Get("/", &apigen.Endpoint{
|
|
Name: "Get Projects",
|
|
Description: "Gets all projects user has",
|
|
MethodName: "GenGetUsersProjects",
|
|
Response: []console.Project{},
|
|
})
|
|
|
|
g.Get("/bucket-rollup", &apigen.Endpoint{
|
|
Name: "Get Project's Single Bucket Usage",
|
|
Description: "Gets project's single bucket usage by bucket ID",
|
|
MethodName: "GenGetSingleBucketUsageRollup",
|
|
Response: accounting.BucketUsageRollup{},
|
|
QueryParams: []apigen.Param{
|
|
apigen.NewParam("projectID", uuid.UUID{}),
|
|
apigen.NewParam("bucket", ""),
|
|
apigen.NewParam("since", time.Time{}),
|
|
apigen.NewParam("before", time.Time{}),
|
|
},
|
|
})
|
|
|
|
g.Get("/bucket-rollups", &apigen.Endpoint{
|
|
Name: "Get Project's All Buckets Usage",
|
|
Description: "Gets project's all buckets usage",
|
|
MethodName: "GenGetBucketUsageRollups",
|
|
Response: []accounting.BucketUsageRollup{},
|
|
QueryParams: []apigen.Param{
|
|
apigen.NewParam("projectID", uuid.UUID{}),
|
|
apigen.NewParam("since", time.Time{}),
|
|
apigen.NewParam("before", time.Time{}),
|
|
},
|
|
})
|
|
}
|
|
|
|
{
|
|
g := a.Group("APIKeyManagement", "apikeys")
|
|
|
|
g.Post("/create", &apigen.Endpoint{
|
|
Name: "Create new macaroon API key",
|
|
Description: "Creates new macaroon API key with given info",
|
|
MethodName: "GenCreateAPIKey",
|
|
Response: console.CreateAPIKeyResponse{},
|
|
Request: console.CreateAPIKeyRequest{},
|
|
})
|
|
}
|
|
|
|
{
|
|
g := a.Group("UserManagement", "users")
|
|
|
|
g.Get("/", &apigen.Endpoint{
|
|
Name: "Get User",
|
|
Description: "Gets User by request context",
|
|
MethodName: "GenGetUser",
|
|
Response: console.ResponseUser{},
|
|
})
|
|
}
|
|
|
|
a.MustWriteGo("satellite/console/consoleweb/consoleapi/api.gen.go")
|
|
}
|