Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Event View Model Details schema for validation and documentation #13

Merged
merged 6 commits into from
Sep 6, 2024

Conversation

remi00
Copy link
Collaborator

@remi00 remi00 commented Aug 30, 2024

What it does?

  • Event View Model Details schema with possible detail types, describing all their important information
  • Use that schema for creating documentation Markdown for users reference
  • Test it to make sure future updates don't break it

What else is worth noting?

  • This is missing piece to EventViewModel approach for handling notification request that addresses all recent challenges:
    • The flexibility of the EVM which is helpful in combining the data model for various notification sources made it easy that format of notifications could break when some detail type or value changed.
    • There was missing full documentation of all possible details that users could use for notifications.
  • Next step: define all other missing EventViewModel details, mostly for synthetics
  • See also Notify PR: https://github.com/kentik/notify/pull/341

Overview

image

@remi00 remi00 self-assigned this Aug 30, 2024
durakup
durakup previously approved these changes Sep 6, 2024
Copy link

@durakup durakup left a comment

Choose a reason for hiding this comment

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

Lgtm!

zamkot
zamkot previously approved these changes Sep 6, 2024
elodszopos
elodszopos previously approved these changes Sep 6, 2024
Copy link

@elodszopos elodszopos left a comment

Choose a reason for hiding this comment

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

Beautiful!

@rchapin
Copy link
Contributor

rchapin commented Sep 6, 2024

Are the "Example values" and "Value schema" columns mixed up?
image

@remi00 remi00 dismissed stale reviews from elodszopos, zamkot, and durakup via 8349212 September 6, 2024 15:07
@remi00
Copy link
Collaborator Author

remi00 commented Sep 6, 2024

Are the "Example values" and "Value schema" columns mixed up?

You are right they were mixed up 👍

@remi00 remi00 requested a review from elodszopos September 6, 2024 15:08
@remi00 remi00 merged commit 1dd1bbd into main Sep 6, 2024
1 check passed
@remi00 remi00 deleted the remi-detail-schemas branch September 6, 2024 15:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants