feat: Add description field to the OSResource in Inventory, REST API and OSProfile (#3)

Co-authored-by: PalashGoelIntel <palash.goel@intel.com>

Author: daniele-moro

api/api/openapi/edge-infrastructure-manager-openapi-all.yaml

@@ -5996,6 +5996,11 @@ components:
           type: string
           maxLength: 128
           pattern: '^[a-zA-Z-_0-9. ()]+$'
+        description:
+          description: The OS resource's description.
+          type: string
+          maxLength: 1000
+          pattern: '^$|^[a-zA-Z-_0-9.:;=@?!#,<>*(){}&%$`^+- ]+$'
         architecture:
           description: The OS resource's architecture.
           title: architecture

api/api/openapi/schemas/os.yaml

@@ -44,6 +44,11 @@ OperatingSystemResource:
       type: string
       maxLength: 128
       pattern: '^[a-zA-Z-_0-9. ()]+$'
+    description:
+      description: "The OS resource's description."
+      type: string
+      maxLength: 1000
+      pattern: '^$|^[a-zA-Z-_0-9.:;=@?!#,<>*(){}&%$`^+- ]+$'
     architecture:
       description: "The OS resource's architecture."
       title: "architecture"

api/go.mod

@@ -5,6 +5,8 @@ module github.com/open-edge-platform/infra-core/api
 
 go 1.24.1
 
+replace github.com/open-edge-platform/infra-core/inventory/v2 => ../inventory
+
 require (
 	github.com/getkin/kin-openapi v0.132.0
 	github.com/go-openapi/strfmt v0.23.0

api/go.sum

@@ -1025,8 +1025,6 @@ github.com/oasdiff/yaml3 v0.0.0-20250309153720-d2182401db90 h1:bQx3WeLcUWy+RletI
 github.com/oasdiff/yaml3 v0.0.0-20250309153720-d2182401db90/go.mod h1:y5+oSEHCPT/DGrS++Wc/479ERge0zTFxaF8PbGKcg2o=
 github.com/oklog/ulid v1.3.1 h1:EGfNDEx6MqHz8B3uNV6QAib1UR2Lm97sHi3ocA6ESJ4=
 github.com/oklog/ulid v1.3.1/go.mod h1:CirwcVhetQ6Lv90oh/F+FBtV6XMibvdAFo93nm5qn4U=
-github.com/open-edge-platform/infra-core/inventory/v2 v2.24.0 h1:ZYt0WXCpLxpxa75UW/DkE5box9Wze8BoIfqZhcE9e0A=
-github.com/open-edge-platform/infra-core/inventory/v2 v2.24.0/go.mod h1:j7n+k3Iy7oG2m79YtCaNKL+Br2IKMHVLVICs8MorCY8=
 github.com/open-edge-platform/orch-library/go v0.6.1 h1:IGR2ic73f3obnhlxTRfHcyYMbPbYu7BSqa9UYyEZ78Q=
 github.com/open-edge-platform/orch-library/go v0.6.1/go.mod h1:3Tes/GJfwYbnQa/1scbKiLbjZrL4fJEouFk28oo5/c8=
 github.com/open-edge-platform/orch-library/go/dazl v0.5.4 h1:Rx/bSAZiLjEEBjUiJEzBvT0fQv5huT5FQ2Ke3IMUhiE=

api/internal/worker/handlers/invhandlers/os.go

@@ -26,6 +26,7 @@ var OpenAPIOSResourceToProto = map[string]string{
 	"kernelCommand":     osv1.OperatingSystemResourceFieldKernelCommand,
 	"updateSources":     osv1.OperatingSystemResourceFieldUpdateSources,
 	"installedPackages": osv1.OperatingSystemResourceFieldInstalledPackages,
+	"description":       osv1.OperatingSystemResourceFieldDescription,
 }
 
 // OpenAPIOSToProtoExcluded defines exclusion rules as there are some fields
@@ -409,6 +410,10 @@ func openapiToGrpcOSResource(body *api.OperatingSystemResource) (*osv1.Operating
 		os.Name = *body.Name
 	}
 
+	if body.Description != nil {
+		os.Description = *body.Description
+	}
+
 	if body.Architecture != nil {
 		os.Architecture = *body.Architecture
 	}
@@ -465,6 +470,7 @@ func grpcToOpenAPIOSResource(
 ) *api.OperatingSystemResource {
 	resID := os.GetResourceId()
 	resName := os.GetName()
+	description := os.GetDescription()
 	kernel := os.GetKernelCommand()
 	arch := os.GetArchitecture()
 	sources := os.GetUpdateSources()
@@ -482,6 +488,7 @@ func grpcToOpenAPIOSResource(
 	obj := api.OperatingSystemResource{
 		OsResourceID:      &resID,
 		Name:              &resName,
+		Description:       &description,
 		KernelCommand:     &kernel,
 		Architecture:      &arch,
 		UpdateSources:     sources,

api/pkg/api/v0/edge-infrastructure-manager-openapi-server.gen.go

@@ -75,6 +75,10 @@ run:
   go: ""
 
 linters-settings:
+  gomoddirectives:
+    replace-local: true
+    replace-allow-list:
+      - github.com/open-edge-platform/infra-core/inventory
   depguard:
     rules:
       main:

api/pkg/api/v0/edge-infrastructure-manager-openapi-types.gen.go

@@ -1 +1 @@
-0.0.3
+0.0.4-dev

apiv2/.golangci.yml

@@ -4146,6 +4146,10 @@ components:
                     pattern: ^$|^[a-zA-Z-_0-9./:;=@?!#,<>*()"\ ]+$
                     type: string
                     description: A unique identifier of the OS image that can be retrieved from the running OS.
+                description:
+                    maxLength: 1000
+                    pattern: ^$|^[a-zA-Z-_0-9.:;=@?!#,<>*(){}&%$`^\+\- ]+$
+                    type: string
                 sha256:
                     maxLength: 64
                     minLength: 64