Azure / Azure/apiops

[BUG] API's with revisions are not being set to current.

Open
#646 3 comments 1 reaction 0 assignees View on GitHub
Dominant language
C#
Stars
448
Forks
247
PR merge metrics
No merged PRs in 30d

Description

### Release version

6.0.1.1

### Describe the bug

The publishing of our APIM artifacts is failing once there's a reference to an API operation that only exists in the parent APIs second revision, even though the second revision should be the current revision. Looking at the APIs in Azure, I see that the first revision is set as current even though the APIs `apiInformation.json` file has it's `isCurrent` property set to `true`.

From what I can tell, looking at the code, the `isCurrent` value is being nulled out of the API `Dto` object to prevent occasional failures.

![image](https://github.com/user-attachments/assets/6bc4ba0f-795e-45d5-a0ef-54494fb50749)

This causes the API to be initially deployed with out the `isCurrent` property set, defaulting to revision 1 as current.

I then noticed that there's a process in place to "correct" the revision number: `CorrectApimRevisionNumber`.
But, reviewing that code, I think I found a small bug preventing that process from correcting the revision numbers of revisioned APIs.

![image](https://github.com/user-attachments/assets/107085bc-e910-4d2b-8e51-d4acebe88e7d)

I could be wrong, but it appears that this would skip all revisioned APIs when assessing them for correction.

To test this, I cloned the repo and updated line [369](https://github.com/Azure/apiops/blob/b9c4361598d20b11d24662c7eced93617725d61e/tools/code/publisher/Api.cs#L369) to:
```cs
if (ApiName.IsNotRevisioned(name))
```
After that, I ran it locally and it published successfully.

### Expected behavior

I expect API revisions to be set correctly in accordance to the API's `apiInformation.json` file.

### Actual behavior

Revisioned APIs do not have the correct revision set to current after deployment, causing failures when anything in the now non-current API is referenced.

### Reproduction Steps

In a new APIM instance:
1. Create an API with a single operation.
2. Revision the API.
3. Create another operation in that new revision.
4. Set the second revision as current (`Make current`).
5. Extract the APIM instance.
6. Delete all APIs or create another new APIM instance.
7. Publish the extracted artifacts to the cleaned or new APIM instance.

You should see that revision 1 is incorrectly set as current.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.