Skip to content

Commit

Permalink
feat(openapi): make items a required field in List requests (#797)
Browse files Browse the repository at this point in the history
Signed-off-by: Alessio Pragliola <[email protected]>
  • Loading branch information
Al-Pragliola authored Feb 13, 2025
1 parent 550e294 commit 2b1b4d6
Show file tree
Hide file tree
Showing 16 changed files with 98 additions and 140 deletions.
14 changes: 14 additions & 0 deletions api/openapi/model-registry.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1225,6 +1225,8 @@ components:
type: array
items:
$ref: "#/components/schemas/ModelVersion"
required:
- items
- $ref: "#/components/schemas/BaseResourceList"
ModelArtifactList:
description: List of ModelArtifact entities.
Expand All @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -1612,6 +1618,8 @@ components:
items:
$ref: "#/components/schemas/ServingEnvironment"
readOnly: false
required:
- items
- $ref: "#/components/schemas/BaseResourceList"
RegisteredModelList:
description: List of RegisteredModels.
Expand All @@ -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`.
Expand Down Expand Up @@ -1656,6 +1666,8 @@ components:
items:
$ref: "#/components/schemas/InferenceService"
readOnly: false
required:
- items
- $ref: "#/components/schemas/BaseResourceList"
ServeModelList:
description: List of ServeModel entities.
Expand All @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion clients/python/src/mr_openapi/models/artifact_list.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class ArtifactList(BaseModel):
)
page_size: StrictInt = Field(description="Maximum number of resources to return in the result.", alias="pageSize")
size: StrictInt = Field(description="Number of items in result list.")
items: list[Artifact] | None = Field(default=None, description="Array of `Artifact` entities.")
items: list[Artifact] = Field(description="Array of `Artifact` entities.")
__properties: ClassVar[list[str]] = ["nextPageToken", "pageSize", "size", "items"]

model_config = ConfigDict(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class InferenceServiceList(BaseModel):
)
page_size: StrictInt = Field(description="Maximum number of resources to return in the result.", alias="pageSize")
size: StrictInt = Field(description="Number of items in result list.")
items: list[InferenceService] | None = None
items: list[InferenceService]
__properties: ClassVar[list[str]] = ["nextPageToken", "pageSize", "size", "items"]

model_config = ConfigDict(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class ModelArtifactList(BaseModel):
)
page_size: StrictInt = Field(description="Maximum number of resources to return in the result.", alias="pageSize")
size: StrictInt = Field(description="Number of items in result list.")
items: list[ModelArtifact] | None = Field(default=None, description="Array of `ModelArtifact` entities.")
items: list[ModelArtifact] = Field(description="Array of `ModelArtifact` entities.")
__properties: ClassVar[list[str]] = ["nextPageToken", "pageSize", "size", "items"]

model_config = ConfigDict(
Expand Down
2 changes: 1 addition & 1 deletion clients/python/src/mr_openapi/models/model_version_list.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class ModelVersionList(BaseModel):
)
page_size: StrictInt = Field(description="Maximum number of resources to return in the result.", alias="pageSize")
size: StrictInt = Field(description="Number of items in result list.")
items: list[ModelVersion] | None = Field(default=None, description="Array of `ModelVersion` entities.")
items: list[ModelVersion] = Field(description="Array of `ModelVersion` entities.")
__properties: ClassVar[list[str]] = ["nextPageToken", "pageSize", "size", "items"]

model_config = ConfigDict(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class RegisteredModelList(BaseModel):
)
page_size: StrictInt = Field(description="Maximum number of resources to return in the result.", alias="pageSize")
size: StrictInt = Field(description="Number of items in result list.")
items: list[RegisteredModel] | None = None
items: list[RegisteredModel]
__properties: ClassVar[list[str]] = ["nextPageToken", "pageSize", "size", "items"]

model_config = ConfigDict(
Expand Down
2 changes: 1 addition & 1 deletion clients/python/src/mr_openapi/models/serve_model_list.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class ServeModelList(BaseModel):
)
page_size: StrictInt = Field(description="Maximum number of resources to return in the result.", alias="pageSize")
size: StrictInt = Field(description="Number of items in result list.")
items: list[ServeModel] | None = Field(default=None, description="Array of `ModelArtifact` entities.")
items: list[ServeModel] = Field(description="Array of `ModelArtifact` entities.")
__properties: ClassVar[list[str]] = ["nextPageToken", "pageSize", "size", "items"]

model_config = ConfigDict(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class ServingEnvironmentList(BaseModel):
)
page_size: StrictInt = Field(description="Maximum number of resources to return in the result.", alias="pageSize")
size: StrictInt = Field(description="Number of items in result list.")
items: list[ServingEnvironment] | None = None
items: list[ServingEnvironment]
__properties: ClassVar[list[str]] = ["nextPageToken", "pageSize", "size", "items"]

model_config = ConfigDict(
Expand Down
7 changes: 7 additions & 0 deletions internal/server/openapi/type_asserts.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ func AssertArtifactListRequired(obj model.ArtifactList) error {
"nextPageToken": obj.NextPageToken,
"pageSize": obj.PageSize,
"size": obj.Size,
"items": obj.Items,
}
for name, el := range elements {
if isZero := IsZeroValue(el); isZero {
Expand Down Expand Up @@ -289,6 +290,7 @@ func AssertInferenceServiceListRequired(obj model.InferenceServiceList) error {
"nextPageToken": obj.NextPageToken,
"pageSize": obj.PageSize,
"size": obj.Size,
"items": obj.Items,
}
for name, el := range elements {
if isZero := IsZeroValue(el); isZero {
Expand Down Expand Up @@ -513,6 +515,7 @@ func AssertModelArtifactListRequired(obj model.ModelArtifactList) error {
"nextPageToken": obj.NextPageToken,
"pageSize": obj.PageSize,
"size": obj.Size,
"items": obj.Items,
}
for name, el := range elements {
if isZero := IsZeroValue(el); isZero {
Expand Down Expand Up @@ -579,6 +582,7 @@ func AssertModelVersionListRequired(obj model.ModelVersionList) error {
"nextPageToken": obj.NextPageToken,
"pageSize": obj.PageSize,
"size": obj.Size,
"items": obj.Items,
}
for name, el := range elements {
if isZero := IsZeroValue(el); isZero {
Expand Down Expand Up @@ -674,6 +678,7 @@ func AssertRegisteredModelListRequired(obj model.RegisteredModelList) error {
"nextPageToken": obj.NextPageToken,
"pageSize": obj.PageSize,
"size": obj.Size,
"items": obj.Items,
}
for name, el := range elements {
if isZero := IsZeroValue(el); isZero {
Expand Down Expand Up @@ -758,6 +763,7 @@ func AssertServeModelListRequired(obj model.ServeModelList) error {
"nextPageToken": obj.NextPageToken,
"pageSize": obj.PageSize,
"size": obj.Size,
"items": obj.Items,
}
for name, el := range elements {
if isZero := IsZeroValue(el); isZero {
Expand Down Expand Up @@ -823,6 +829,7 @@ func AssertServingEnvironmentListRequired(obj model.ServingEnvironmentList) erro
"nextPageToken": obj.NextPageToken,
"pageSize": obj.PageSize,
"size": obj.Size,
"items": obj.Items,
}
for name, el := range elements {
if isZero := IsZeroValue(el); isZero {
Expand Down
29 changes: 10 additions & 19 deletions pkg/openapi/model_artifact_list.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

29 changes: 10 additions & 19 deletions pkg/openapi/model_inference_service_list.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 2b1b4d6

Please sign in to comment.