feat: various fixes and improvements to schemas #264

wolfy1339 · 2021-01-11T23:15:14Z

No description provided.

…event

gr2m

Wow these changes look great!

…uest` events

Sets it to either `string`, `null` or both depending on the event

Sets it to either `enum` or `null` depending on the event type

…oved` payload example

Removes the `changes` property from non-`edit` event actions and completes the properties with information from the docs

This way we can set the repository as private, archived or unarchived, all depending on the event

In some events, properties are set to one boolean value but not the other, for example when the `issue.locked` event is sent, the `locked` property will be set to `false`.

wolfy1339 · 2021-01-12T03:47:10Z

@G-Rath If you could review this as well. I've done a lot of changes, just want you to confirm everything will work as intended especially once they get converted to TS types

oscard0m

This is A-W-E-S-O-M-E! I'm super excited about all the power these changes landing to webhooks. Congrats to everybody 😍

G-Rath · 2021-01-12T17:40:52Z

@G-Rath If you could review this as well.

Sure thing - I'll try to get to sometime this week (works a bit busy right now, so might have to wait a couple of days)

wolfy1339 · 2021-01-13T19:50:45Z

The openapi spec for the rest api shares a lot of properties with these shemas.
Later on, we could try and use it as the source of truth where possible.

Ref: github/rest-api-description#74

oscard0m · 2021-01-13T20:09:21Z

The openapi spec for the rest api shares a lot of properties with these shemas.
Later on, we could try and use it as the source of truth where possible.

Agree on that.

Should we create an issue to follow up this?

wolfy1339 · 2021-01-13T20:10:40Z

Should we create an issue to follow up this?

Yes, for sure.

…` event

Uses `null` for `star.deleted` and `string` for `star.created`

G-Rath

Overall looks good.

I'll need to do some checking on how the enum: [true] and allOfs come out, but I don't think they'll be any real trouble.

There are a few optimizations you can make, but I've started committing my optimize-schema script which'll handle them automatically.

I'm happy if you want to merge this :)

wolfy1339 · 2021-01-13T22:36:20Z

I'm noticing a lot of events have missing schemas & payload examples for the different actions

octokitbot · 2021-01-13T22:41:44Z

🎉 This PR is included in version 3.33.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

oscard0m · 2021-01-13T23:01:31Z

I'm noticing a lot of events have missing schemas & payload examples for the different actions

Should we create an issue for this? Would have sense to tackle it in #266? @wolfy1339 @G-Rath

wolfy1339 added 4 commits January 11, 2021 17:35

fix: head_branch property can be null or string

d648bbd

feat: use an enum for author_association

c857790

feat: add types for commits and head_commit properties in push …

799c1ca

…event

feat: add active_lock_reason where missing

e778cf0

wolfy1339 added the Type: Feature New feature or request label Jan 11, 2021

wolfy1339 force-pushed the update-schemas branch from c29bcd4 to debed86 Compare January 11, 2021 23:23

gr2m approved these changes Jan 11, 2021

View reviewed changes

wolfy1339 added 10 commits January 11, 2021 22:29

feat: use an enum for the repository_selection property

b77dcb3

feat: add types for the labels property where missing

a6632af

feat: use an enum for the state property of issue and `pull_req…

4a53dff

…uest` events

feat: update closed_at property

5837ffe

Sets it to either `string`, `null` or both depending on the event

feat: update active_lock_reason property

eb3ad65

Sets it to either `enum` or `null` depending on the event type

feat: update merged_at and merge_commit_sha properties

b8a874e

fix: property sender is not required on the ping event

ebf82d9

feat: use an enum for the ref_type property of create events

a9c3dcd

fix: add missing node_id property to `installation_repositories.rem…

7a48c21

