Azure / Azure/apiops

[BUG] API Description cannot be updated using publishing configuration, only API specification

Abierto
#563 4 comentarios 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

v5.1.4

### Describe the bug

For an existing API, and for pushing a new API where none was present in APIM. The Description field on the Settings tab for the API will not be updated using the override and from what I can see, also the apiInformation.json. The only successful means I've seen to get it to update is by baking it into the API Specification. If we have multiple environments and desired to have an Environment distinction in that description then we have to update the API spec's info.description which is not ideal. Its possible this is just an Azure Portal UI quirk whereby it just shows the info.description but under the hood, the objectd models' description is as specified.

In trace-mode, the API Ops CLI is sending the description from the publishing override yaml. The following API was used for reference when trying to find if it's a misconfiguration of the override. https://learn.microsoft.com/en-us/rest/api/apimanagement/apis/update?view=rest-apimanagement-2022-08-01&tabs=HTTP#request-body

apiVersionDescription does show its update when you look at the description column on the Revisions screen.

### Expected behavior

The Description field in the Settings tab of the Azure Portal is reflecting the content pushed by API Ops using what I believe is this API - [Apis - Create Or Update](https://learn.microsoft.com/en-us/rest/api/apimanagement/apis/create-or-update?view=rest-apimanagement-2022-08-01&tabs=HTTP) when the properties.description or, description field is set in the publishing properties.

### Actual behavior

The description field is only updated in the UI when the API Specification's info.description field is updated. However, the API's Display Name, Name, Path and serviceUrl do take their values from the property overrides.

### Reproduction Steps

Specify a new description in the property override that differs from the info.description in the API's specification such as in the case of a sub-environment.

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Comienza reproduciendo el problema con una sobrescritura de una propiedad de publicación cuya descripción difiera de info.description en la especificación de la API. Compara el rastro de API Ops CLI, apiInformation.json, la pestaña Settings de Azure API Management y el endpoint citado APIs - Create Or Update. Se considera terminado cuando la descripción de Settings refleja la sobrescritura tanto para las APIs existentes como para las recién insertadas, mientras apiVersionDescription sigue actualizándose en la pantalla Revisions.

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

Evaluación

Stack tecnológico
azure, csharp
Área
api, cloud, devops
Tipo de issue
Error
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.