Azure / Azure/api-management-developer-portal

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

Open
#2,131 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
545
Forks
360
PR merge metrics
No merged PRs in 30d

Description

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](https://user-images.githubusercontent.com/127383680/224684002-0856b504-f084-4bf6-8f6f-741940188567.png)

![image](https://user-images.githubusercontent.com/127383680/224685188-79d31ad9-9b9b-413d-b962-975c244dab1a.png)

![image](https://user-images.githubusercontent.com/127383680/224686258-15841b55-4422-4d68-b0d8-0162617b4333.png)

![image](https://user-images.githubusercontent.com/127383680/224691158-61baefd9-470b-4124-920e-9d91c544c811.png)

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](https://user-images.githubusercontent.com/127383680/224690138-e4e77cb3-e2e7-48ed-8218-cd599a9a4383.png)

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](https://user-images.githubusercontent.com/127383680/224693832-5248af29-d1aa-4832-8478-d8119c357439.png)

![image](https://user-images.githubusercontent.com/127383680/224696626-f6023afa-603a-44de-a3ff-254c444d06c0.png)

![image](https://user-images.githubusercontent.com/127383680/224696905-3b5902a9-9c12-453c-bdb0-c6242abe0382.png)

![image](https://user-images.githubusercontent.com/127383680/224893198-57f77174-d6f0-4b06-9e09-67c7e23f06e5.png)

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

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the AzureResourceGroupDeploymentV2 README linked in the issue and compare its documented pipeline inputs with the APIM service GUI behavior. Read the OpenAPI 3.0.1 Tag Object documentation linked in the report, then trace how API-version tags are represented in the developer portal. Done means the supported pipeline or specification path for version-level tags is identified and the reported behavior is resolved or documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure, openapi, typescript
Domain
api, cloud
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.