Update as per review

content-services · Dec 12, 2024 · 4294e66 · 4294e66
1 parent 635cbe0
commit 4294e66
Show file tree

Hide file tree

Showing 9 changed files with 78 additions and 78 deletions.
diff --git a/api/docs.go b/api/docs.go
@@ -2308,7 +2308,7 @@ const docTemplate = `{
                         "in": "body",
                         "required": true,
                         "schema": {
-                            "$ref": "#/definitions/api.SearchModuleStreamsRequest"
+                            "$ref": "#/definitions/api.SearchSnapshotModuleStreamsRequest"
                         }
                     },
                     {
@@ -4633,37 +4633,6 @@ const docTemplate = `{
                 }
             }
         },
-        "api.SearchModuleStreamsRequest": {
-            "type": "object",
-            "required": [
-                "rpm_names",
-                "uuids"
-            ],
-            "properties": {
-                "rpm_names": {
-                    "description": "List of rpm names to search",
-                    "type": "array",
-                    "items": {
-                        "type": "string"
-                    }
-                },
-                "search": {
-                    "description": "Search string to search rpm names",
-                    "type": "string"
-                },
-                "sort_by": {
-                    "description": "SortBy sets the sort order of the result",
-                    "type": "string"
-                },
-                "uuids": {
-                    "description": "List of snapshot UUIDs to search",
-                    "type": "array",
-                    "items": {
-                        "type": "string"
-                    }
-                }
-            }
-        },
         "api.SearchPackageGroupResponse": {
             "type": "object",
             "properties": {
@@ -4701,6 +4670,37 @@ const docTemplate = `{
                 }
             }
         },
+        "api.SearchSnapshotModuleStreamsRequest": {
+            "type": "object",
+            "required": [
+                "rpm_names",
+                "uuids"
+            ],
+            "properties": {
+                "rpm_names": {
+                    "description": "List of rpm names to search",
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "search": {
+                    "description": "Search string to search rpm names",
+                    "type": "string"
+                },
+                "sort_by": {
+                    "description": "SortBy sets the sort order of the result",
+                    "type": "string"
+                },
+                "uuids": {
+                    "description": "List of snapshot UUIDs to search",
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            }
+        },
         "api.SnapshotCollectionResponse": {
             "type": "object",
             "properties": {

diff --git a/api/openapi.json b/api/openapi.json
@@ -1063,37 +1063,6 @@
                 },
                 "type": "object"
             },
-            "api.SearchModuleStreamsRequest": {
-                "properties": {
-                    "rpm_names": {
-                        "description": "List of rpm names to search",
-                        "items": {
-                            "type": "string"
-                        },
-                        "type": "array"
-                    },
-                    "search": {
-                        "description": "Search string to search rpm names",
-                        "type": "string"
-                    },
-                    "sort_by": {
-                        "description": "SortBy sets the sort order of the result",
-                        "type": "string"
-                    },
-                    "uuids": {
-                        "description": "List of snapshot UUIDs to search",
-                        "items": {
-                            "type": "string"
-                        },
-                        "type": "array"
-                    }
-                },
-                "required": [
-                    "rpm_names",
-                    "uuids"
-                ],
-                "type": "object"
-            },
             "api.SearchPackageGroupResponse": {
                 "properties": {
                     "description": {
@@ -1131,6 +1100,37 @@
                 },
                 "type": "object"
             },
+            "api.SearchSnapshotModuleStreamsRequest": {
+                "properties": {
+                    "rpm_names": {
+                        "description": "List of rpm names to search",
+                        "items": {
+                            "type": "string"
+                        },
+                        "type": "array"
+                    },
+                    "search": {
+                        "description": "Search string to search rpm names",
+                        "type": "string"
+                    },
+                    "sort_by": {
+                        "description": "SortBy sets the sort order of the result",
+                        "type": "string"
+                    },
+                    "uuids": {
+                        "description": "List of snapshot UUIDs to search",
+                        "items": {
+                            "type": "string"
+                        },
+                        "type": "array"
+                    }
+                },
+                "required": [
+                    "rpm_names",
+                    "uuids"
+                ],
+                "type": "object"
+            },
             "api.SnapshotCollectionResponse": {
                 "properties": {
                     "data": {
@@ -4776,7 +4776,7 @@
                     "content": {
                         "application/json": {
                             "schema": {
-                                "$ref": "#/components/schemas/api.SearchModuleStreamsRequest"
+                                "$ref": "#/components/schemas/api.SearchSnapshotModuleStreamsRequest"
                             }
                         }
                     },

diff --git a/pkg/api/module_streams.go b/pkg/api/module_streams.go
@@ -1,6 +1,6 @@
 package api
 
-type SearchModuleStreamsRequest struct {
+type SearchSnapshotModuleStreamsRequest struct {
 	UUIDs    []string `json:"uuids" validate:"required"`     // List of snapshot UUIDs to search
 	RpmNames []string `json:"rpm_names" validate:"required"` // List of rpm names to search
 	SortBy   string   `json:"sort_by"`                       // SortBy sets the sort order of the result

diff --git a/pkg/dao/interfaces.go b/pkg/dao/interfaces.go
@@ -77,7 +77,7 @@ type RepositoryConfigDao interface {
 }
 
 type ModuleStreamsDao interface {
-	SearchSnapshotModuleStreams(ctx context.Context, orgID string, request api.SearchModuleStreamsRequest) (api.SearchModuleStreamsCollectionResponse, error)
+	SearchSnapshotModuleStreams(ctx context.Context, orgID string, request api.SearchSnapshotModuleStreamsRequest) (api.SearchModuleStreamsCollectionResponse, error)
 }
 
 type RpmDao interface {

diff --git a/pkg/dao/module_streams.go b/pkg/dao/module_streams.go
@@ -22,7 +22,7 @@ func GetModuleStreamsDao(db *gorm.DB) ModuleStreamsDao {
 	}
 }
 
-func (r *moduleStreamsImpl) SearchSnapshotModuleStreams(ctx context.Context, orgID string, request api.SearchModuleStreamsRequest) (api.SearchModuleStreamsCollectionResponse, error) {
+func (r *moduleStreamsImpl) SearchSnapshotModuleStreams(ctx context.Context, orgID string, request api.SearchSnapshotModuleStreamsRequest) (api.SearchModuleStreamsCollectionResponse, error) {
 	if orgID == "" {
 		return api.SearchModuleStreamsCollectionResponse{}, fmt.Errorf("orgID can not be an empty string")
 	}

diff --git a/pkg/dao/module_streams_test.go b/pkg/dao/module_streams_test.go
@@ -81,7 +81,7 @@ func (s *RpmSuite) TestSearchModulesForSnapshots() {
 	//ctx context.Context, hrefs []string, rpmNames []string, search string, pageOpts PageOption
 	dao := GetModuleStreamsDao(s.tx)
 
-	resp, err := dao.SearchSnapshotModuleStreams(ctx, orgId, api.SearchModuleStreamsRequest{
+	resp, err := dao.SearchSnapshotModuleStreams(ctx, orgId, api.SearchSnapshotModuleStreamsRequest{
 		UUIDs:    []string{snaps[0].UUID},
 		RpmNames: []string(nil),
 		Search:   "Foo",
@@ -95,15 +95,15 @@ func (s *RpmSuite) TestSearchModulesForSnapshots() {
 	)
 
 	// ensure error returned for invalid snapshot uuid
-	_, err = dao.SearchSnapshotModuleStreams(ctx, orgId, api.SearchModuleStreamsRequest{
+	_, err = dao.SearchSnapshotModuleStreams(ctx, orgId, api.SearchSnapshotModuleStreamsRequest{
 		UUIDs:  []string{"blerg!"},
 		Search: "Foo",
 	})
 
 	assert.Error(s.T(), err)
 
 	// ensure error returned for no uuids
-	_, err = dao.SearchSnapshotModuleStreams(ctx, orgId, api.SearchModuleStreamsRequest{
+	_, err = dao.SearchSnapshotModuleStreams(ctx, orgId, api.SearchSnapshotModuleStreamsRequest{
 		UUIDs:    []string{},
 		RpmNames: []string{},
 		Search:   "Foo",

diff --git a/pkg/dao/modules_streams_mock.go b/pkg/dao/modules_streams_mock.go
diff --git a/pkg/handler/module_streams.go b/pkg/handler/module_streams.go
@@ -27,10 +27,10 @@ func RegisterModuleStreamsRoutes(engine *echo.Group, rDao *dao.DaoRegistry) {
 // @Summary      List modules and their streams for snapshots
 // @ID           searchSnapshotModuleStreams
 // @Description  List modules and their streams for snapshots
-// @Tags         snapshots
+// @Tags         module_streams
 // @Accept       json
 // @Produce      json
-// @Param        body  body   api.SearchModuleStreamsRequest  true  "request body"
+// @Param        body  body   api.SearchSnapshotModuleStreamsRequest  true  "request body"
 // @Param  	     uuids	path	[]string	true	"Snapshot IDs."
 // @Param  	     package_names	path	[]string	true	"Package Names"
 // @Success      200   {object}  api.SearchModuleStreamsCollectionResponse
@@ -42,7 +42,7 @@ func RegisterModuleStreamsRoutes(engine *echo.Group, rDao *dao.DaoRegistry) {
 func (rh *ModuleStreamsHandler) searchSnapshotModuleStreams(c echo.Context) error {
 	_, orgId := getAccountIdOrgId(c)
 
-	dataInput := api.SearchModuleStreamsRequest{}
+	dataInput := api.SearchSnapshotModuleStreamsRequest{}
 
 	if err := c.Bind(&dataInput); err != nil {
 		return ce.NewErrorResponse(http.StatusBadRequest, "Error binding parameters", err.Error())

diff --git a/pkg/handler/module_streams_test.go b/pkg/handler/module_streams_test.go
@@ -127,7 +127,7 @@ func (suite *ModuleStreamsSuite) TestSearchSnapshotModuleStreams() {
 		switch {
 		case testCase.Expected.Code >= 200 && testCase.Expected.Code < 300:
 			{
-				var bodyRequest api.SearchModuleStreamsRequest
+				var bodyRequest api.SearchSnapshotModuleStreamsRequest
 				err := json.Unmarshal([]byte(testCase.Given.Body), &bodyRequest)
 				require.NoError(t, err)
 				suite.dao.ModuleStreams.On("SearchSnapshotModuleStreams", mock.AnythingOfType("*context.valueCtx"), test_handler.MockOrgId, bodyRequest).