Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

GET all webhooks API has incorrect schema definition

未关闭
#753 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
1/5
预计耗时
1 小时以内
新手友好度
52/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
停滞
技术栈
postman
领域
api, documentation

调研方向

从链接的 team webhooks 文档页面开始,将其中的 GET-all 响应示例与 issue 中显示的 Postman 响应进行比较。更新 schema 示例,使顶层为一个包含 data 数组的对象;当页面不再将响应描述为数组时即完成。

由索引模型根据 Issue 内容生成。

描述

documentation

Request for updates in the documentation

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

GET all webhooks API has incorrect schema definition

The documentation mentions it returns an Array: https://www.alchemy.com/docs/data/webhooks/webhooks-api-endpoints/notify-api-endpoints/team-webhooks

[
  {
    "data": [
      {
        "id": "foo",
        "network": "ETH_MAINNET",
        "webhook_type": "GRAPHQL",
        "webhook_url": "foo",
        "is_active": true,
        "time_created": 42,
        "addresses": [
          "foo"
        ],
        "version": "foo",
        "signing_key": "foo"
      }
    ]
  }
]

However, calling it via Postman returns an object:

{
  data: Array<...>
}

I think the documentation for this particular API is wrong.

主要语言
MDX
星标
8
派生
18
平均合并
21 小时 8 分钟
30 天内合并 PR
45

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

alchemyplatform/docs 的其他 Issue

查看 alchemyplatform/docs 的全部 Issue

相似的 Issue

更多 Backend & API Design Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。