periodic sync upstream KF to midstream ODH

.github/workflows/python-tests.yml

@@ -65,6 +65,53 @@ jobs:
             nox --python=${{ matrix.python }}
           fi
 
+  check-autogen:
+    name: Check autogenerated code is in sync
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ["3.12"]
+        nodejs: ["20"]
+    steps:
+      - name: Check out the repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.nodejs }}
+      - name: Upgrade pip
+        run: |
+          pip install --constraint=.github/workflows/constraints.txt pip
+          pip --version
+      - name: Install Poetry
+        run: |
+          pipx install --pip-args=--constraint=${{ github.workspace }}/.github/workflows/constraints.txt poetry
+          poetry --version
+      - name: Install openapi-generator-cli
+        run: |
+          make bin/openapi-generator-cli
+      - name: Generate Python client
+        working-directory: clients/python
+        run: |
+          make clean install tidy
+      - name: Check if there are uncommitted file changes
+        run: |
+          clean=$(git status --porcelain)
+          if [[ -z "$clean" ]]; then
+              echo "Empty git status --porcelain: $clean"
+          else
+              echo "Uncommitted file changes detected: $clean"
+              git diff
+              exit 1
+          fi
+
   test:
     name: Test against Py ${{ matrix.python }} and K8s ${{ matrix.kubernetes-version }}
     runs-on: ubuntu-latest

api/openapi/model-registry.yaml

@@ -1225,6 +1225,8 @@ components:
               type: array
               items:
                 $ref: "#/components/schemas/ModelVersion"
+          required:
+            - items
         - $ref: "#/components/schemas/BaseResourceList"
     ModelArtifactList:
       description: List of ModelArtifact entities.
@@ -1236,6 +1238,8 @@ components:
               type: array
               items:
                 $ref: "#/components/schemas/ModelArtifact"
+          required:
+            - items
         - $ref: "#/components/schemas/BaseResourceList"
     RegisteredModelCreate:
       description: A registered model in model registry. A registered model has ModelVersion children.
@@ -1507,6 +1511,8 @@ components:
               type: array
               items:
                 $ref: "#/components/schemas/Artifact"
+          required:
+            - items
         - $ref: "#/components/schemas/BaseResourceList"
     ModelArtifactUpdate:
       description: An ML model artifact to be updated.
@@ -1612,6 +1618,8 @@ components:
               items:
                 $ref: "#/components/schemas/ServingEnvironment"
               readOnly: false
+          required:
+            - items
         - $ref: "#/components/schemas/BaseResourceList"
     RegisteredModelList:
       description: List of RegisteredModels.
@@ -1624,6 +1632,8 @@ components:
               items:
                 $ref: "#/components/schemas/RegisteredModel"
               readOnly: false
+          required:
+            - items
         - $ref: "#/components/schemas/BaseResourceList"
     ServingEnvironment:
       description: A Model Serving environment for serving `RegisteredModels`.
@@ -1656,6 +1666,8 @@ components:
               items:
                 $ref: "#/components/schemas/InferenceService"
               readOnly: false
+          required:
+            - items
         - $ref: "#/components/schemas/BaseResourceList"
     ServeModelList:
       description: List of ServeModel entities.
@@ -1667,6 +1679,8 @@ components:
               type: array
               items:
                 $ref: "#/components/schemas/ServeModel"
+          required:
+            - items
         - $ref: "#/components/schemas/BaseResourceList"
     ServeModel:
       description: An ML model serving action.

clients/python/Makefile

@@ -5,8 +5,8 @@ IMG_VERSION ?= latest
 
 .PHONY: install
 install:
-	../../bin/openapi-generator-cli generate -i ../../api/openapi/model-registry.yaml -g python -o src/ --package-name mr_openapi --additional-properties=library=asyncio,generateSourceCodeOnly=true,useOneOfDiscriminatorLookup=true
-	mv src/mr_openapi{_,/}README.md
+	../../bin/openapi-generator-cli generate -i ../../api/openapi/model-registry.yaml -g python -o src/ --package-name mr_openapi --additional-properties=library=asyncio,generateSourceCodeOnly=true,useOneOfDiscriminatorLookup=true --template-dir templates/
+	mv src/mr_openapi_README.md src/mr_openapi/README.md
 	git apply patches/*
 	poetry install
 

clients/python/README.md

@@ -185,16 +185,31 @@ Currently, the Model Registry backend treats model lists as a circular buffer, a
 
 ## Development
 
+### Using the Makefile
+
+The `Makefile` contains most common development tasks
+
+To install dependencies:
+
+```bash
+make
+```
+
+Then you can run tests:
+
+```bash
+make test test-e2e
+```
+
+### Using Nox
+
 Common tasks, such as building documentation and running tests, can be executed using [`nox`](https://github.com/wntrblm/nox) sessions.
 
 Use `nox -l` to list sessions and execute them using `nox -s [session]`.
 
-Alternatively, use `make install` to setup a local Python virtual environment with `poetry`.
+### Testing requirements
 
-To run the tests you will need `docker` (or equivalent) and the `compose` extension command.
-This is necessary as the test suite will manage a Model Registry server and an MLMD instance to ensure a clean state on
-each run.
-You can use `make test` to execute `pytest`.
+To run the e2e tests you will need [kind](https://kind.sigs.k8s.io/) to be installed. This is necessary as the e2e test suite will manage a Model Registry deployment and an MLMD deployment to ensure a clean MR target on each run.
 
 ### Running Locally on Mac M1 or M2 (arm64 architecture)