apiops icon indicating copy to clipboard operation
apiops copied to clipboard

[BUG] Product not being associated with API after publishing

Open JamesProant opened this issue 1 year ago • 11 comments

Release version

6.0.1

Describe the bug

When publishing an API (with the setting "publish-all-artifacts-in-repo") the product is not being associated with the API. The product itself is being published, but it is not being connected with the API. In previous APIOps versions this worked fine. Since upgrading to version 6.0.1 this has stopped working for us.

Artifacts:

Image

In the older version of the APIOps the extractor would associate the product with the api using the apis.json file (this is a screenshot from version v5.1.1 of APIOps):

Image

This worked as expected, the product was associated with the API and when publishing, the product was connected with the API in the portal.

Expected behavior

When running the publisher, the product should be associated with the API. In the portal, product association can be verified: Image

Actual behavior

No product is being associated with the API either in the artifacts or in the portal. In the portal no product is associated with the API: Image

Reproduction Steps

Using APIOps v6.0.1
Extract API using extractor pipeline, with specific productName defined in extractor config file. Publish API using publisher pipeline.

JamesProant avatar Oct 22 '24 13:10 JamesProant

  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 Oct 22 '24 13:10 github-actions[bot]

@JamesProant - version 6 changed the way products are associated with APIs. Search for Subfolder structure in the release notes.

guythetechie avatar Nov 01 '24 16:11 guythetechie

@guythetechie thanks for the response.

Our main concern when raising this issue is that we are not receiving the product artifacts as described in the subfolder structure in the release notes from the link you provided. According to the release notes we should receive product artifacts as: /artifacts/products/productA/apis/apiA/productApiInformation.json Instead we receive product artifacts with no association to the API: /artifacts/products/productA/productInformation.json as seen in the photo I provided above.

JamesProant avatar Nov 02 '24 08:11 JamesProant

@guythetechie any update on this?

JamesProant avatar Jan 08 '25 06:01 JamesProant

@JamesProant - sorry for the delayed response. Between personal and professional matters, I've had no time for ApiOps.

Can you confirm that the APIs aren't filtered in the extractor configuration? If you have a filter like the one below, the only product APIs that would be extracted are apiA and apiB. In the meantime, I'll see if I can replicate the issue.

apis:
- apiA
- apiB

guythetechie avatar Feb 11 '25 13:02 guythetechie

Hi @guythetechie thanks for the response, no worries on the delay.

The configuration.extractor.yaml looks like this:

apiNames:
  - apiA

productNames:
  - apiProduct

The product and API are both being extracted as expected, but there is no association between the product and the api as was previously seen in v5.1.1. This causes an issue when publishing to a higher environment. The product and api will both be published to the higher environment, but once again there is no association between them as expected and I have to manually add the product to the api.

Thanks for the help!

JamesProant avatar Feb 11 '25 13:02 JamesProant

Any updates? Im facing the same issue @guythetechie

tkmsol avatar Mar 09 '25 16:03 tkmsol

@guythetechie any updates on this issue?

JamesProant avatar Sep 30 '25 07:09 JamesProant

@JamesProant - this should be fixed in our next release, v7. We have an alpha branch here, if you'd like to clone it and test it. Note that this branch is still missing some features, but product + api associations should work.

guythetechie avatar Oct 08 '25 13:10 guythetechie

@guythetechie We are experiencing the same issue but with Workspace scoped APIs to Workspace scoped Products. Should we also try the alpha branch 7?

ToddHamptonGit avatar Nov 20 '25 22:11 ToddHamptonGit

Yes, please go ahead and try the latest v7 alpha code. If it's easier to use executables instead of cloning the repo, you can find the latest alpha release here. This is still alpha, so you might encounter major bugs; please flag any you find.

guythetechie avatar Nov 20 '25 22:11 guythetechie