Merge pull request #1609 from openmeterio/openapi-fixes

fix: make id in subject a required-readOnly field
openmeterio · Oct 2, 2024 · fb387b6 · fb387b6
2 parents b4a5836 + 1ecde8b
commit fb387b6
Show file tree

Hide file tree

Showing 8 changed files with 282 additions and 280 deletions.
diff --git a/api/api.gen.go b/api/api.gen.go
diff --git a/api/client/go/client.gen.go b/api/client/go/client.gen.go
diff --git a/api/openapi.yaml b/api/openapi.yaml
@@ -3331,9 +3331,7 @@ components:
       type: object
       description: A subject is a unique identifier for a user or entity.
       required:
-        # Validator doesn't obey required for readOnly properties
-        # See: https://github.com/stoplightio/spectral/issues/1274
-        # - id
+        - id
         - key
       additionalProperties: false
       properties:

diff --git a/openmeter/event/models/subject.go b/openmeter/event/models/subject.go
@@ -23,7 +23,7 @@ func (s SubjectKeyAndID) Validate() error {
 }
 
 type Subject struct {
-	Id                 *string                `json:"id"`
+	Id                 string                 `json:"id"`
 	Key                string                 `json:"key"`
 	DisplayName        *string                `json:"displayName,omitempty"`
 	Metadata           map[string]interface{} `json:"metadata"`

diff --git a/openmeter/notification/consumer/balancetreshold.go b/openmeter/notification/consumer/balancetreshold.go
@@ -175,7 +175,7 @@ func (b *BalanceThresholdEventHandler) createEvent(ctx context.Context, in creat
 		notification.AnnotationEventDedupeHash: in.DedupeHash,
 	}
 
-	if in.Snapshot.Subject.Id != nil && *in.Snapshot.Subject.Id != "" {
+	if in.Snapshot.Subject.Id != "" {
 		annotations[notification.AnnotationEventSubjectID] = in.Snapshot.Subject.Id
 	}
 

diff --git a/openmeter/notification/internal/rule.go b/openmeter/notification/internal/rule.go
@@ -68,7 +68,7 @@ func NewTestEventPayload(eventType notification.EventType) notification.EventPay
 				CurrentPeriodEnd:   convert.ToPointer(from),
 				CurrentPeriodStart: convert.ToPointer(to),
 				DisplayName:        convert.ToPointer("Test Subject 1"),
-				Id:                 convert.ToPointer("01J5AW0ZD6T8624PCK0Q5TYX71"),
+				Id:                 "01J5AW0ZD6T8624PCK0Q5TYX71",
 				Key:                "test-subject-1",
 				Metadata: &map[string]interface{}{
 					"test-metadata-key": "test-metadata-value",

diff --git a/openmeter/server/server.go b/openmeter/server/server.go
@@ -100,6 +100,10 @@ func NewServer(config *Config) (*Server, error) {
 					// Unfortunately, the OpenAPI 3 filter library doesn't support context changes
 					AuthenticationFunc:  openapi3filter.NoopAuthenticationFunc,
 					SkipSettingDefaults: true,
+
+					// Excluding read-only validation because required and readOnly fields in our Go models are translated to non-nil fields, leading to a zero-value being passed to the API
+					// The OpenAPI spec says read-only fields SHOULD NOT be sent in requests, so technically it should be fine, hence disabling validation for now to make our life easier
+					ExcludeReadOnlyValidations: true,
 				},
 			}),
 		},

diff --git a/test/notification/event.go b/test/notification/event.go
@@ -64,7 +64,7 @@ func NewBalanceThresholdPayload() notification.EventPayload {
 				CurrentPeriodEnd:   &time.Time{},
 				CurrentPeriodStart: &time.Time{},
 				DisplayName:        nil,
-				Id:                 convert.ToPointer("01J4VD1XZH5HM705DCPB8XD5QD"),
+				Id:                 "01J4VD1XZH5HM705DCPB8XD5QD",
 				Key:                "customer-1",
 				Metadata:           nil,
 				StripeCustomerId:   nil,