…oved` payload example

fix: organization property is not required

436f534

wolfy1339 force-pushed the update-schemas branch from debed86 to 534feef Compare January 12, 2021 03:29

feat: Add better types for the changes property

3b9613a

Removes the `changes` property from non-`edit` event actions and completes the properties with information from the docs

wolfy1339 force-pushed the update-schemas branch from 534feef to 545e3a1 Compare January 12, 2021 03:35

wolfy1339 added 7 commits January 11, 2021 22:37

feat: use allOf to extend repository schema

bbdb868

This way we can set the repository as private, archived or unarchived, all depending on the event

feat: mark dismisser, dismiss_reason and dismissed_at as required

4f2ddf4

fix: the body of a release can be either null or string

ca41431

feat: use an enum in conjunction with boolean

df49ec3

In some events, properties are set to one boolean value but not the other, for example when the `issue.locked` event is sent, the `locked` property will be set to `false`.

feat: add schema for installation unsuspended and suspended

359432c

fix: the scope property in the membership events can only be team

9ca9d92

fix: member_invited replace membership property with invitation

3448a4f

wolfy1339 force-pushed the update-schemas branch from 545e3a1 to 3448a4f Compare January 12, 2021 03:37

wolfy1339 requested a review from G-Rath January 12, 2021 03:39

oscard0m approved these changes Jan 12, 2021

View reviewed changes

feat: update author_association enum

fa9d4ec

Ref: github/rest-api-description#74

wolfy1339 added 4 commits January 13, 2021 15:28

feat: update enum for the verification.reason property in `status…

7548ba0

…` event

feat: better types for the changes property

85a207b

fix: remove the effective_date property where extraneous

51f88a1

feat: update starred_at property with better types

54c7d87

Uses `null` for `star.deleted` and `string` for `star.created`

G-Rath approved these changes Jan 13, 2021

View reviewed changes

wolfy1339 added 6 commits January 13, 2021 16:58

feat: add schemas for secret_scanning_alert

24422b8

lint: run prettier

d2adafe

fix: the repository and sender properties are required

f2e1dce

feat: add types for the items in the release assets array

509a3d4

feat: add changes property to release.edited

a4efdae

fix: Add $id and title to the secret_scanning_alert schemas

8dd1f22

feat: add missing schemas for pull_request_review_comment

dcf30bf

wolfy1339 force-pushed the update-schemas branch from 49783ff to dcf30bf Compare January 13, 2021 22:38

wolfy1339 merged commit 124b0b2 into master Jan 13, 2021

wolfy1339 deleted the update-schemas branch January 13, 2021 22:40

octokitbot added the released label Jan 13, 2021

oscard0m mentioned this pull request Jan 13, 2021

Use GitHub's OpenAPI spec as source of truth for generating schemas #266

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: various fixes and improvements to schemas #264

feat: various fixes and improvements to schemas #264

wolfy1339 commented Jan 11, 2021

gr2m left a comment

wolfy1339 commented Jan 12, 2021

oscard0m left a comment

G-Rath commented Jan 12, 2021

wolfy1339 commented Jan 13, 2021

oscard0m commented Jan 13, 2021

wolfy1339 commented Jan 13, 2021

G-Rath left a comment

wolfy1339 commented Jan 13, 2021

octokitbot commented Jan 13, 2021

oscard0m commented Jan 13, 2021 •

edited

Loading

feat: various fixes and improvements to schemas #264

feat: various fixes and improvements to schemas #264

Conversation

wolfy1339 commented Jan 11, 2021

gr2m left a comment

Choose a reason for hiding this comment

wolfy1339 commented Jan 12, 2021

oscard0m left a comment

Choose a reason for hiding this comment

G-Rath commented Jan 12, 2021

wolfy1339 commented Jan 13, 2021

oscard0m commented Jan 13, 2021

wolfy1339 commented Jan 13, 2021

G-Rath left a comment

Choose a reason for hiding this comment

wolfy1339 commented Jan 13, 2021

octokitbot commented Jan 13, 2021

oscard0m commented Jan 13, 2021 • edited Loading

oscard0m commented Jan 13, 2021 •

edited

Loading