[Schema Inaccuracy] Repository Vulnerability Alert's webhook create action missing lots of fields for Organization, Repository, and Sender

オープン
#5,838 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
48/100
issue の種類
バグ
明瞭さ
おおむね明確
活発さ
静か
技術スタック
openapi
領域
api

調査の方向性

まず、OpenAPI 仕様の Repository、Organization、Sender の定義を、他の webhook イベントで使用されているものと比較します。提供されている場合は、利用可能な webhook payload の例を確認します。仕様と発行された Repository Vulnerability Alert payload が記載されたフィールドで一致すれば完了ですが、どちらを変更すべきかは issue では未解決のままです。

索引モデルが issue の本文から書いたものです。

説明

feature

Schema Inaccuracy

Repository only seems to contain id, node_id, name, full_name, private, owner (also missing a bunch of things), html_url, description, fork, and default_branch. The other actions provide many more things.
Organization only seems to contain login, id, node_id, url, avatar_url, and description. Compared to other events, it's missing repos_url, events_url, hooks_url, issues_url, members_url, and public_members_url.
Sender only seems to contain login, id, node_id, avatar_url, type, and site_admin. Compared to other events, it's missing gravatar_id, url, html_url, followers_url, following_url, gists_url, starred_url, subscriptions_url, organizations_url, repos_url, events_url, received_events_url, and user_view_type.

Expected

The spec has definitions for these, but it's not sent. Either the spec needs to be updated or what sends needs to be updated; I don't really care which.

Reproduction Steps

I can get webhook payload examples if needed, but unlike REST API, this is a bit harder to reproduce at will.

主要言語
言語のデータがありません
スター
1.6k
フォーク
342
平均マージ
3時間 33分
マージ済み PR(30日)
51

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

github/rest-api-description のほかの issue

github/rest-api-description の issue をすべて見る

似ている issue

Backend & API Design の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。