change: make filter in resultSelector optional (#47)

There is certainly the case where we want to e.g. use paging without filtering the data. Then it is quite cumbersome that we have to define a dummy filter which does not filter anything, instead of just omitting the filter property.

Like Paging there is a reasonable default: no filter provided -> no filtering.

Author: mgoetzegb

pkg/dbcrypt/README.md

@@ -73,13 +73,33 @@ import "github.com/greenbone/opensight-golang-libraries/pkg/dbcrypt"
 
 ## Index
 
+- [func Decrypt\(encrypted string, key \[\]byte\) \(string, error\)](<#Decrypt>)
+- [func Encrypt\(plaintext string, key \[\]byte\) \(string, error\)](<#Encrypt>)
 - [type DBCrypt](<#DBCrypt>)
   - [func \(d \*DBCrypt\[T\]\) DecryptStruct\(data \*T\) error](<#DBCrypt[T].DecryptStruct>)
   - [func \(d \*DBCrypt\[T\]\) EncryptStruct\(data \*T\) error](<#DBCrypt[T].EncryptStruct>)
 
 
+<a name="Decrypt"></a>
+## func [Decrypt](<https://github.com/greenbone/opensight-golang-libraries/blob/main/pkg/dbcrypt/dbcrypt.go#L105>)
+
+```go
+func Decrypt(encrypted string, key []byte) (string, error)
+```
+
+
+
+<a name="Encrypt"></a>
+## func [Encrypt](<https://github.com/greenbone/opensight-golang-libraries/blob/main/pkg/dbcrypt/dbcrypt.go#L83>)
+
+```go
+func Encrypt(plaintext string, key []byte) (string, error)
+```
+
+
+
 <a name="DBCrypt"></a>
-## type [DBCrypt](<https://github.com/greenbone/opensight-golang-libraries/blob/main/pkg/dbcrypt/dbcrypt.go#L19-L21>)
+## type [DBCrypt](<https://github.com/greenbone/opensight-golang-libraries/blob/main/pkg/dbcrypt/dbcrypt.go#L24-L26>)
 
 
 
@@ -90,7 +110,7 @@ type DBCrypt[T any] struct {
 ```
 
 <a name="DBCrypt[T].DecryptStruct"></a>
-### func \(\*DBCrypt\[T\]\) [DecryptStruct](<https://github.com/greenbone/opensight-golang-libraries/blob/main/pkg/dbcrypt/dbcrypt.go#L55>)
+### func \(\*DBCrypt\[T\]\) [DecryptStruct](<https://github.com/greenbone/opensight-golang-libraries/blob/main/pkg/dbcrypt/dbcrypt.go#L65>)
 
 ```go
 func (d *DBCrypt[T]) DecryptStruct(data *T) error
@@ -99,7 +119,7 @@ func (d *DBCrypt[T]) DecryptStruct(data *T) error
 DecryptStruct decrypts all fields of a struct that are tagged with \`encrypt:"true"\`
 
 <a name="DBCrypt[T].EncryptStruct"></a>
-### func \(\*DBCrypt\[T\]\) [EncryptStruct](<https://github.com/greenbone/opensight-golang-libraries/blob/main/pkg/dbcrypt/dbcrypt.go#L30>)
+### func \(\*DBCrypt\[T\]\) [EncryptStruct](<https://github.com/greenbone/opensight-golang-libraries/blob/main/pkg/dbcrypt/dbcrypt.go#L41>)
 
 ```go
 func (d *DBCrypt[T]) EncryptStruct(data *T) error

pkg/openSearch/openSearchClient/README.md

@@ -134,7 +134,7 @@ func NewOpenSearchErrorWithStack(message string) error
 func NewOpenSearchProjectClient(ctx context.Context, config config.OpensearchClientConfig) (*opensearch.Client, error)
 ```
 
-NewOpenSearchProjectClient creates a new official OpenSearch client \(package github.com/opensearch\-project/opensearch\-go\) for usage in NewClient. It returns an error if the client couldn't be created or the connection couldn't be established.
+NewOpenSearchProjectClient creates a new official OpenSearch client \(package github.com/opensearch\-project/opensearch\-go\) for usage NewClient. It returns an error if the client couldn't be created or the connection couldn't be established.
 
 ctx is the context to use for the connection. config is the configuration for the client.
 

pkg/query/README.md

@@ -55,7 +55,7 @@ Metadata represents the metadata used in a query.
 
 ```go
 type Metadata struct {
-    Filter  *filter.Request  `json:"filter" binding:"required"`
+    Filter  *filter.Request  `json:"filter,omitempty"`
     Paging  *paging.Response `json:"paging,omitempty"`
     Sorting *sorting.Request `json:"sorting,omitempty"`
 }
@@ -101,7 +101,7 @@ ResultSelector is a type that represents the selection criteria for querying dat
 
 ```go
 type ResultSelector struct {
-    Filter  *filter.Request  `json:"filter" binding:"required"`
+    Filter  *filter.Request  `json:"filter" binding:"omitempty"`
     Sorting *sorting.Request `json:"sorting" binding:"omitempty"`
     Paging  *paging.Request  `json:"paging" binding:"omitempty"`
 }

pkg/query/filter/validation.go

@@ -15,6 +15,10 @@ import (
 
 // ValidateFilter validates the filter in the request
 func ValidateFilter(request *Request, requestOptions []RequestOption) error {
+	if request == nil {
+		return nil
+	}
+
 	for i, field := range request.Fields {
 		fieldNameIsValid := false
 		if field.Name == "tag" {

pkg/query/filter/validation_test.go

@@ -54,6 +54,13 @@ func TestRequestOptionValidation(t *testing.T) {
 		}
 	}
 
+	t.Run("shouldAllowUnsetFilter", func(t *testing.T) {
+		setup(t)
+
+		err := ValidateFilter(nil, requestOptions)
+		require.NoError(t, err)
+	})
+
 	t.Run("shouldAllowEmptyFilter", func(t *testing.T) {
 		setup(t)
 

pkg/query/responseWithMetadata.go

@@ -25,15 +25,17 @@ type ResponseWithMetadata[T any] struct {
 
 // Metadata represents the metadata used in a query.
 type Metadata struct {
-	Filter  *filter.Request  `json:"filter" binding:"required"`
+	Filter  *filter.Request  `json:"filter,omitempty"`
 	Paging  *paging.Response `json:"paging,omitempty"`
 	Sorting *sorting.Request `json:"sorting,omitempty"`
 }
 
 func NewMetadata(resultSelector ResultSelector, totalRowCount uint64) Metadata {
-	for i, field := range resultSelector.Filter.Fields {
-		if field.Keys == nil {
-			resultSelector.Filter.Fields[i].Keys = []string{}
+	if resultSelector.Filter != nil {
+		for i, field := range resultSelector.Filter.Fields {
+			if field.Keys == nil {
+				resultSelector.Filter.Fields[i].Keys = []string{}
+			}
 		}
 	}
 	return Metadata{

pkg/query/resultSelector.go

@@ -15,7 +15,7 @@ import (
 // Sorting is a pointer to a sorting.Request struct that specifies the sorting order for the query.
 // Paging is a pointer to a paging.Request struct that specifies the paging configuration for the query.
 type ResultSelector struct {
-	Filter  *filter.Request  `json:"filter" binding:"required"`
+	Filter  *filter.Request  `json:"filter" binding:"omitempty"`
 	Sorting *sorting.Request `json:"sorting" binding:"omitempty"`
 	Paging  *paging.Request  `json:"paging" binding:"omitempty"`
 }