Merge pull request #18 from mittwald/feature/system_client_gc

add system client

client.go

@@ -2,9 +2,10 @@ package harbor
 
 import (
 	"fmt"
-	"github.com/parnurzeal/gorequest"
 	"net/url"
 	"strings"
+
+	"github.com/parnurzeal/gorequest"
 )
 
 const (
@@ -130,3 +131,7 @@ func (c *Client) Registries() *RegistryClient {
 func (c *Client) Replications() *ReplicationClient {
 	return &ReplicationClient{c.withURLSuffix("replication")}
 }
+
+func (c *Client) System() *SystemClient {
+	return &SystemClient{c.withURLSuffix("system")}
+}

harbor.go

@@ -2,8 +2,9 @@ package harbor
 
 import (
 	"fmt"
-	"github.com/parnurzeal/gorequest"
 	"strconv"
+
+	"github.com/parnurzeal/gorequest"
 )
 
 type StatusCodeError struct {

project.go

@@ -2,8 +2,9 @@ package harbor
 
 import (
 	"fmt"
-	"github.com/parnurzeal/gorequest"
 	"net/url"
+
+	"github.com/parnurzeal/gorequest"
 )
 
 // ProjectClient handles communication with the project related methods of the Harbor API.

project_types.go

@@ -4,7 +4,7 @@ import "time"
 
 // To ensure type-safe queries to the harbor API,
 // the following typings include typings from the upstream sources:
-// https://github.com/goharbor/harbor/src/common/models/
+// https://github.com/goharbor/harbor/tree/v1.10.2/src/common/models
 
 // AccessLog holds the information of log entries
 type AccessLog struct {

registry.go

@@ -2,6 +2,7 @@ package harbor
 
 import (
 	"fmt"
+
 	"github.com/parnurzeal/gorequest"
 )
 

registry_types.go

@@ -4,7 +4,7 @@ import "time"
 
 // To ensure type-safe queries to the harbor API,
 // the following typings include typings from the upstream sources:
-// https://github.com/goharbor/harbor/src/replication/dao/models/
+// https://github.com/goharbor/harbor/tree/v1.10.2/src/replication/dao/models/
 
 // const definition
 const (

replication_types.go

@@ -4,7 +4,7 @@ import "time"
 
 // To ensure type-safe queries to the harbor API,
 // the following typings include typings from the upstream sources:
-// https://github.com/goharbor/harbor/src/replication/dao/models/
+// https://github.com/goharbor/harbor/tree/v1.10.2/src/replication/dao/models/
 
 // ReplicationExecution holds information about one replication execution.
 type ReplicationExecution struct {

repository.go

@@ -2,8 +2,9 @@ package harbor
 
 import (
 	"fmt"
-	"github.com/parnurzeal/gorequest"
 	"net/url"
+
+	"github.com/parnurzeal/gorequest"
 )
 
 // RepositoryClient handles communication with the repository related methods of the Harbor API

repository_types.go

@@ -6,7 +6,7 @@ import (
 
 // To ensure type-safe queries to the harbor API,
 // the following typings include typings from the upstream sources:
-// https://github.com/goharbor/harbor/src/common/models/
+// https://github.com/goharbor/harbor/tree/v1.10.2/src/common/models
 
 // Label holds information used for a label
 type Label struct {

system.go

@@ -0,0 +1,35 @@
+package harbor
+
+import "github.com/parnurzeal/gorequest"
+
+// SystemClient handles communication with the system related methods of the Harbor API
+type SystemClient struct {
+	*Client
+}
+
+// GetSystemGarbageCollection
+// Get the system's configured garbage collection schedule
+func (s *SystemClient) GetSystemGarbageCollectionSchedule() (AdminJobReq, error) {
+	var gc AdminJobReq
+	resp, _, errs := s.NewRequest(gorequest.GET, "/gc/schedule").
+		EndStruct(&gc)
+	return gc, CheckResponse(errs, resp, 200)
+}
+
+// CreateSystemGarbageCollectionSchedule
+// Create a garbage collection schedule for the system
+func (s *SystemClient) CreateSystemGarbageCollectionSchedule(gc AdminJobReq) error {
+	resp, _, errs := s.NewRequest(gorequest.POST, "/gc/schedule").
+		Send(gc).
+		End()
+	return CheckResponse(errs, resp, 201)
+}
+
+// UpdateSystemGarbageCollectionSchedule
+// Update the system's configured garbage collection schedule
+func (s *SystemClient) UpdateSystemGarbageCollectionSchedule(gc AdminJobReq) error {
+	resp, _, errs := s.NewRequest(gorequest.PUT, "/gc/schedule").
+		Send(gc).
+		End()
+	return CheckResponse(errs, resp, 200)
+}

system_types.go

@@ -0,0 +1,39 @@
+package harbor
+
+// To ensure type-safe queries to the harbor API,
+// the following typings include typings from the upstream sources:
+// https://github.com/goharbor/harbor/tree/v1.10.2/src/core/api/models
+
+type ScheduleType string
+
+const (
+	ScheduleTypeHourly ScheduleType = "Hourly"
+	ScheduleTypeDaily               = "Daily"
+	ScheduleTypeWeekly              = "Weekly"
+	ScheduleTypeCustom              = "Custom"
+	ScheduleTypeManual              = "Manual"
+	ScheduleTypeNone                = "None"
+)
+
+// AdminJobReq holds request information for admin job
+type AdminJobReq struct {
+	AdminJobSchedule
+	Name       string                 `json:"name"`
+	Status     string                 `json:"status"`
+	ID         int64                  `json:"id"`
+	Parameters map[string]interface{} `json:"parameters"`
+}
+
+// AdminJobSchedule holds the information of an admin job schedule
+type AdminJobSchedule struct {
+	Schedule *ScheduleParam `json:"schedule"`
+}
+
+// ScheduleParam defines the parameters of a schedule trigger
+type ScheduleParam struct {
+	// Daily, Hourly, Weekly, Custom, Manual, None
+	// Note: When creating pre-defined schedule types (e.g. 'Hourly'), the Cron string has to be provided.
+	Type ScheduleType `json:"type"`
+	// The cron string of scheduled job
+	Cron string `json:"cron"`
+}

user.go

@@ -2,6 +2,7 @@ package harbor
 
 import (
 	"fmt"
+
 	"github.com/parnurzeal/gorequest"
 )
 

user_types.go

@@ -4,7 +4,7 @@ import "time"
 
 // To ensure type-safe queries to the harbor API,
 // the following typings include typings from the upstream sources:
-// https://github.com/goharbor/harbor/src/common/models/
+// https://github.com/goharbor/harbor/tree/v1.10.2/src/common/models
 
 // User holds the details of a user.
 type User struct {