Add Openapi spec and STUB endpoint for source_preview (#1884)

Signed-off-by: ppadti <ppadti@redhat.com>

Author: ppadti

clients/ui/api/openapi/mod-arch.yaml

@@ -963,6 +963,66 @@ paths:
       summary: Delete a Model Catalog source
       description: Deletes an existing Model Catalog Source.
 
+  /api/v1/settings/model_catalog/source_preview:
+    description: >-
+      The REST endpoint/path used to preview the effects of catalog source configuration changes.
+    post:
+      summary: Preview catalog source configuration effects
+      description: >-
+        Accepts catalog source definitions and returns a preview of which models would be
+        included or excluded based on the configuration. Supports multipart form uploads
+        for YAML catalogs files.
+      tags:
+        - ModelCatalogService
+      parameters:
+        - name: statusFilter
+          description: |-
+            Filter the response to show specific model statuses.
+            - `all` shows all models (default)
+            - `included` shows only models that would be included
+            - `excluded` shows only models that would be excluded
+          schema:
+            type: string
+            enum:
+              - all
+              - included
+              - excluded
+            default: all
+          in: query
+          required: false
+        - $ref: "#/components/parameters/pageSize"
+        - $ref: "#/components/parameters/nextPageToken"
+      requestBody:
+        description: Catalog source configuration
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CatalogSourcePreviewRequest"
+          multipart/form-data:
+            schema:
+              type: object
+              properties:
+                file:
+                  type: string
+                  format: yaml
+                description:
+                  type: string
+                  description:
+                    Should include a file named `source.json`, and may optionally
+                    include a YAML catalog. The name referenced in the source
+                    definition should match uploaded file name.
+      responses:
+        "200":
+          $ref: "#/components/responses/CatalogSourcePreviewResponse"
+        "400":
+          $ref: "#/components/responses/BadRequest"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "500":
+          $ref: "#/components/responses/InternalServerError"
+      operationId: previewCatalogSource
+
 components:
   schemas:
     Config:
@@ -2085,6 +2145,76 @@ components:
           description: A single filter option.
           additionalProperties:
             $ref: "#/components/schemas/FilterOption"
+    CatalogSourcePreviewRequest:
+      description: Request to preview catalog source configuration effects.
+      type: object
+      required:
+        - type
+      properties:
+        type:
+          type: string
+          description: The type of catalog source (e.g., 'huggingface', 'yaml')
+          example: yaml
+        includedModels:
+          type: array
+          items:
+            type: string
+        excludedModels:
+          type: array
+          items:
+            type: string
+        properties:
+          type: object
+          description: Type-specific configuration properties
+          additionalProperties: true
+    CatalogSourcePreviewModel:
+      description: A model in the preview response with inclusion status.
+      type: object
+      required:
+        - name
+        - included
+      properties:
+        name:
+          type: string
+          description: Name of the model
+          example: microsoft/DialoGPT-medium
+        included:
+          type: boolean
+          description: Whether this model would be included based on the source configuration
+    CatalogSourcePreviewResult:
+      description: Preview result for catalog source configuration.
+      allOf:
+        - type: object
+          properties:
+            items:
+              description: Array of models with their inclusion status.
+              type: array
+              items:
+                $ref: "#/components/schemas/CatalogSourcePreviewModel"
+            summary:
+              description: Summary of the preview results
+              type: object
+              properties:
+                totalModels:
+                  type: integer
+                  description: Total number of models evaluated
+                  example: 1500
+                includedModels:
+                  type: integer
+                  description: Number of models that would be included
+                  example: 850
+                excludedModels:
+                  type: integer
+                  description: Number of models that would be excluded
+                  example: 650
+              required:
+                - totalModels
+                - includedModels
+                - excludedModels
+          required:
+            - items
+            - summary
+        - $ref: "#/components/schemas/BaseResourceList"
 
     # Schema for catalog settings
     CatalogSourceConfig:
@@ -2501,6 +2631,12 @@ components:
           schema:
             $ref: "#/components/schemas/FilterOptionsList"
       description: A response containing options for a `filterQuery` parameter.
+    CatalogSourcePreviewResponse:
+      content:
+        application/json:
+          schema:
+            $ref: "#/components/schemas/CatalogSourcePreviewResult"
+      description: A response containing the preview results of catalog source configuration effects.
 
     # Catalog settings response
     CatalogSourceConfigListResponse:

clients/ui/bff/internal/api/app.go

@@ -72,6 +72,7 @@ const (
 	ModelCatalogSettingsPathPrefix           = SettingsPath + "/model_catalog"
 	ModelCatalogSettingsSourceConfigListPath = ModelCatalogSettingsPathPrefix + "/source_configs"
 	ModelCatalogSettingsSourceConfigPath     = ModelCatalogSettingsSourceConfigListPath + "/:" + CatalogSourceId
+	CatalogSourcePreviewPath                 = ModelCatalogSettingsPathPrefix + "/source_preview"
 )
 
 type App struct {
@@ -286,6 +287,8 @@ func (app *App) Routes() http.Handler {
 		apiRouter.GET(ModelCatalogSettingsSourceConfigPath, app.AttachNamespace(app.GetCatalogSourceConfigHandler))
 		apiRouter.PATCH(ModelCatalogSettingsSourceConfigPath, app.AttachNamespace(app.UpdateCatalogSourceConfigHandler))
 		apiRouter.DELETE(ModelCatalogSettingsSourceConfigPath, app.AttachNamespace(app.DeleteCatalogSourceConfigHandler))
+
+		apiRouter.POST(CatalogSourcePreviewPath, app.AttachNamespace(app.AttachModelCatalogRESTClient(app.CreateCatalogSourcePreviewHandler)))
 	}
 
 	// App Router

clients/ui/bff/internal/api/catalog_source_preview_handler.go

@@ -0,0 +1,44 @@
+package api
+
+import (
+	"encoding/json"
+	"errors"
+	"fmt"
+	"net/http"
+
+	"github.com/julienschmidt/httprouter"
+	"github.com/kubeflow/model-registry/ui/bff/internal/constants"
+	"github.com/kubeflow/model-registry/ui/bff/internal/integrations/httpclient"
+	"github.com/kubeflow/model-registry/ui/bff/internal/models"
+)
+
+type CatalogSourcePreviewEnvelope Envelope[*models.CatalogSourcePreviewResult, None]
+
+func (app *App) CreateCatalogSourcePreviewHandler(w http.ResponseWriter, r *http.Request, _ httprouter.Params) {
+	client, ok := r.Context().Value(constants.ModelCatalogHttpClientKey).(httpclient.HTTPClientInterface)
+	if !ok {
+		app.serverErrorResponse(w, r, errors.New("catalog REST client not found"))
+		return
+	}
+
+	var sourcePreviewPayload models.CatalogSourcePreviewRequest
+	if err := json.NewDecoder(r.Body).Decode(&sourcePreviewPayload); err != nil {
+		app.serverErrorResponse(w, r, fmt.Errorf("error decoding JSON:: %v", err.Error()))
+		return
+	}
+
+	sourcePreview, err := app.repositories.ModelCatalogClient.CreateCatalogSourcePreview(client, sourcePreviewPayload)
+
+	if err != nil {
+		app.serverErrorResponse(w, r, err)
+	}
+
+	catalogSourcePreview := CatalogSourcePreviewEnvelope{
+		Data: sourcePreview,
+	}
+
+	err = app.WriteJSON(w, http.StatusOK, catalogSourcePreview, nil)
+	if err != nil {
+		app.serverErrorResponse(w, r, err)
+	}
+}

clients/ui/bff/internal/mocks/model_catalog_client_mock.go

@@ -207,3 +207,9 @@ func (m *ModelCatalogClientMock) GetCatalogFilterOptions(client httpclient.HTTPC
 
 	return &filterOptions, nil
 }
+
+func (m *ModelCatalogClientMock) CreateCatalogSourcePreview(client httpclient.HTTPClientInterface, sourcePreviewPaylod models.CatalogSourcePreviewRequest) (*models.CatalogSourcePreviewResult, error) {
+	catalogSourcePreview := CreateCatalogSourcePreviewMock()
+
+	return &catalogSourcePreview, nil
+}

clients/ui/bff/internal/mocks/static_data_mock.go

@@ -1373,3 +1373,45 @@ func GetCatalogSourceConfigListMock() models.CatalogSourceConfigList {
 		Catalogs: allCatalogSourceConfigs,
 	}
 }
+
+func GetModelsWithInclusionStatusListMocks() []models.CatalogSourcePreviewModel {
+	return []models.CatalogSourcePreviewModel{
+		{
+			Name:     "sample-source/granite",
+			Included: true,
+		},
+		{
+			Name:     "sample-source/model-1",
+			Included: true,
+		},
+		{
+			Name:     "adminModel1/model-2",
+			Included: true,
+		},
+		{
+			Name:     "adminModel1/model-3",
+			Included: false,
+		},
+	}
+}
+
+func GetCatalogSourcePreviewSummaryMock() models.CatalogSourcePreviewSummary {
+	return models.CatalogSourcePreviewSummary{
+		TotalModels:    1500,
+		IncludedModels: 850,
+		ExcludedModels: 650,
+	}
+}
+
+func CreateCatalogSourcePreviewMock() models.CatalogSourcePreviewResult {
+	catalogModelPreview := GetModelsWithInclusionStatusListMocks()
+	catalogSourcePreviewSummary := GetCatalogSourcePreviewSummaryMock()
+
+	return models.CatalogSourcePreviewResult{
+		Items:         catalogModelPreview,
+		Summary:       catalogSourcePreviewSummary,
+		NextPageToken: "",
+		PageSize:      int32(10),
+		Size:          int32(len(catalogModelPreview)),
+	}
+}

clients/ui/bff/internal/models/catalog_source_preview.go

@@ -0,0 +1,27 @@
+package models
+
+type CatalogSourcePreviewRequest struct {
+	Type           string                 `json:"type"`
+	IncludedModels []string               `json:"includedModels,omitempty"`
+	ExcludedModels []string               `json:"excludedModels,omitempty"`
+	Properties     map[string]interface{} `json:"properties,omitempty"`
+}
+
+type CatalogSourcePreviewModel struct {
+	Name     string `json:"name"`
+	Included bool   `json:"included"`
+}
+
+type CatalogSourcePreviewSummary struct {
+	TotalModels    int32 `json:"totalModels"`
+	IncludedModels int32 `json:"includedModels"`
+	ExcludedModels int32 `json:"excludedModels"`
+}
+
+type CatalogSourcePreviewResult struct {
+	Items         []CatalogSourcePreviewModel `json:"items"`
+	Summary       CatalogSourcePreviewSummary `json:"summary"`
+	NextPageToken string                      `json:"nextPageToken"`
+	PageSize      int32                       `json:"pageSize"`
+	Size          int32                       `json:"size"`
+}

clients/ui/bff/internal/repositories/catalog_source_preview.go

@@ -0,0 +1,20 @@
+package repositories
+
+import (
+	"fmt"
+
+	"github.com/kubeflow/model-registry/ui/bff/internal/integrations/httpclient"
+	"github.com/kubeflow/model-registry/ui/bff/internal/models"
+)
+
+type CatalogSourcePreviewInterface interface {
+	CreateCatalogSourcePreview(client httpclient.HTTPClientInterface, sourcePreviewPaylod models.CatalogSourcePreviewRequest) (*models.CatalogSourcePreviewResult, error)
+}
+
+type CatalogSourcePreview struct {
+	CatalogSourcePreviewInterface
+}
+
+func (a CatalogSourcePreview) CreateCatalogSourcePreview(client httpclient.HTTPClientInterface, sourcePreviewPaylod models.CatalogSourcePreviewRequest) (*models.CatalogSourcePreviewResult, error) {
+	return nil, fmt.Errorf("not implemented yet")
+}

clients/ui/bff/internal/repositories/model_catalog_client.go

@@ -7,12 +7,14 @@ import (
 type ModelCatalogClientInterface interface {
 	CatalogSourcesInterface
 	CatalogModelsInterface
+	CatalogSourcePreviewInterface
 }
 
 type ModelCatalogClient struct {
 	logger *slog.Logger
 	CatalogSources
 	CatalogModels
+	CatalogSourcePreview
 }
 
 func NewModelCatalogClient(logger *slog.Logger) (ModelCatalogClientInterface, error) {