Adds a relation between Resources and Categories

- This patch updates the design of Resources by adding an array of Categories for the following API's - /query - /resources - /resource/<resourceID> - Updates the model of Category and Resource by creating many to many relation - Adds a migration to update the relation between category and resources - Updates the resources tests which adds category array in the response of query, list and resource by id API's Signed-off-by: Puneet Punamiya <ppunamiy@redhat.com>
PuneetPunamiya · Jun 30, 2021 · eaaf8ef · eaaf8ef
1 parent a950c5e
commit eaaf8ef
Show file tree

Hide file tree

Showing 42 changed files with 1,016 additions and 58 deletions.
diff --git a/api/design/resource.go b/api/design/resource.go
@@ -44,6 +44,9 @@ var _ = Service("resource", func() {
 			Attribute("kinds", ArrayOf(String), "Kinds of resource to filter by", func() {
 				Example([]string{"task", "pipelines"})
 			})
+			Attribute("categories", ArrayOf(String), "Category associated with a resource to filter by", func() {
+				Example([]string{"build", "tools"})
+			})
 			Attribute("tags", ArrayOf(String), "Tags associated with a resource to filter by", func() {
 				Example([]string{"image", "build"})
 			})
@@ -64,6 +67,7 @@ var _ = Service("resource", func() {
 
 			Param("name")
 			Param("catalogs")
+			Param("categories")
 			Param("kinds")
 			Param("tags")
 			Param("limit")

diff --git a/api/design/types/type.go b/api/design/types/type.go
@@ -44,6 +44,8 @@ var Category = Type("Category", func() {
 	Required("id", "name")
 })
 
+var Categories = ArrayOf(Category)
+
 var Catalog = ResultType("application/vnd.hub.catalog", "Catalog", func() {
 	Attribute("id", UInt, "ID is the unique id of the catalog", func() {
 		Example("id", 1)
@@ -172,6 +174,13 @@ var ResourceData = ResultType("application/vnd.hub.resource.data", "ResourceData
 			Value(Val{"id": 1, "name": "tekton", "type": "community"})
 		})
 	})
+	Attribute("categories", Categories, "Categories related to resource", func() {
+		Example("categories", func() {
+			Value([]Val{
+				{"id": 1, "name": "image-build"},
+			})
+		})
+	})
 	Attribute("kind", String, "Kind of resource", func() {
 		Example("kind", "task")
 	})
@@ -227,6 +236,7 @@ var ResourceData = ResultType("application/vnd.hub.resource.data", "ResourceData
 		Attribute("catalog", func() {
 			View("min")
 		})
+		Attribute("categories")
 		Attribute("kind")
 		Attribute("latestVersion")
 		Attribute("tags")
@@ -237,6 +247,7 @@ var ResourceData = ResultType("application/vnd.hub.resource.data", "ResourceData
 		Attribute("id")
 		Attribute("name")
 		Attribute("catalog")
+		Attribute("categories")
 		Attribute("kind")
 		Attribute("latestVersion")
 		Attribute("tags")
@@ -246,7 +257,7 @@ var ResourceData = ResultType("application/vnd.hub.resource.data", "ResourceData
 		})
 	})
 
-	Required("id", "name", "catalog", "kind", "latestVersion", "tags", "rating", "versions")
+	Required("id", "name", "catalog", "categories", "kind", "latestVersion", "tags", "rating", "versions")
 })
 
 var Versions = ResultType("application/vnd.hub.versions", "Versions", func() {

diff --git a/api/gen/http/cli/hub/cli.go b/api/gen/http/cli/hub/cli.go
diff --git a/api/gen/http/openapi.json b/api/gen/http/openapi.json
diff --git a/api/gen/http/openapi.yaml b/api/gen/http/openapi.yaml
@@ -213,6 +213,14 @@ paths:
         items:
           type: string
         collectionFormat: multi
+      - name: categories
+        in: query
+        description: Category associated with a resource to filter by
+        required: false
+        type: array
+        items:
+          type: string
+        collectionFormat: multi
       - name: kinds
         in: query
         description: Kinds of resource to filter by
@@ -2357,6 +2365,9 @@ definitions:
           id: 1
           name: tekton
           type: community
+        categories:
+        - id: 1
+          name: image-build
         id: 1
         kind: task
         latestVersion:
@@ -2605,6 +2616,9 @@ definitions:
           id: 1
           name: tekton
           type: community
+        categories:
+        - id: 1
+          name: image-build
         id: 1
         kind: task
         latestVersion:
@@ -2756,6 +2770,14 @@ definitions:
     properties:
       catalog:
         $ref: '#/definitions/CatalogResponseBodyMin'
+      categories:
+        type: array
+        items:
+          $ref: '#/definitions/CategoryResponseBody'
+        description: Categories related to resource
+        example:
+        - id: 1
+          name: image-build
       id:
         type: integer
         description: ID is the unique id of the resource
@@ -2800,6 +2822,9 @@ definitions:
         id: 1
         name: tekton
         type: community
+      categories:
+      - id: 1
+        name: image-build
       id: 1
       kind: task
       latestVersion:
@@ -2826,6 +2851,7 @@ definitions:
     - id
     - name
     - catalog
+    - categories
     - kind
     - latestVersion
     - tags
@@ -2889,6 +2915,14 @@ definitions:
     properties:
       catalog:
         $ref: '#/definitions/CatalogResponseBodyMin'
+      categories:
+        type: array
+        items:
+          $ref: '#/definitions/CategoryResponseBody'
+        description: Categories related to resource
+        example:
+        - id: 1
+          name: image-build
       id:
         type: integer
         description: ID is the unique id of the resource
@@ -2924,6 +2958,9 @@ definitions:
         id: 1
         name: tekton
         type: community
+      categories:
+      - id: 1
+        name: image-build
       id: 1
       kind: task
       latestVersion:
@@ -2945,6 +2982,7 @@ definitions:
     - id
     - name
     - catalog
+    - categories
     - kind
     - latestVersion
     - tags
@@ -2962,6 +3000,9 @@ definitions:
         id: 1
         name: tekton
         type: community
+      categories:
+      - id: 1
+        name: image-build
       id: 1
       kind: task
       latestVersion:
@@ -2988,6 +3029,9 @@ definitions:
         id: 1
         name: tekton
         type: community
+      categories:
+      - id: 1
+        name: image-build
       id: 1
       kind: task
       latestVersion:
@@ -3014,6 +3058,9 @@ definitions:
         id: 1
         name: tekton
         type: community
+      categories:
+      - id: 1
+        name: image-build
       id: 1
       kind: task
       latestVersion:
@@ -3040,6 +3087,9 @@ definitions:
         id: 1
         name: tekton
         type: community
+      categories:
+      - id: 1
+        name: image-build
       id: 1
       kind: task
       latestVersion:
@@ -3120,6 +3170,9 @@ definitions:
           id: 1
           name: tekton
           type: community
+        categories:
+        - id: 1
+          name: image-build
         id: 1
         kind: task
         latestVersion:
@@ -3141,6 +3194,9 @@ definitions:
           id: 1
           name: tekton
           type: community
+        categories:
+        - id: 1
+          name: image-build
         id: 1
         kind: task
         latestVersion:
@@ -3308,6 +3364,9 @@ definitions:
           id: 1
           name: tekton
           type: community
+        categories:
+        - id: 1
+          name: image-build
         id: 1
         kind: task
         latestVersion:
@@ -3329,6 +3388,9 @@ definitions:
           id: 1
           name: tekton
           type: community
+        categories:
+        - id: 1
+          name: image-build
         id: 1
         kind: task
         latestVersion:

diff --git a/api/gen/http/openapi3.json b/api/gen/http/openapi3.json