Skip to content
代码片段 群组 项目
未验证 提交 31c33f52 编辑于 作者: Vasilii Iakliushin's avatar Vasilii Iakliushin 提交者: GitLab
浏览文件

Document changes to `List repository tree` REST API response code

Contributes to https://gitlab.com/gitlab-org/gitlab/-/issues/514756

Add a deprecation notice
上级 3f928ee7
No related branches found
No related tags found
2 合并请求!3031Merge per-main-jh to main-jh by luzhiyuan,!3030Merge per-main-jh to main-jh
- title: 'Error handling for `/repository/tree` REST API endpoint returns `404`'
announcement_milestone: '16.5'
removal_milestone: '17.7'
breaking_change: true
reporter: phikai
stage: Create
issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/420865
body: |
In GitLab 17.7, the error handling behavior for the list repository tree API endpoint, `/projects/:id/repository/tree`, is updated when a requested path is not found. The endpoint now returns a status code `404 Not Found`. Previously, the status code was `200 OK`.
This change was enabled on GitLab.com in GitLab 16.5, and will be available for self-managed instances in GitLab 17.7.
If your implementation relies on receiving a `200` status code with an empty array for missing paths, you must update your error handling to handle the new `404` responses.
......@@ -2539,6 +2539,26 @@ another RHEL-compatible operating system.
## GitLab 17.7
<div class="deprecation breaking-change" data-milestone="17.7">
### Error handling for `/repository/tree` REST API endpoint returns `404`
<div class="deprecation-notes">
- Announced in GitLab <span class="milestone">16.5</span>
- Removal in GitLab <span class="milestone">17.7</span> ([breaking change](https://docs.gitlab.com/update/terminology/#breaking-change))
- To discuss this change or learn more, see the [deprecation issue](https://gitlab.com/gitlab-org/gitlab/-/issues/420865).
</div>
In GitLab 17.7, the error handling behavior for the list repository tree API endpoint, `/projects/:id/repository/tree`, is updated when a requested path is not found. The endpoint now returns a status code `404 Not Found`. Previously, the status code was `200 OK`.
This change was enabled on GitLab.com in GitLab 16.5, and will be available for self-managed instances in GitLab 17.7.
If your implementation relies on receiving a `200` status code with an empty array for missing paths, you must update your error handling to handle the new `404` responses.
</div>
<div class="deprecation " data-milestone="17.7">
### TLS 1.0 and 1.1 no longer supported
......
0% 加载中 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册