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

[BUG] Huge APIs (with many Operations and other artifacts) have the publisher tool fail

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

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
35/100
Issue 类型
缺陷
描述清晰度
基本清楚
活跃度
停滞
技术栈
azure, csharp
领域
api, cloud

调研方向

从 publisher 工具的 Management API 创建或更新路径开始,检查它如何处理 422 响应,包括现有的 409 重试行为。使用包含非常大量操作的 API 进行复现,然后验证状态轮询会在有界超时内等待,并且成功或失败的操作会产生适当的 workflow 结果。

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

描述

Release version

5.00 and onwards

Describe the bug

I have tried to transfer "The Jira Service Management Public REST API" from one Service to another using the publisher tool. As the amount of operations and possibly other artifacts is significant, the Management API Call to create or update the API results in the Management API returning 422 after a while. Which is fine if it was handled, but of course that is not the case, so the Publisher fails.

Expected behavior

Here is what I expect publisher to do:

  1. Catch the 422 Error: Modify the Publisher Tool to explicitly catch the 422 error. The tool should recognize this specific HTTP status code and handle it appropriately rather than immediately retrying or failing.
  2. Implement a Status Check: After catching the 422 error, introduce a function to query the status of the API operation using the Azure Management API. You can use endpoints like GET /apis/{apiId} to check the current status of the ongoing API update.
  3. Retry Mechanism: If the status indicates that the API operation is still "in progress," implement a retry loop with a delay (e.g., using sleep) until the process is finished. Make sure to introduce a sensible timeout to avoid indefinite retries.
  4. Proceed or Abort Workflow: Based on the final status of the operation, either proceed with the next step of the deployment if the update was successful or abort the workflow with an appropriate error message if the operation ultimately fails.

This approach ensured that the script avoided unnecessary retries and handled conflicts like the 409 error by waiting for the ongoing operation to complete before attempting further updates.

Actual behavior

After the timeout, the Management APIs return of 422 breaks publisher which aborts with an error. Actually, the requested operation is continued to be carried out in the backend, so ultimately business-logic wise the call has succeeded, we just don't know about it and are left with an unhandled exception.

Reproduction Steps

I'd try to have publisher publish the "The Jira Service Management Public REST API", or any other API with a HUGE amount of operations and perhaps other artifacts.

主要语言
C#
星标
448
派生
247
PR 合并指标
30 天内没有已合并 PR

贡献指南

打开贡献指南

从这里开始

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

Azure/apiops 的其他 Issue

查看 Azure/apiops 的全部 Issue

相似的 Issue

更多 C# Issue

把新 issue 发到你的邮箱

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