Azure / Azure/apiops

[BUG] Api revision description ignored by publisher

Offen Anfängerfreundlich
#866 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
C#
Sterne
448
Forks
247
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

### 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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne in apiops/src/common/Api.cs bei Zeile 299 und in WorkspaceApi.cs bei Zeile 334. Verfolge anschließend, wie apiRevisionDescription aus apiInformation.json in die Revision übernommen wird. Verwende die bereitgestellten Reproduktionsschritte mit publisher 7.0.2 und bestätige, dass die Beschreibung der bereitgestellten Revision in beiden API-Pfaden mit dem konfigurierten Wert übereinstimmt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
csharp
Bereich
api
Issue-Typ
Bug
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Ruhig
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
68/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.