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

Update README to explain `top` in pagination response

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

还没有人认领这个 Issue。

评估

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

调研方向

从链接的 swagger.yaml 第 1758 行附近的部分开始,找到 README 中关于分页的文档。确认其中解释属性 top 的位置,包括服务器强制施加的限制,以及未请求页面大小时的默认值。完成标准是 README 清楚地记录此行为及其可能适用于 Foundation API 的情况。

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

描述

https://github.com/buildingSMART/BCF-API/blob/19ac4f410728994bb67fb1552c974b4ec36d6f90/swagger.yaml#L1758

The top property describes how many items are at most returned per request / per page. If a server responds with a lower top value than what the client originally asked for, then that means the server has imposed a lower limit than what was requested.

If no page size is requested, the server will still populate the top property with it's default limit.

Maybe this part should be included in the Foundation API?

主要语言
没有语言数据
星标
239
派生
67
PR 合并指标
30 天内没有已合并 PR

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

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

buildingSMART/BCF-API 的其他 Issue

查看 buildingSMART/BCF-API 的全部 Issue

相似的 Issue

更多 Backend & API Design Issue

把新 issue 发到你的邮箱

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