feat: add filter options and fix openapi spec conflicts

syntaxsdev · syntaxsdev · commit fbbc35a11b63 · 2025-10-14T11:04:18.000-04:00
Signed-off-by: Sidney Glinton &lt;sglinton@redhat.com&gt;
diff --git a/api/openapi/catalog.yaml b/api/openapi/catalog.yaml
@@ -32,6 +32,15 @@ paths:
           explode: true
           in: query
           required: false
+        - name: sourceLabel
+          description: |-
+            Filter models by the label associated with the source. This
+            parameter may be included multiple times to include models from
+            multiple sources.
+          schema:
+            type: string
+          in: query
+          required: false
         - name: q
           description: Free-form keyword search used to filter the response.
           schema:
@@ -55,6 +64,22 @@ paths:
         "500":
           $ref: "#/components/responses/InternalServerError"
       operationId: findModels
+  /api/model_catalog/v1alpha1/models/filter_options:
+    description: Lists options for `filterQuery` when listing models.
+    get:
+      summary: Lists fields and available options that can be used in `filterQuery` on the list models endpoint.
+      tags:
+        - ModelCatalogService
+      responses:
+        "200":
+          $ref: "#/components/responses/FilterOptionsResponse"
+        "400":
+          $ref: "#/components/responses/BadRequest"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "500":
+          $ref: "#/components/responses/InternalServerError"
+      operationId: findModelsFilterOptions
   /api/model_catalog/v1alpha1/sources:
     summary: Path used to get the list of catalog sources.
     description: >-
@@ -142,16 +167,11 @@ paths:
           type: string
         in: path
         required: true
-      - name: artifact_type
-        description: Filter artifacts by type.
-        schema:
-          type: string
-        in: query
-        required: false
       - $ref: "#/components/parameters/pageSize"
       - $ref: "#/components/parameters/orderBy"
       - $ref: "#/components/parameters/sortOrder"
       - $ref: "#/components/parameters/nextPageToken"
+      - $ref: "#/components/parameters/catalogArtifactType"
 components:
   schemas:
     ArtifactTypeQueryParam:
@@ -422,6 +442,38 @@ components:
         message:
           description: Error message
           type: string
+    FilterOption:
+      type: object
+      required:
+        - type
+      properties:
+        type:
+          type: string
+          description: The data type of the filter option
+          enum:
+            - string
+            - number
+        values:
+          type: array
+          description: Known values of the property for string types with a small number of possible options.
+          items: {}
+        range:
+          type: object
+          description: Min and max values for number types.
+          properties:
+            min:
+              type: number
+            max:
+              type: number
+    FilterOptionsList:
+      description: List of FilterOptions
+      type: object
+      properties:
+        filters:
+          type: object
+          description: A single filter option.
+          additionalProperties:
+            $ref: "#/components/schemas/FilterOption"
     MetadataBoolValue:
       description: A bool property value.
       type: object
@@ -586,6 +638,12 @@ components:
           schema:
             $ref: "#/components/schemas/Error"
       description: Conflict with current state of target resource
+    FilterOptionsResponse:
+      content:
+        application/json:
+          schema:
+            $ref: "#/components/schemas/FilterOptionsList"
+      description: A response containing options for a `filterQuery` parameter.
     InternalServerError:
       content:
         application/json:
@@ -629,6 +687,18 @@ components:
         $ref: "#/components/schemas/OrderByField"
       in: query
       required: false
+    catalogArtifactType:
+      name: artifactType
+      description: |-
+        Specifies the artifact types to return. May be specified multiple
+        times to retrieve multiple artifact types.
+      schema:
+        type: string
+        enum:
+          - model-artifact
+          - metrics-artifact
+      in: query
+      required: false
     id:
       name: id
       description: The ID of resource.
diff --git a/api/openapi/src/catalog.yaml b/api/openapi/src/catalog.yaml
@@ -32,6 +32,15 @@ paths:
           explode: true
           in: query
           required: false
