Azure / Azure/apiops

[BUG] Api revision description ignored by publisher

Aperta Adatta ai principianti
#866 1 commento 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
C#
Stelle
448
Fork
247
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia in apiops/src/common/Api.cs alla riga 299 e in WorkspaceApi.cs alla riga 334, quindi segui il modo in cui apiRevisionDescription proveniente da apiInformation.json viene trasferita nella revisione. Usa i passaggi di riproduzione forniti con publisher 7.0.2 e verifica che la descrizione della revisione distribuita corrisponda al valore configurato in entrambi i percorsi API.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
csharp
Ambito
api
Tipo di issue
Bug
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Tranquilla
Chiarezza
Specificata chiaramente
Idoneità per principianti
68/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.