[BUG] Api revision description ignored by publisher

オープン 初心者向け
#866 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
68/100
issue の種類
バグ
明瞭さ
明確に書かれている
活発さ
静か
技術スタック
csharp
領域
api

調査の方向性

apiops/src/common/Api.cs の 299 行目と WorkspaceApi.cs の 334 行目から開始し、apiInformation.json の apiRevisionDescription がどのようにリビジョンへ引き継がれるかを追跡します。publisher 7.0.2 を使用して提供された再現手順を実行し、デプロイされたリビジョンの説明が両方の API パスで構成された値と一致することを確認します。

索引モデルが issue の本文から書いたものです。

説明

Release version

7.0.2

Describe the bug

We are using apiInformation.json where we have correctly setup everything what is needed, and it all worked just fine when we were using publisher version 5.x.x. After upgrade to publisher version 7.0.2 we noticed that our description of the revisions were not changing (before it was pipeline build ID).
The apiRevisionDescription was still configured correctly in apiInformation.json but somehow the value got ignored by the publisher and instead the description of the previous current revision was used.

It looks like the new publisher version 7.0.2 has either a bug (or maybe its a feature) where those descriptions are ignored.

AI helped me to identify the problem directly in the publisher code (but it may be wrong as I did not investigate the code in detail):
File: apiops/src/common/Api.cs line 299:
ApiRevisionDescription = existingDtoObject.Properties.ApiRevisionDescription,

and also:

Same bug exists in WorkspaceApi.cs line 334.

Expected behavior

When apiRevisionDescription is set in apiInformation.json, we expect this description in the api revision after deployment.

Actual behavior

When apiRevisionDescription is set in apiInformation.json, the api revision description set in apiInformation.json is ignored and latest current revision description is used instead.

Reproduction Steps

set apiRevisionDescription in apiInformation.json to certain value and deploy the revision via publisher version 7.0.2. Observe that thedescription in the api revision is not set to the value set in apiInformation.json.

主要言語
C#
スター
448
フォーク
247
PR マージ指標
30日以内にマージされた PR はありません

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Azure/apiops のほかの issue

Azure/apiops の issue をすべて見る

似ている issue

C# の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。