+        - name: sourceLabel
+          description: |-
+            Filter models by the label associated with the source. This
+            parameter may be included multiple times to include models from
+            multiple sources.
+          schema:
+            type: string
+          in: query
+          required: false
         - name: q
           description: Free-form keyword search used to filter the response.
           schema:
@@ -55,6 +64,22 @@ paths:
         "500":
           $ref: "#/components/responses/InternalServerError"
       operationId: findModels
+  /api/model_catalog/v1alpha1/models/filter_options:
+    description: Lists options for `filterQuery` when listing models.
+    get:
+      summary: Lists fields and available options that can be used in `filterQuery` on the list models endpoint.
+      tags:
+        - ModelCatalogService
+      responses:
+        "200":
+          $ref: "#/components/responses/FilterOptionsResponse"
+        "400":
+          $ref: "#/components/responses/BadRequest"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "500":
+          $ref: "#/components/responses/InternalServerError"
+      operationId: findModelsFilterOptions
   /api/model_catalog/v1alpha1/sources:
     summary: Path used to get the list of catalog sources.
     description: >-
@@ -142,16 +167,11 @@ paths:
           type: string
         in: path
         required: true
-      - name: artifact_type
-        description: Filter artifacts by type.
-        schema:
-          type: string
-        in: query
-        required: false
       - $ref: "#/components/parameters/pageSize"
       - $ref: "#/components/parameters/orderBy"
       - $ref: "#/components/parameters/sortOrder"
       - $ref: "#/components/parameters/nextPageToken"
+      - $ref: "#/components/parameters/catalogArtifactType"
 components:
   schemas:
     CatalogArtifact:
@@ -283,6 +303,38 @@ components:
               items:
                 $ref: "#/components/schemas/CatalogSource"
         - $ref: "#/components/schemas/BaseResourceList"
+    FilterOption:
+      type: object
+      required:
+        - type
+      properties:
+        type:
+          type: string
+          description: The data type of the filter option
+          enum:
+            - string
+            - number
+        values:
+          type: array
+          description: Known values of the property for string types with a small number of possible options.
+          items: {}
+        range:
+          type: object
+          description: Min and max values for number types.
+          properties:
+            min:
+              type: number
+            max:
+              type: number
+    FilterOptionsList:
+      description: List of FilterOptions
+      type: object
+      properties:
+        filters:
+          type: object
+          description: A single filter option.
+          additionalProperties:
+            $ref: "#/components/schemas/FilterOption"
     OrderByField:
       description: Supported fields for ordering result entities.
       enum:
@@ -323,6 +375,12 @@ components:
           schema:
             $ref: "#/components/schemas/CatalogSource"
       description: A response containing a `CatalogSource` entity.
+    FilterOptionsResponse:
+      content:
+        application/json:
+          schema:
+            $ref: "#/components/schemas/FilterOptionsList"
+      description: A response containing options for a `filterQuery` parameter.
 
   parameters:
     orderBy:
@@ -337,4 +395,16 @@ components:
         $ref: "#/components/schemas/OrderByField"
       in: query
       required: false
+    catalogArtifactType:
+      name: artifactType
+      description: |-
+        Specifies the artifact types to return. May be specified multiple
+        times to retrieve multiple artifact types.
+      schema:
+        type: string
+        enum:
+          - model-artifact
+          - metrics-artifact
+      in: query
+      required: false
 tags: []
diff --git a/catalog/internal/server/openapi/api_model_catalog_service_service_test.go b/catalog/internal/server/openapi/api_model_catalog_service_service_test.go
@@ -979,7 +979,6 @@ func TestGetAllModelArtifacts(t *testing.T) {
 				context.Background(),
 				tc.sourceID,
 				tc.modelName,
-				"",
 				"10",
 				model.ORDERBYFIELD_CREATE_TIME,
 				model.SORTORDER_ASC,
diff --git a/catalog/pkg/openapi/api_model_catalog_service.go b/catalog/pkg/openapi/api_model_catalog_service.go
