Azure / apiops

APIOps applies the concepts of GitOps and DevOps to API deployment. By using practices from these two methodologies, APIOps can enable everyone involved in the lifecycle of API design, development, and deployment with self-service and automated tools to ensure the quality of the specifications and APIs that they’re building.
https://azure.github.io/apiops
MIT License
306 stars 180 forks source link

[Question] Extractor Config difference between v5.* and v6.* #651

Open mandiga8 opened 1 week ago

mandiga8 commented 1 week ago

Release version

v6.0*

Question Details

When I use "api-name;rev=2" in version 5. it extracts only revision 2 related apis. However same is not working in v6.. Please let us if this is expected behaviour, or anything change in the configuration?

Expected behavior

Extraction should be same as v5, e.g. have the api only for revision 2

Actual behavior

api revision 2 is not extracted

Reproduction Steps

Place below in extractor config. run in both v5.& and v6.

api2;rev=2

github-actions[bot] commented 1 week ago
  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.
guythetechie commented 1 week ago

Hi @mandiga8,

The behavior did change between versions.

In version 5, revisions were not working correctly. Trying to get them right was one of the big reasons for version 6.

In version 6, putting an API name in configuration will extract that API and all of its revisions. There is currently no way in configuration to only extract a specific revision of an API.

mandiga8 commented 1 week ago

Hello @guythetechie , Thank you for the response and the details. Could you please share the link for the Extractor and Publish configuration, where I can refer to available functionalities?

waelkdouh commented 1 week ago

Please check the wiki and the github page associated with our repo. Also please keep in mind that we are in the process of updating our docs. We are just casting to finish the workspaces implementation. Please keep in mind that this is a source project so we would appreciate your patience. Also, we do offer a sample configuration file which admittedly is not comprehensive as there is a lot of configurations that can be overridden, but it's a good starting point which she will find and our repository.