API: do not return null when methods returning a list have no items (#170)

* API: do not return null when methods returning a list have no items

* Use "omitempty" in all API structs
This commit is contained in:
Nikolay Edigaryev
2024-04-29 15:49:09 -04:00
committed by GitHub
parent e6caf480de
commit c845f3b2fd
11 changed files with 65 additions and 49 deletions
@@ -7,7 +7,7 @@ import (
var ClusterSettingsKey = []byte("/cluster-settings")
func (txn *Transaction) GetClusterSettings() (result *v1.ClusterSettings, err error) {
func (txn *Transaction) GetClusterSettings() (_ *v1.ClusterSettings, err error) {
defer func() {
err = mapErr(err)
}()
@@ -45,11 +45,15 @@ func (txn *Transaction) AppendEvents(events []v1.Event, scope ...string) (err er
return nil
}
func (txn *Transaction) ListEvents(scope ...string) (result []v1.Event, err error) {
func (txn *Transaction) ListEvents(scope ...string) (_ []v1.Event, err error) {
defer func() {
err = mapErr(err)
}()
// Declare an empty, non-nil slice to
// return [] when no events are found
result := []v1.Event{}
it := txn.badgerTxn.NewIterator(badger.IteratorOptions{
Prefix: scopePrefix(scope),
})
@@ -13,7 +13,7 @@ func ServiceAccountKey(name string) []byte {
return []byte(path.Join(SpaceServiceAccounts, name))
}
func (txn *Transaction) GetServiceAccount(name string) (result *v1.ServiceAccount, err error) {
func (txn *Transaction) GetServiceAccount(name string) (_ *v1.ServiceAccount, err error) {
defer func() {
err = mapErr(err)
}()
@@ -65,11 +65,15 @@ func (txn *Transaction) DeleteServiceAccount(name string) (err error) {
return txn.badgerTxn.Delete(key)
}
func (txn *Transaction) ListServiceAccounts() (result []*v1.ServiceAccount, err error) {
func (txn *Transaction) ListServiceAccounts() (_ []*v1.ServiceAccount, err error) {
defer func() {
err = mapErr(err)
}()
// Declare an empty, non-nil slice to return
// [] when no service accounts are found
result := []*v1.ServiceAccount{}
it := txn.badgerTxn.NewIterator(badger.IteratorOptions{
Prefix: []byte(SpaceServiceAccounts),
})
@@ -14,7 +14,7 @@ func VMKey(name string) []byte {
return []byte(path.Join(SpaceVMs, name))
}
func (txn *Transaction) GetVM(name string) (result *v1.VM, err error) {
func (txn *Transaction) GetVM(name string) (_ *v1.VM, err error) {
defer func() {
err = mapErr(err)
}()
@@ -66,11 +66,15 @@ func (txn *Transaction) DeleteVM(name string) (err error) {
return txn.badgerTxn.Delete(key)
}
func (txn *Transaction) ListVMs() (result []v1.VM, err error) {
func (txn *Transaction) ListVMs() (_ []v1.VM, err error) {
defer func() {
err = mapErr(err)
}()
// Declare an empty, non-nil slice to
// return [] when no VMs are found
result := []v1.VM{}
it := txn.badgerTxn.NewIterator(badger.IteratorOptions{
Prefix: []byte(SpaceVMs),
})
@@ -14,7 +14,7 @@ func WorkerKey(name string) []byte {
return []byte(path.Join(SpaceWorkers, name))
}
func (txn *Transaction) GetWorker(name string) (result *v1.Worker, err error) {
func (txn *Transaction) GetWorker(name string) (_ *v1.Worker, err error) {
defer func() {
err = mapErr(err)
}()
@@ -66,11 +66,15 @@ func (txn *Transaction) DeleteWorker(name string) (err error) {
return txn.badgerTxn.Delete(key)
}
func (txn *Transaction) ListWorkers() (result []v1.Worker, err error) {
func (txn *Transaction) ListWorkers() (_ []v1.Worker, err error) {
defer func() {
err = mapErr(err)
}()
// Declare an empty, non-nil slice to
// return [] when no workers are found
result := []v1.Worker{}
it := txn.badgerTxn.NewIterator(badger.IteratorOptions{
Prefix: []byte(SpaceWorkers),
})