Azure / Azure/apiops

[BUG] Api revision description ignored by publisher

Abierto Apto para principiantes
#866 1 comentario 0 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
C#
Estrellas
448
Forks
247
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Comienza en apiops/src/common/Api.cs en la línea 299 y en WorkspaceApi.cs en la línea 334; luego sigue cómo se incorpora apiRevisionDescription de apiInformation.json a la revisión. Usa los pasos de reproducción proporcionados con publisher 7.0.2 y confirma que la descripción de la revisión implementada coincide con el valor configurado en ambas rutas de API.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
csharp
Área
api
Tipo de issue
Error
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Tranquilo
Claridad
Bien especificado
Aptitud para principiantes
68/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.