require name when creating serving environment (kubeflow#868)

* require name when creating serving env

Signed-off-by: Adysen Rothman <[email protected]>

* add req field to create

Signed-off-by: Adysen Rothman <[email protected]>

* make clean install tidy python

Signed-off-by: Adysen Rothman <[email protected]>

* resolve poetry formatting diffs

Signed-off-by: Adysen Rothman <[email protected]>

---------

Signed-off-by: Adysen Rothman <[email protected]>

Author: adysenrothman

api/openapi/model-registry.yaml

@@ -1687,9 +1687,16 @@ components:
         - $ref: "#/components/schemas/BaseResourceUpdate"
     ServingEnvironmentCreate:
       description: A Model Serving environment for serving `RegisteredModels`.
+      required:
+      - name
       allOf:
         - $ref: "#/components/schemas/BaseResourceCreate"
         - $ref: "#/components/schemas/ServingEnvironmentUpdate"
+        - type: object  
+          properties:
+            name:
+              description: The name of the ServingEnvironment.
+              type: string  
     InferenceService:
       description: >-
         An `InferenceService` entity in a `ServingEnvironment` represents a deployed `ModelVersion` from a `RegisteredModel` created by Model Serving.

clients/python/src/mr_openapi/models/serving_environment.py

@@ -35,10 +35,7 @@ class ServingEnvironment(BaseModel):
         description="The external id that come from the clients’ system. This field is optional. If set, it must be unique among all resources within a database instance.",
         alias="externalId",
     )
-    name: StrictStr | None = Field(
-        default=None,
-        description="The client provided name of the artifact. This field is optional. If set, it must be unique among all the artifacts of the same artifact type within a database instance and cannot be changed once set.",
-    )
+    name: StrictStr = Field(description="The name of the ServingEnvironment.")
     id: StrictStr | None = Field(default=None, description="The unique server generated id of the resource.")
     create_time_since_epoch: StrictStr | None = Field(
         default=None,

clients/python/src/mr_openapi/models/serving_environment_create.py

@@ -35,10 +35,7 @@ class ServingEnvironmentCreate(BaseModel):
         description="The external id that come from the clients’ system. This field is optional. If set, it must be unique among all resources within a database instance.",
         alias="externalId",
     )
-    name: StrictStr | None = Field(
-        default=None,
-        description="The client provided name of the artifact. This field is optional. If set, it must be unique among all the artifacts of the same artifact type within a database instance and cannot be changed once set.",
-    )
+    name: StrictStr = Field(description="The name of the ServingEnvironment.")
     __properties: ClassVar[list[str]] = ["customProperties", "description", "externalId", "name"]
 
     model_config = ConfigDict(

internal/converter/generated/mlmd_openapi_converter.gen.go

@@ -48,7 +48,7 @@ type MLMDToOpenAPIConverter interface {
 	// goverter:map Properties Description | MapDescription
 	ConvertDocArtifact(source *proto.Artifact) (*openapi.DocArtifact, error)
 
-	// goverter:map Name | MapNameFromOwned
+	// goverter:map Name | MapName
 	// goverter:map Properties Description | MapDescription
 	ConvertServingEnvironment(source *proto.Context) (*openapi.ServingEnvironment, error)
 

internal/converter/generated/openapi_converter.gen.go

@@ -104,7 +104,7 @@ func TestMapFromModelArtifactsEmpty(t *testing.T) {
 func TestMapFromServingEnvironment(t *testing.T) {
 	assertion, m := setup(t)
 
-	ctx, err := m.MapFromServingEnvironment(&openapi.ServingEnvironment{Name: of("Env")})
+	ctx, err := m.MapFromServingEnvironment(&openapi.ServingEnvironment{Name: *of("Env")})
 	assertion.Nil(err)
 	assertion.Equal("Env", ctx.GetName())
 	assertion.Equal(servingEnvironmentTypeId, ctx.GetTypeId())

internal/converter/generated/openapi_mlmd_converter.gen.go

@@ -815,6 +815,15 @@ func AssertServingEnvironmentCreateConstraints(obj model.ServingEnvironmentCreat
 
 // AssertServingEnvironmentCreateRequired checks if the required fields are not zero-ed
 func AssertServingEnvironmentCreateRequired(obj model.ServingEnvironmentCreate) error {
+	elements := map[string]interface{}{
+		"name": obj.Name,
+	}
+	for name, el := range elements {
+		if isZero := IsZeroValue(el); isZero {
+			return &RequiredError{Field: name}
+		}
+	}
+
 	return nil
 }
 
@@ -847,6 +856,15 @@ func AssertServingEnvironmentListRequired(obj model.ServingEnvironmentList) erro
 
 // AssertServingEnvironmentRequired checks if the required fields are not zero-ed
 func AssertServingEnvironmentRequired(obj model.ServingEnvironment) error {
+	elements := map[string]interface{}{
+		"name": obj.Name,
+	}
+	for name, el := range elements {
+		if isZero := IsZeroValue(el); isZero {
+			return &RequiredError{Field: name}
+		}
+	}
+
 	return nil
 }
 

internal/converter/mlmd_openapi_converter.go

@@ -172,11 +172,11 @@ func (suite *CoreTestSuite) registerModel(service api.ModelRegistryApi, override
 }
 
 // utility function that register a new simple ServingEnvironment and return its ID
-func (suite *CoreTestSuite) registerServingEnvironment(service api.ModelRegistryApi, overrideName *string, overrideExternalId *string) string {
+func (suite *CoreTestSuite) registerServingEnvironment(service api.ModelRegistryApi, overrideName string, overrideExternalId *string) string {
 	eutName := "Simple ServingEnvironment"
 	eutExtID := "Simple ServingEnvironment ExtID"
 	eut := &openapi.ServingEnvironment{
-		Name:        &eutName,
+		Name:        eutName,
 		ExternalId:  &eutExtID,
 		Description: &entityDescription,
 		CustomProperties: &map[string]openapi.MetadataValue{
@@ -186,7 +186,7 @@ func (suite *CoreTestSuite) registerServingEnvironment(service api.ModelRegistry
 		},
 	}
 
-	if overrideName != nil {
+	if overrideName != "" {
 		eut.Name = overrideName
 	}
 
@@ -233,7 +233,7 @@ func (suite *CoreTestSuite) registerModelVersion(
 }
 
 // utility function that register a new simple ServingEnvironment and return its ID
-func (suite *CoreTestSuite) registerInferenceService(service api.ModelRegistryApi, registerdModelId string, overrideParentResourceName *string, overrideParentResourceExternalId *string, overrideName *string, overrideExternalId *string) string {
+func (suite *CoreTestSuite) registerInferenceService(service api.ModelRegistryApi, registerdModelId string, overrideParentResourceName string, overrideParentResourceExternalId *string, overrideName *string, overrideExternalId *string) string {
 	servingEnvironmentId := suite.registerServingEnvironment(service, overrideParentResourceName, overrideParentResourceExternalId)
 
 	eutName := "simpleInferenceService"