api-management-developer-portal icon indicating copy to clipboard operation
api-management-developer-portal copied to clipboard

How to add tags for APIs at version level apart from APIM service GUI

Open ravindrapcshs opened this issue 2 years ago • 3 comments

Hi,

We recently found an issue to add tags for APIs at version level.

Issue-1: Adding tags for an API version is possible from APIM service GUI and same will be reflected in Developer portal at API version level but it's not possible to add tags from pipeline task. See below snaps.

image

image

image

image

In pipeline agent job/tasks, there is no other ways to add this tags from "Deploy an Azure Resource Manager (ARM) template" https://github.com/microsoft/azure-pipelines-tasks/blob/master/Tasks/AzureResourceGroupDeploymentV2/README.md. Is this right one to add tags for API version?

image

How to add tags for APIs at version level from pipeline agent job? Why tasks are not support to add tag in pipeline job?

Issue-2:

I have added tag in json file for one of the API version having couple of operations, this will not reflect in APIM service GUI or in developer portal anywhere, but this new tag "new-test-tag" will add only to "API tags" after saving. Added tag as per documentation: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.1.md#tagObject

image

image

image

image

Need help to fix the tagging issue here as well. Why added tag in OpenAPI specification JSON file not updated in tags settings and developer portal API gallery?

CC: @AnRei123

ravindrapcshs avatar Mar 13 '23 11:03 ravindrapcshs

@ravindrapcshs, thank you for opening this issue. We will triage it within the next few business days.

ghost avatar Mar 13 '23 11:03 ghost

Hello @ravindrapcshs, this repo is for dev portal issues only. From what I can see, your issue root is in the Azure portal. Please, contact Azure support for assistance.

jsorohova avatar Mar 15 '23 13:03 jsorohova

@jsorohova, Thanks for your response! I will post Azure portal issues separately. But, I didn't get right place to post. Can you please share the link for Azure portal issues?

With this, I also reported few issue of dev portal to display Tag group and Tag name. And few issue in API-Management settings. Let me reframe my issue once again here.

image

  1. (Follow the flow 1 to 3 in snap) "Group by tags" is required here. In my case, I have products and each product contains many API versions. I have grouped these API versions with tags. This tag name used to discover my API versions for one of use-case. Same tag name can be possible too to add for different versions of APIs. Page link : devportal-url/api-products/details#product=product-name Please see the point-1 in above snap for reference.

  2. (Follow the flow 3 to 4 in snap) API tag name is required here. In my case, Tag name added for API version is missing to display inside of operation page. This will be easy for us to identify the API versions belongs to which tag name to discover the use-case. Page link : devportal-url/api-gallery/details#api=API-Version Please see the point-2 in above snap for reference.

@AnRei123

Thanks.

ravindrapcshs avatar Mar 16 '23 08:03 ravindrapcshs