Skip to content

Commit d5eec54

Browse files
antisalingantisaling
committed
bump OAS version to v1alpha3
Signed-off-by: Isabella Basso do Amaral <idoamara@redhat.com>
1 parent 9a51c58 commit d5eec54

67 files changed

Lines changed: 261 additions & 261 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎api/openapi/model-registry.yaml‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
openapi: 3.0.3
22
info:
33
title: Model Registry REST API
4-
version: v1alpha2
4+
version: v1alpha3
55
description: REST API for Model Registry to create and manage ML model metadata
66
license:
77
name: Apache 2.0
@@ -10,7 +10,7 @@ servers:
1010
- url: "https://localhost:8080"
1111
- url: "http://localhost:8080"
1212
paths:
13-
/api/model_registry/v1alpha2/model_artifact:
13+
/api/model_registry/v1alpha3/model_artifact:
1414
summary: Path used to search for a modelartifact.
1515
description: >-
1616
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:
3535
- $ref: "#/components/parameters/name"
3636
- $ref: "#/components/parameters/externalId"
3737
- $ref: "#/components/parameters/parentResourceId"
38-
/api/model_registry/v1alpha2/model_artifacts:
38+
/api/model_registry/v1alpha3/model_artifacts:
3939
summary: Path used to manage the list of modelartifacts.
4040
description: >-
4141
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:
8383
operationId: createModelArtifact
8484
summary: Create a ModelArtifact
8585
description: Creates a new instance of a `ModelArtifact`.
86-
"/api/model_registry/v1alpha2/model_artifacts/{modelartifactId}":
86+
"/api/model_registry/v1alpha3/model_artifacts/{modelartifactId}":
8787
summary: Path used to manage a single ModelArtifact.
8888
description: >-
8989
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:
133133
type: string
134134
in: path
135135
required: true
136-
/api/model_registry/v1alpha2/model_versions:
136+
/api/model_registry/v1alpha3/model_versions:
137137
summary: Path used to manage the list of modelversions.
138138
description: >-
139139
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:
177177
operationId: createModelVersion
178178
summary: Create a ModelVersion
179179
description: Creates a new instance of a `ModelVersion`.
180-
"/api/model_registry/v1alpha2/model_versions/{modelversionId}":
180+
"/api/model_registry/v1alpha3/model_versions/{modelversionId}":
181181
summary: Path used to manage a single ModelVersion.
182182
description: >-
183183
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:
227227
type: string
228228
in: path
229229
required: true
230-
/api/model_registry/v1alpha2/registered_model:
230+
/api/model_registry/v1alpha3/registered_model:
231231
summary: Path used to search for a registeredmodel.
232232
description: >-
233233
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:
249249
parameters:
250250
- $ref: "#/components/parameters/name"
251251
- $ref: "#/components/parameters/externalId"
252-
/api/model_registry/v1alpha2/registered_models:
252+
/api/model_registry/v1alpha3/registered_models:
253253
summary: Path used to manage the list of registeredmodels.
254254
description: >-
255255
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:
293293
operationId: createRegisteredModel
294294
summary: Create a RegisteredModel
295295
description: Creates a new instance of a `RegisteredModel`.
296-
"/api/model_registry/v1alpha2/registered_models/{registeredmodelId}":
296+
"/api/model_registry/v1alpha3/registered_models/{registeredmodelId}":
297297
summary: Path used to manage a single RegisteredModel.
298298
description: >-
299299
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:
343343
type: string
344344
in: path
345345
required: true
346-
"/api/model_registry/v1alpha2/model_versions/{modelversionId}/artifacts":
346+
"/api/model_registry/v1alpha3/model_versions/{modelversionId}/artifacts":
347347
summary: Path used to manage the list of artifacts for a modelversion.
348348
description: >-
349349
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:
401401
type: string
402402
in: path
403403
required: true
404-
"/api/model_registry/v1alpha2/registered_models/{registeredmodelId}/versions":
404+
"/api/model_registry/v1alpha3/registered_models/{registeredmodelId}/versions":
405405
summary: Path used to manage the list of modelversions for a registeredmodel.
406406
description: >-
407407
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:
458458
type: string
459459
in: path
460460
required: true
461-
/api/model_registry/v1alpha2/inference_service:
461+
/api/model_registry/v1alpha3/inference_service:
462462
summary: Path used to manage an instance of inferenceservice.
463463
description: >-
464464
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:
483483
- $ref: "#/components/parameters/name"
484484
- $ref: "#/components/parameters/externalId"
485485
- $ref: "#/components/parameters/parentResourceId"
486-
"/api/model_registry/v1alpha2/inference_services/{inferenceserviceId}":
486+
"/api/model_registry/v1alpha3/inference_services/{inferenceserviceId}":
487487
summary: Path used to manage a single InferenceService.
488488
description: >-
489489
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:
533533
type: string
534534
in: path
535535
required: true
536-
/api/model_registry/v1alpha2/inference_services:
536+
/api/model_registry/v1alpha3/inference_services:
537537
summary: Path used to manage the list of inferenceservices.
538538
description: >-
539539
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:
581581
operationId: createInferenceService
582582
summary: Create a InferenceService
583583
description: Creates a new instance of a `InferenceService`.
584-
/api/model_registry/v1alpha2/serving_environment:
584+
/api/model_registry/v1alpha3/serving_environment:
585585
summary: Path used to find a servingenvironment.
586586
description: >-
587587
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:
603603
parameters:
604604
- $ref: "#/components/parameters/name"
605605
- $ref: "#/components/parameters/externalId"
606-
/api/model_registry/v1alpha2/serving_environments:
606+
/api/model_registry/v1alpha3/serving_environments:
607607
summary: Path used to manage the list of servingenvironments.
608608
description: >-
609609
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:
647647
operationId: createServingEnvironment
648648
summary: Create a ServingEnvironment
649649
description: Creates a new instance of a `ServingEnvironment`.
650-
"/api/model_registry/v1alpha2/serving_environments/{servingenvironmentId}":
650+
"/api/model_registry/v1alpha3/serving_environments/{servingenvironmentId}":
651651
summary: Path used to manage a single ServingEnvironment.
652652
description: >-
653653
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:
697697
type: string
698698
in: path
699699
required: true
700-
"/api/model_registry/v1alpha2/serving_environments/{servingenvironmentId}/inference_services":
700+
"/api/model_registry/v1alpha3/serving_environments/{servingenvironmentId}/inference_services":
701701
summary: Path used to manage the list of `InferenceServices` for a `ServingEnvironment`.
702702
description: >-
703703
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:
754754
type: string
755755
in: path
756756
required: true
757-
"/api/model_registry/v1alpha2/inference_services/{inferenceserviceId}/serves":
757+
"/api/model_registry/v1alpha3/inference_services/{inferenceserviceId}/serves":
758758
summary: Path used to manage the list of `ServeModels` for a `InferenceService`.
759759
description: >-
760760
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:
811811
type: string
812812
in: path
813813
required: true
814-
"/api/model_registry/v1alpha2/inference_services/{inferenceserviceId}/model":
814+
"/api/model_registry/v1alpha3/inference_services/{inferenceserviceId}/model":
815815
summary: Path used to manage a `RegisteredModel` associated with an `InferenceService`.
816816
description: >-
817817
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:
837837
type: string
838838
in: path
839839
required: true
840-
"/api/model_registry/v1alpha2/inference_services/{inferenceserviceId}/version":
840+
"/api/model_registry/v1alpha3/inference_services/{inferenceserviceId}/version":
841841
summary: Path used to get the current `ModelVersion` associated with an `InferenceService`.
842842
description: >-
843843
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:
863863
type: string
864864
in: path
865865
required: true
866-
/api/model_registry/v1alpha2/model_version:
866+
/api/model_registry/v1alpha3/model_version:
867867
summary: Path used to search for a modelversion.
868868
description: >-
869869
The REST endpoint/path used to search for a `ModelVersion` entity. This path contains a `GET` operation to perform the find task.

