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

Document Webhook format #128

Open
n1ru4l opened this issue May 31, 2022 · 2 comments
Open

Document Webhook format #128

n1ru4l opened this issue May 31, 2022 · 2 comments
Labels
enhancement New feature or request that adds new things or value to Hive good first issue Good for newcomers help wanted Extra attention is needed

Comments

@n1ru4l
Copy link
Collaborator

n1ru4l commented May 31, 2022

There is no information on the shape of the Webhook payload in the docs: https://docs.graphql-hive.com/features/alerts-notifications#adding-a-channel

In addition to that, it could be helpful to have some kind of preview and "send test event" on the "Adding a Channel Page" and "Available Channels" table.
image

image

@kmcgill88
Copy link

https://the-guild.dev/graphql/hive/docs/management/projects#schema-changed-notification

It appears type SchemaChangedNotificationPayload has changed form.

I was expecting changes like this per the website.

changes: Array<{
    criticality: 'Breaking' | 'Dangerous' | 'Safe'
    message: string
    path?: string
}>

actual

{
    "type": "ENUM_VALUE_ADDED",
    "criticality": {
      "level": "DANGEROUS",
      "reason": "Adding an enum value may break existing clients that were not programming defensively against an added case when querying an enum."
    },
    "message": "Enum value 'FOO' was added to enum 'join__Graph'",
    "meta": {
      "enumName": "join__Graph",
      "addedEnumValueName": "FOO"
    },
    "path": "join__Graph.FOO"
}

@n1ru4l n1ru4l added enhancement New feature or request that adds new things or value to Hive help wanted Extra attention is needed good first issue Good for newcomers labels Nov 6, 2023
@kmcgill88
Copy link

It appears criticality has gone back to being a string and it's all uppercase. BREAKING not Breaking. In fact, it doesn't look like changes are defined at all on the interface. I'm happy to make a PR but failing to see where WebhookInput is created.

@theguild-bot theguild-bot mentioned this issue Jan 24, 2024
91 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request that adds new things or value to Hive good first issue Good for newcomers help wanted Extra attention is needed
Projects
Status: Q4 2022 – Oct-Dec
Development

No branches or pull requests

2 participants