Skip to content

Conversation

@jischr
Copy link
Contributor

@jischr jischr commented Mar 31, 2025

Added event_metadata to CAEP and RISC for the transmitter to provide additional information about the event itself.

Fixes #221

@jischr jischr requested a review from a team as a code owner March 31, 2025 23:05
Copy link
Contributor

@appsdesh appsdesh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • what does it mean by action?
  • how would we prevent bloating?
  • Why are we singling this out "This claim SHOULD not be used to express information about
    the subject." needs more concrete guidance

@jischr
Copy link
Contributor Author

jischr commented Apr 1, 2025

@appsdesh

  • what does it mean by action?
  • that wording was taken from the issue. happy to remove or replace if it doesnt suit.
  • how would we prevent bloating?
  • I don't believe we need to prevent bloating as SETs do not have restrictions in place for event claims. if necessary, we could put restrictions on string length.
  • Why are we singling this out "This claim SHOULD not be used to express information about
    the subject." needs more concrete guidance
  • We need to differentiate the this claim for other claims that could have been added to the individual event schemas (that describes the subject). this is metadata. Guidance could be added to prevent this claim from becoming out of hand.

@iamseanodentity
Copy link
Contributor

"action" here is needed, but we do not need to call it out in the description. In the event_metadata field it is setting the foundation to expand upon profile events that might be mandatory via a contract between the transmitter and receiver.

We need guidelines for this and a use case with event_metadata details.

  • Don't overload this claim (size considerations of the JWT)
  • Don't add in subject based information and keep it siloed to the event itself (i.e. correlation_id, enriched meta data info)
  • Why and When to use it

Copy link
Contributor

@appsdesh appsdesh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New changes look good. Suggesting a nit to remove redundant event from the key

occurred. Its value is a JSON number representing the number of seconds
from 1970-01-01T0:0:0Z as measured in UTC until the date/time.

event_metadata
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
event_metadata
metadata

<t>The following claims are optional unless otherwise specified in the event type definition.

<list style="symbols">
<t>event_metadata - optional, JSON object,metadata specific to the event provided by the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<t>event_metadata - optional, JSON object,metadata specific to the event provided by the
<t>metadata - optional, JSON object,metadata specific to the event provided by the

@tulshi tulshi added the v1Final Issues that must be fixed before we propose a spec to become a v1 final spec. label Apr 11, 2025
@jischr
Copy link
Contributor Author

jischr commented Apr 15, 2025

@iamseanodentity do you can an example of this you can supply?

@iamseanodentity
Copy link
Contributor

@iamseanodentity do you can an example of this you can supply?

I will get to this tonight. Would you like me to add inline or just here and you can handle the copy?

@jischr
Copy link
Contributor Author

jischr commented Apr 22, 2025

decided against this 4/15

@jischr jischr closed this Apr 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

v1Final Issues that must be fixed before we propose a spec to become a v1 final spec.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Addition of Event data field inside events

5 participants