Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

docs: correctly specifying which fields will be present in Webhook API responses

オープン
  • 何か問題がありますか？
#749 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

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

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
45/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
openapi
領域
api, documentation

調査の方向性

リンクされている「Get all webhooks」API ドキュメントから始め、対応する OpenAPI response schema を見つけてください。どの response fields が nullable ではなく存在することを意図されているかを確認し、そのうえで required fields が正確に表現されるようにドキュメントまたは schema を更新し、レンダリングされた API reference を検証してください。

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

説明

documentation

Request for updates in the documentation

  • [ ] New Documentation
  • [x] Updates to Existing Documentation

I was looking at the Get all webhooks API: https://www.alchemy.com/docs/data/webhooks/webhooks-api-endpoints/notify-api-endpoints/team-webhooks and noticed that all fields can be nullable.

Is this intented? Can we add required in OpenAPI spec, since in version v3.1.0 not adding required means it can be optional?

Image
主要言語
MDX
スター
8
フォーク
18
平均マージ
21時間 8分
マージ済み PR（30日）
45

環境構築

はじめの一歩

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

alchemyplatform/docs のほかの issue

alchemyplatform/docs の issue をすべて見る

似ている issue

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

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

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