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

GET Document Service endpoint - Mismatch between Documentation and BCF-API SwaggerHub

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

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
48/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
停滞
领域
api, documentation

调研方向

将链接为“3.8.1 GET documents service”的 README 部分与 SwaggerHub 中针对项目级 endpoint 的 Documents 操作进行比较。确认 BCF-API 规范规定使用哪条 route,以及哪个来源具有权威性。当文档和 SwaggerHub 定义对同一个 endpoint 达成一致时,即视为完成。

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

描述

In the documentation the endpoint is:
GET /bcf/{version}/projects/{project_id}/documents ,
while in SwaggerHub:
/bcf/{version}/projects/{project_id}/topics/{topic_id}/documents

I believe that the endpoint defined in the documentation is correct, as it retrieves a collection of all documents uploaded to a project.

主要语言
没有语言数据
星标
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 摘要。