Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE REQ] Referring api specification by specifying its directory path #420

Closed
cmergenthaler opened this issue Nov 15, 2023 · 3 comments
Labels
enhancement New feature or request

Comments

@cmergenthaler
Copy link

Please describe the feature.

Let's say we want to have one specification.yaml for both the API provisioning and for code generating, it would be nice to be able to reference to a specific path rather than expecting a specification.yaml in the apis folder.
A possible folder structure could look like this:

artifacts
  apis
    apiA
      apiInformation.json
    apiB
      apiInformation.json
src
  specification.yaml

Inside the apiInformation.json we would be able to use the api-spec /src/specification.yaml

Copy link

  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.

@waelkdouh waelkdouh added the enhancement New feature or request label Nov 15, 2023
@waelkdouh
Copy link
Contributor

@guythetechie is this something we can consider down the line?

@guythetechie
Copy link
Contributor

@cmergenthaler - thanks for the suggestion. I'm reluctant to start parameterizing the path of certain artifact files, as this will increase the code complexity. It's the first time we've had this ask, and if it's a big enough concern, we can certainly revisit it.

In the meantime, I would suggest handling this in your CI/CD pipeline. Simply add a step to copy the specification file from src/specification.yaml to apis/apiA/specification.yaml prior to the step that runs the publisher.

We've envisioned the extractor/publisher exes to be fairly opinionated about how they handle things. The starter pipelines, on the other hand, can be easily customized to handle specific needs.

@waelkdouh waelkdouh closed this as not planned Won't fix, can't repro, duplicate, stale Nov 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants