bump OAS version to v1alpha3

Signed-off-by: Isabella Basso do Amaral <[email protected]>
kubeflow · Mar 8, 2024 · bb1101d · bb1101d
1 parent 9a51c58
commit bb1101d
Show file tree

Hide file tree

Showing 64 changed files with 258 additions and 258 deletions.
diff --git a/api/openapi/model-registry.yaml b/api/openapi/model-registry.yaml
@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: Model Registry REST API
-  version: v1alpha2
+  version: v1alpha3
   description: REST API for Model Registry to create and manage ML model metadata
   license:
     name: Apache 2.0
@@ -10,7 +10,7 @@ servers:
   - url: "https://localhost:8080"
   - url: "http://localhost:8080"
 paths:
-  /api/model_registry/v1alpha2/model_artifact:
+  /api/model_registry/v1alpha3/model_artifact:
     summary: Path used to search for a modelartifact.
     description: >-
       The REST endpoint/path used to search for a `ModelArtifact` entity.  This path contains a `GET` operation to perform the find task.
@@ -35,7 +35,7 @@ paths:
       - $ref: "#/components/parameters/name"
       - $ref: "#/components/parameters/externalId"
       - $ref: "#/components/parameters/parentResourceId"
-  /api/model_registry/v1alpha2/model_artifacts:
+  /api/model_registry/v1alpha3/model_artifacts:
     summary: Path used to manage the list of modelartifacts.
     description: >-
       The REST endpoint/path used to list and create zero or more `ModelArtifact` entities.  This path contains a `GET` and `POST` operation to perform the list and create tasks, respectively.
@@ -83,7 +83,7 @@ paths:
       operationId: createModelArtifact
       summary: Create a ModelArtifact
       description: Creates a new instance of a `ModelArtifact`.
-  "/api/model_registry/v1alpha2/model_artifacts/{modelartifactId}":
+  "/api/model_registry/v1alpha3/model_artifacts/{modelartifactId}":
     summary: Path used to manage a single ModelArtifact.
     description: >-
       The REST endpoint/path used to get, update, and delete single instances of an `ModelArtifact`. This path contains `GET`, `PUT`, and `DELETE` operations used to perform the get, update, and delete tasks, respectively.
@@ -133,7 +133,7 @@ paths:
           type: string
         in: path
         required: true
-  /api/model_registry/v1alpha2/model_versions:
+  /api/model_registry/v1alpha3/model_versions:
     summary: Path used to manage the list of modelversions.
     description: >-
       The REST endpoint/path used to list and create zero or more `ModelVersion` entities.  This path contains a `GET` and `POST` operation to perform the list and create tasks, respectively.
@@ -177,7 +177,7 @@ paths:
       operationId: createModelVersion
       summary: Create a ModelVersion
       description: Creates a new instance of a `ModelVersion`.
-  "/api/model_registry/v1alpha2/model_versions/{modelversionId}":
+  "/api/model_registry/v1alpha3/model_versions/{modelversionId}":
     summary: Path used to manage a single ModelVersion.
     description: >-
       The REST endpoint/path used to get, update, and delete single instances of an `ModelVersion`. This path contains `GET`, `PUT`, and `DELETE` operations used to perform the get, update, and delete tasks, respectively.
@@ -227,7 +227,7 @@ paths:
           type: string
         in: path
         required: true
-  /api/model_registry/v1alpha2/registered_model:
+  /api/model_registry/v1alpha3/registered_model:
     summary: Path used to search for a registeredmodel.
     description: >-
       The REST endpoint/path used to search for a `RegisteredModel` entity.  This path contains a `GET` operation to perform the find task.
@@ -249,7 +249,7 @@ paths:
     parameters:
       - $ref: "#/components/parameters/name"
       - $ref: "#/components/parameters/externalId"
-  /api/model_registry/v1alpha2/registered_models:
+  /api/model_registry/v1alpha3/registered_models:
     summary: Path used to manage the list of registeredmodels.
     description: >-
       The REST endpoint/path used to list and create zero or more `RegisteredModel` entities.  This path contains a `GET` and `POST` operation to perform the list and create tasks, respectively.
@@ -293,7 +293,7 @@ paths:
       operationId: createRegisteredModel
       summary: Create a RegisteredModel
       description: Creates a new instance of a `RegisteredModel`.
-  "/api/model_registry/v1alpha2/registered_models/{registeredmodelId}":
+  "/api/model_registry/v1alpha3/registered_models/{registeredmodelId}":
     summary: Path used to manage a single RegisteredModel.
     description: >-
       The REST endpoint/path used to get, update, and delete single instances of an `RegisteredModel`. This path contains `GET`, `PUT`, and `DELETE` operations used to perform the get, update, and delete tasks, respectively.
@@ -343,7 +343,7 @@ paths:
           type: string
         in: path
         required: true
-  "/api/model_registry/v1alpha2/model_versions/{modelversionId}/artifacts":
+  "/api/model_registry/v1alpha3/model_versions/{modelversionId}/artifacts":
     summary: Path used to manage the list of artifacts for a modelversion.
     description: >-
       The REST endpoint/path used to list and create zero or more `Artifact` entities for a `ModelVersion`.  This path contains a `GET` and `POST` operation to perform the list and create tasks, respectively.
@@ -401,7 +401,7 @@ paths:
           type: string
         in: path
         required: true
-  "/api/model_registry/v1alpha2/registered_models/{registeredmodelId}/versions":
+  "/api/model_registry/v1alpha3/registered_models/{registeredmodelId}/versions":
     summary: Path used to manage the list of modelversions for a registeredmodel.
     description: >-
       The REST endpoint/path used to list and create zero or more `ModelVersion` entities for a `RegisteredModel`.  This path contains a `GET` and `POST` operation to perform the list and create tasks, respectively.
@@ -458,7 +458,7 @@ paths:
           type: string
         in: path
         required: true
-  /api/model_registry/v1alpha2/inference_service:
+  /api/model_registry/v1alpha3/inference_service:
     summary: Path used to manage an instance of inferenceservice.
     description: >-
       The REST endpoint/path used to list and create zero or more `InferenceService` entities.  This path contains a `GET` and `POST` operation to perform the list and create tasks, respectively.
@@ -483,7 +483,7 @@ paths:
       - $ref: "#/components/parameters/name"
       - $ref: "#/components/parameters/externalId"
       - $ref: "#/components/parameters/parentResourceId"
-  "/api/model_registry/v1alpha2/inference_services/{inferenceserviceId}":
+  "/api/model_registry/v1alpha3/inference_services/{inferenceserviceId}":
     summary: Path used to manage a single InferenceService.
     description: >-
       The REST endpoint/path used to get, update, and delete single instances of an `InferenceService`. This path contains `GET`, `PUT`, and `DELETE` operations used to perform the get, update, and delete tasks, respectively.
@@ -533,7 +533,7 @@ paths:
           type: string
         in: path
         required: true
-  /api/model_registry/v1alpha2/inference_services:
+  /api/model_registry/v1alpha3/inference_services:
     summary: Path used to manage the list of inferenceservices.
     description: >-
       The REST endpoint/path used to list and create zero or more `InferenceService` entities.  This path contains a `GET` and `POST` operation to perform the list and create tasks, respectively.
@@ -581,7 +581,7 @@ paths:
       operationId: createInferenceService
       summary: Create a InferenceService
       description: Creates a new instance of a `InferenceService`.
-  /api/model_registry/v1alpha2/serving_environment:
+  /api/model_registry/v1alpha3/serving_environment:
     summary: Path used to find a servingenvironment.
     description: >-
       The REST endpoint/path used to search for a `ServingEnvironment` entity.  This path contains a `GET` operation to perform the find task.
@@ -603,7 +603,7 @@ paths:
     parameters:
       - $ref: "#/components/parameters/name"
       - $ref: "#/components/parameters/externalId"
-  /api/model_registry/v1alpha2/serving_environments:
+  /api/model_registry/v1alpha3/serving_environments:
     summary: Path used to manage the list of servingenvironments.
     description: >-
       The REST endpoint/path used to list and create zero or more `ServingEnvironment` entities.  This path contains a `GET` and `POST` operation to perform the list and create tasks, respectively.
@@ -647,7 +647,7 @@ paths:
       operationId: createServingEnvironment
       summary: Create a ServingEnvironment
       description: Creates a new instance of a `ServingEnvironment`.
-  "/api/model_registry/v1alpha2/serving_environments/{servingenvironmentId}":
+  "/api/model_registry/v1alpha3/serving_environments/{servingenvironmentId}":
     summary: Path used to manage a single ServingEnvironment.
     description: >-
       The REST endpoint/path used to get, update, and delete single instances of an `ServingEnvironment`.  This path contains `GET`, `PUT`, and `DELETE` operations used to perform the get, update, and delete tasks, respectively.
@@ -697,7 +697,7 @@ paths:
           type: string
         in: path
         required: true
-  "/api/model_registry/v1alpha2/serving_environments/{servingenvironmentId}/inference_services":
+  "/api/model_registry/v1alpha3/serving_environments/{servingenvironmentId}/inference_services":
     summary: Path used to manage the list of `InferenceServices` for a `ServingEnvironment`.
     description: >-
       The REST endpoint/path used to list and create zero or more `InferenceService` entities for a `ServingEnvironment`.  This path contains a `GET` and `POST` operation to perform the list and create tasks, respectively.
