Azure / Azure/apiops

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

Ouverte
#563 4 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
C#
Étoiles
448
Forks
247
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par reproduire le problème avec une surcharge d’une propriété de publication dont la description diffère de info.description dans la spécification de l’API. Comparez la trace de API Ops CLI, apiInformation.json, l’onglet Settings d’Azure API Management et le point de terminaison cité APIs - Create Or Update. Le travail est terminé lorsque la description de Settings reflète la surcharge pour les API existantes et les API nouvellement poussées, tandis que apiVersionDescription continue de se mettre à jour dans l’écran Revisions.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
azure, csharp
Domaine
api, cloud, devops
Type d'issue
Bug
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.