refactor(api): notification event payload #1239
Conversation
chrisgacsal
added
kind/feature
chrisgacsal
force-pushed
the
notifications-api-spec
branch
from
29e9c3a to
a8c62d3
Compare
| $ref: "#/components/schemas/Feature" | ||
| subject: | ||
| $ref: "#/components/schemas/Subject" | ||
| balance: |
There was a problem hiding this comment.
Isn't there a balance type, EntitlementValue?
There was a problem hiding this comment.
So I was kinda hasitant to use EntitlementValue directly as it is shared across all the entitlement types meaning it has fields for all teh entitlement types while we only need metered here. So it might be confusing for users to see optinal fields in the spec which will be never used for entitlements.balance.threshold payload.
It would be awesome to have entitlement specific Entitlement[Metered|Static|Boolean]Value resources in the spec to support better reusability, but making this type of change out of scope for this PR.
So I am ok with using EntitlementValue here, but I'd improve on this at some point to make the API spec more clean.
Add type specification for notification event payload instead of keeping it as a free form object.
chrisgacsal
force-pushed
the
notifications-api-spec
branch
from
a8c62d3 to
05dde5b
Compare
Overview
Add notification event type playload to the OepnAPI specification. Currently only payload for notifications with
entitlements.balance.thresholdtype is supported.