@@ -754,7 +754,7 @@ paths:
           type: string
         in: path
         required: true
-  "/api/model_registry/v1alpha2/inference_services/{inferenceserviceId}/serves":
+  "/api/model_registry/v1alpha3/inference_services/{inferenceserviceId}/serves":
     summary: Path used to manage the list of `ServeModels` for a `InferenceService`.
     description: >-
       The REST endpoint/path used to list and create zero or more `ServeModel` entities for a `InferenceService`.  This path contains a `GET` and `POST` operation to perform the list and create tasks, respectively.
@@ -811,7 +811,7 @@ paths:
           type: string
         in: path
         required: true
-  "/api/model_registry/v1alpha2/inference_services/{inferenceserviceId}/model":
+  "/api/model_registry/v1alpha3/inference_services/{inferenceserviceId}/model":
     summary: Path used to manage a `RegisteredModel` associated with an `InferenceService`.
     description: >-
       The REST endpoint/path used to list the `RegisteredModel` entity for an `InferenceService`.  This path contains a `GET` operation to perform the get task.
@@ -837,7 +837,7 @@ paths:
           type: string
         in: path
         required: true
-  "/api/model_registry/v1alpha2/inference_services/{inferenceserviceId}/version":
+  "/api/model_registry/v1alpha3/inference_services/{inferenceserviceId}/version":
     summary: Path used to get the current `ModelVersion` associated with an `InferenceService`.
     description: >-
       The REST endpoint/path used to get the current `ModelVersion` entity for a `InferenceService`. This path contains a `GET` operation to perform the get task.
@@ -863,7 +863,7 @@ paths:
           type: string
         in: path
         required: true
-  /api/model_registry/v1alpha2/model_version:
+  /api/model_registry/v1alpha3/model_version:
     summary: Path used to search for a modelversion.
     description: >-
       The REST endpoint/path used to search for a `ModelVersion` entity.  This path contains a `GET` operation to perform the find task.

diff --git a/csi/GET_STARTED.md b/csi/GET_STARTED.md
@@ -82,7 +82,7 @@ Then, in the same terminal where you exported `MR_HOSTNAME`, perform the followi
 
 ```bash
 curl --silent -X 'POST' \
-  "$MR_HOSTNAME/api/model_registry/v1alpha2/registered_models" \
+  "$MR_HOSTNAME/api/model_registry/v1alpha3/registered_models" \
   -H 'accept: application/json' \
   -H 'Content-Type: application/json' \
   -d '{
@@ -100,7 +100,7 @@ Expected output:
 
 ```bash
 curl --silent -X 'POST' \
-  "$MR_HOSTNAME/api/model_registry/v1alpha2/model_versions" \
+  "$MR_HOSTNAME/api/model_registry/v1alpha3/model_versions" \
   -H 'accept: application/json' \
   -H 'Content-Type: application/json' \
   -d '{
@@ -121,7 +121,7 @@ This artifact defines where the actual trained model is stored, i.e., `gs://kfse
 
 ```bash
 curl --silent -X 'POST' \
-  "$MR_HOSTNAME/api/model_registry/v1alpha2/model_versions/2/artifacts" \
+  "$MR_HOSTNAME/api/model_registry/v1alpha3/model_versions/2/artifacts" \
   -H 'accept: application/json' \
   -H 'Content-Type: application/json' \
   -d '{
@@ -246,4 +246,4 @@ If you do not have DNS, you can still curl with the ingress gateway external IP
 ```bash
 SERVICE_HOSTNAME=$(kubectl get inferenceservice iris-model -n kserve-test -o jsonpath='{.status.url}' | cut -d "/" -f 3)
 curl -v -H "Host: ${SERVICE_HOSTNAME}" -H "Content-Type: application/json" "http://${INGRESS_HOST}:${INGRESS_PORT}/v1/models/iris-v1:predict" -d @/tmp/iris-input.json
-```
+```
diff --git a/docs/logical_model.md b/docs/logical_model.md
@@ -87,7 +87,7 @@ resulting in:
 
 ```
 curl --silent -X 'GET' \
-  "$MR_HOSTNAME/api/model_registry/v1alpha2/registered_models/1" \                     
+  "$MR_HOSTNAME/api/model_registry/v1alpha3/registered_models/1" \                     
   -H 'accept: application/json' | jq
 {
   "createTimeSinceEpoch": "1707765353963",
@@ -99,7 +99,7 @@ curl --silent -X 'GET' \
 }
 
 curl --silent -X 'GET' \
