apiops icon indicating copy to clipboard operation
apiops copied to clipboard

Unable to extract Operations for an API, while running extractor pipeline

Open Mallikarjuna97 opened this issue 8 months ago • 4 comments

Release version

v4.1.3

Describe the bug

Hi Team,

We are using APIOps pipelines to extract and deploy the APIs from One environment to another in APIM instance.

When trying to run the API extract pipeline, the APIs are being extracted but the operations inside an API are not extracting.

The operations are only extracted when we manually go inside one of the api operation and edit and save it. We want to understand this behaviour why it is happening like this.

Image

One more thing we observed is, as shown in above image, it is not able to extract operations , if service URL in the backend policies is not Overridden. If the service URL in the backend policy is overridden with some value, it is able to extract those Operations, which is strange. Want to understand this behaviour.

Currently we are using apios version v4.1.3 in the pipelines for extracting apis from APIM.

I tried with different versions like 4.6.0 , 5.0.1 , 5.1.4 , 6.0.1.

For 4.6.0 and 5.0.1 versions , the pipeline is able to fetch apis, but still the issue is there while fetching operations inside an API.

For latest versions like 5.1.4 , 6.0.1 and other 6.0+ versions, while fetching extractor itself the pipeline is failing .

Regards, Mallikarjun

Expected behavior

Need to extract all the operations inside an API

Actual behavior

When trying to run the API extract pipeline, the APIs are being extracted but the operations inside an API are not extracting.

Reproduction Steps

  1. While running the extractor pipeline, it is able to extract the APIs, but unable to extract the operations inside it.

Mallikarjuna97 avatar Apr 17 '25 06:04 Mallikarjuna97

  Thank you for opening this issue! Please be patient while we will look into it and get back to you as this is an open source project. In the meantime make sure you take a look at the [closed issues](https://github.com/Azure/apiops/issues?q=is%3Aissue+is%3Aclosed) in case your question has already been answered. Don't forget to provide any additional information if needed (e.g. scrubbed logs, detailed feature requests,etc.).
  Whenever it's feasible, please don't hesitate to send a Pull Request (PR) our way. We'd greatly appreciate it, and we'll gladly assess and incorporate your changes.

github-actions[bot] avatar Apr 17 '25 06:04 github-actions[bot]

One more scenario we observed is it is able to extract operations when we edit and saved policies section and backend section.

Policies section:

Image

Backend section:

Image

Similarly when we tried edit and update Frontend section, it didnt pickedup, we are not able to extract operations in this case.

Frontend section:

Image

Mallikarjuna97 avatar Apr 23 '25 09:04 Mallikarjuna97

ApiOps only creates folders for operations that have policies. They will appear under apis/apiName/operations/operationName/policy.xml. If an operation doesn't have a policy, it won't get a folder under apis/apiName.

Most of the operation content will come from your specification file (apis/apiName/specification.yaml|json).

guythetechie avatar Apr 23 '25 12:04 guythetechie

Let me check and get back

Mallikarjuna97 avatar Apr 24 '25 07:04 Mallikarjuna97