‎csi/GET_STARTED.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Then, in the same terminal where you exported `MR_HOSTNAME`, perform the followi
8282

8383
```bash
8484
curl --silent -X 'POST' \
85-
"$MR_HOSTNAME/api/model_registry/v1alpha2/registered_models" \
85+
"$MR_HOSTNAME/api/model_registry/v1alpha3/registered_models" \
8686
-H 'accept: application/json' \
8787
-H 'Content-Type: application/json' \
8888
-d '{
@@ -100,7 +100,7 @@ Expected output:
100100

101101
```bash
102102
curl --silent -X 'POST' \
103-
"$MR_HOSTNAME/api/model_registry/v1alpha2/model_versions" \
103+
"$MR_HOSTNAME/api/model_registry/v1alpha3/model_versions" \
104104
-H 'accept: application/json' \
105105
-H 'Content-Type: application/json' \
106106
-d '{
@@ -121,7 +121,7 @@ This artifact defines where the actual trained model is stored, i.e., `gs://kfse
121121

122122
```bash
123123
curl --silent -X 'POST' \
124-
"$MR_HOSTNAME/api/model_registry/v1alpha2/model_versions/2/artifacts" \
124+
"$MR_HOSTNAME/api/model_registry/v1alpha3/model_versions/2/artifacts" \
125125
-H 'accept: application/json' \
126126
-H 'Content-Type: application/json' \
127127
-d '{
@@ -246,4 +246,4 @@ If you do not have DNS, you can still curl with the ingress gateway external IP
246246
```bash
247247
SERVICE_HOSTNAME=$(kubectl get inferenceservice iris-model -n kserve-test -o jsonpath='{.status.url}' | cut -d "/" -f 3)
248248
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
249-
```
249+
```

‎docs/logical_model.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ resulting in:
8787

8888
```
8989
curl --silent -X 'GET' \
90-
"$MR_HOSTNAME/api/model_registry/v1alpha2/registered_models/1" \
90+
"$MR_HOSTNAME/api/model_registry/v1alpha3/registered_models/1" \
9191
-H 'accept: application/json' | jq
9292
{
9393
"createTimeSinceEpoch": "1707765353963",
@@ -99,7 +99,7 @@ curl --silent -X 'GET' \
9999
}
100100
101101
curl --silent -X 'GET' \
102-
"$MR_HOSTNAME/api/model_registry/v1alpha2/registered_models/1/versions?pageSize=100&orderBy=ID&sortOrder=DESC&nextPageToken=" \
102+
"$MR_HOSTNAME/api/model_registry/v1alpha3/registered_models/1/versions?pageSize=100&orderBy=ID&sortOrder=DESC&nextPageToken=" \
103103
-H 'accept: application/json' | jq
104104
{
105105
"items": [
@@ -120,7 +120,7 @@ curl --silent -X 'GET' \
120120
}
121121
122122
curl --silent -X 'GET' \
123-
"$MR_HOSTNAME/api/model_registry/v1alpha2/model_versions/2/artifacts" \
123+
"$MR_HOSTNAME/api/model_registry/v1alpha3/model_versions/2/artifacts" \
124124
-H 'accept: application/json' | jq
125125
{
126126
"items": [
@@ -167,7 +167,7 @@ resulting in:
167167

168168
```
169169
curl --silent -X 'GET' \
170-
"$MR_HOSTNAME/api/model_registry/v1alpha2/registered_models/3" \
170+
"$MR_HOSTNAME/api/model_registry/v1alpha3/registered_models/3" \
171171
-H 'accept: application/json' | jq
172172
{
173173
"createTimeSinceEpoch": "1707765756856",
@@ -179,7 +179,7 @@ curl --silent -X 'GET' \
179179
}
180180
181181
curl --silent -X 'GET' \
182-
"$MR_HOSTNAME/api/model_registry/v1alpha2/registered_models/3/versions?pageSize=100&orderBy=ID&sortOrder=DESC&nextPageToken=" \
182+
"$MR_HOSTNAME/api/model_registry/v1alpha3/registered_models/3/versions?pageSize=100&orderBy=ID&sortOrder=DESC&nextPageToken=" \
183183
-H 'accept: application/json' | jq
184184
{
185185
"items": [
@@ -200,7 +200,7 @@ curl --silent -X 'GET' \
200200
}
201201
202202
curl --silent -X 'GET' \
203-
"$MR_HOSTNAME/api/model_registry/v1alpha2/model_versions/4/artifacts" \
203+
"$MR_HOSTNAME/api/model_registry/v1alpha3/model_versions/4/artifacts" \
204204
-H 'accept: application/json' | jq
205205
{
206206
"items": [
@@ -247,7 +247,7 @@ resulting in:
247247

248248
```
249249
curl --silent -X 'GET' \
250-
"$MR_HOSTNAME/api/model_registry/v1alpha2/registered_models/5" \
250+
"$MR_HOSTNAME/api/model_registry/v1alpha3/registered_models/5" \
251251
-H 'accept: application/json' | jq
252252
{
253253
"createTimeSinceEpoch": "1707765990857",
@@ -259,7 +259,7 @@ curl --silent -X 'GET' \
259259
}
260260
261261
curl --silent -X 'GET' \
262-
"$MR_HOSTNAME/api/model_registry/v1alpha2/registered_models/5/versions?pageSize=100&orderBy=ID&sortOrder=DESC&nextPageToken=" \
262+
"$MR_HOSTNAME/api/model_registry/v1alpha3/registered_models/5/versions?pageSize=100&orderBy=ID&sortOrder=DESC&nextPageToken=" \
263263
-H 'accept: application/json' | jq
264264
{
265265
"items": [
@@ -290,7 +290,7 @@ curl --silent -X 'GET' \
290290
}
291291
292292
curl --silent -X 'GET' \
293-
"$MR_HOSTNAME/api/model_registry/v1alpha2/model_versions/6/artifacts" \
293+
"$MR_HOSTNAME/api/model_registry/v1alpha3/model_versions/6/artifacts" \
294294
-H 'accept: application/json' | jq
295295
{
296296
"items": [
@@ -362,7 +362,7 @@ resulting in:
362362

363363
```
364364
curl --silent -X 'GET' \
365-
"$MR_HOSTNAME/api/model_registry/v1alpha2/registered_models/7" \
365+
"$MR_HOSTNAME/api/model_registry/v1alpha3/registered_models/7" \
366366
-H 'accept: application/json' | jq
367367
{
368368
"createTimeSinceEpoch": "1707766117250",
@@ -374,7 +374,7 @@ curl --silent -X 'GET' \
374374
}
375375
376376
curl --silent -X 'GET' \
377-
"$MR_HOSTNAME/api/model_registry/v1alpha2/registered_models/7/versions?pageSize=100&orderBy=ID&sortOrder=DESC&nextPageToken=" \
377+
"$MR_HOSTNAME/api/model_registry/v1alpha3/registered_models/7/versions?pageSize=100&orderBy=ID&sortOrder=DESC&nextPageToken=" \
378378
-H 'accept: application/json' | jq
379379
{
380380
"items": [
@@ -395,7 +395,7 @@ curl --silent -X 'GET' \
395395
}
396396
397397
curl --silent -X 'GET' \
398-
"$MR_HOSTNAME/api/model_registry/v1alpha2/model_versions/8/artifacts" \
398+
"$MR_HOSTNAME/api/model_registry/v1alpha3/model_versions/8/artifacts" \
399399
-H 'accept: application/json' | jq
400400
{
401401
"items": [

‎internal/ml_metadata/proto/metadata_store.pb.go‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎internal/ml_metadata/proto/metadata_store_service.pb.go‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎internal/ml_metadata/proto/metadata_store_service_grpc.pb.go‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)