-  "$MR_HOSTNAME/api/model_registry/v1alpha2/registered_models/1/versions?pageSize=100&orderBy=ID&sortOrder=DESC&nextPageToken=" \
+  "$MR_HOSTNAME/api/model_registry/v1alpha3/registered_models/1/versions?pageSize=100&orderBy=ID&sortOrder=DESC&nextPageToken=" \
   -H 'accept: application/json' | jq 
 {
   "items": [
@@ -120,7 +120,7 @@ curl --silent -X 'GET' \
 }
 
 curl --silent -X 'GET' \
-  "$MR_HOSTNAME/api/model_registry/v1alpha2/model_versions/2/artifacts" \
+  "$MR_HOSTNAME/api/model_registry/v1alpha3/model_versions/2/artifacts" \
   -H 'accept: application/json' | jq
 {
   "items": [
@@ -167,7 +167,7 @@ resulting in:
 
 ```
 curl --silent -X 'GET' \
-  "$MR_HOSTNAME/api/model_registry/v1alpha2/registered_models/3" \       
+  "$MR_HOSTNAME/api/model_registry/v1alpha3/registered_models/3" \       
   -H 'accept: application/json' | jq 
 {
   "createTimeSinceEpoch": "1707765756856",
@@ -179,7 +179,7 @@ curl --silent -X 'GET' \
 }
 
 curl --silent -X 'GET' \
-  "$MR_HOSTNAME/api/model_registry/v1alpha2/registered_models/3/versions?pageSize=100&orderBy=ID&sortOrder=DESC&nextPageToken=" \
+  "$MR_HOSTNAME/api/model_registry/v1alpha3/registered_models/3/versions?pageSize=100&orderBy=ID&sortOrder=DESC&nextPageToken=" \
   -H 'accept: application/json' | jq 
 {
   "items": [
@@ -200,7 +200,7 @@ curl --silent -X 'GET' \
 }
 
 curl --silent -X 'GET' \
-  "$MR_HOSTNAME/api/model_registry/v1alpha2/model_versions/4/artifacts" \                                                       
+  "$MR_HOSTNAME/api/model_registry/v1alpha3/model_versions/4/artifacts" \                                                       
   -H 'accept: application/json' | jq
 {
   "items": [
@@ -247,7 +247,7 @@ resulting in:
 
 ```
 curl --silent -X 'GET' \
-  "$MR_HOSTNAME/api/model_registry/v1alpha2/registered_models/5" \                                                               
+  "$MR_HOSTNAME/api/model_registry/v1alpha3/registered_models/5" \                                                               
   -H 'accept: application/json' | jq 
 {
   "createTimeSinceEpoch": "1707765990857",
@@ -259,7 +259,7 @@ curl --silent -X 'GET' \
 }
 
 curl --silent -X 'GET' \
-  "$MR_HOSTNAME/api/model_registry/v1alpha2/registered_models/5/versions?pageSize=100&orderBy=ID&sortOrder=DESC&nextPageToken=" \
+  "$MR_HOSTNAME/api/model_registry/v1alpha3/registered_models/5/versions?pageSize=100&orderBy=ID&sortOrder=DESC&nextPageToken=" \
   -H 'accept: application/json' | jq 
 {
   "items": [
@@ -290,7 +290,7 @@ curl --silent -X 'GET' \
 }
 
 curl --silent -X 'GET' \
-  "$MR_HOSTNAME/api/model_registry/v1alpha2/model_versions/6/artifacts" \                                                      
+  "$MR_HOSTNAME/api/model_registry/v1alpha3/model_versions/6/artifacts" \                                                      
   -H 'accept: application/json' | jq
 {
   "items": [
@@ -362,7 +362,7 @@ resulting in:
 
 ```
 curl --silent -X 'GET' \
-  "$MR_HOSTNAME/api/model_registry/v1alpha2/registered_models/7" \                                                               
+  "$MR_HOSTNAME/api/model_registry/v1alpha3/registered_models/7" \                                                               
   -H 'accept: application/json' | jq 
 {
   "createTimeSinceEpoch": "1707766117250",
@@ -374,7 +374,7 @@ curl --silent -X 'GET' \
 }
 
 curl --silent -X 'GET' \
-  "$MR_HOSTNAME/api/model_registry/v1alpha2/registered_models/7/versions?pageSize=100&orderBy=ID&sortOrder=DESC&nextPageToken=" \
+  "$MR_HOSTNAME/api/model_registry/v1alpha3/registered_models/7/versions?pageSize=100&orderBy=ID&sortOrder=DESC&nextPageToken=" \
   -H 'accept: application/json' | jq 
 {
   "items": [
@@ -395,7 +395,7 @@ curl --silent -X 'GET' \
 }
 
 curl --silent -X 'GET' \
-  "$MR_HOSTNAME/api/model_registry/v1alpha2/model_versions/8/artifacts" \                                                       
+  "$MR_HOSTNAME/api/model_registry/v1alpha3/model_versions/8/artifacts" \                                                       
   -H 'accept: application/json' | jq
 {
   "items": [