Openapi specifications from ApiVersions

We are using the exported openapi.yaml files for code generation in our workflows. Unfortunately the openapi specifications can only be exportet from the main branch.

Our preferred workflow woud be:

  1. our API Designer develops the API in ApiDog.
  2. When a new Version has been finished, he will create an ApiVersion in ApiDog.
  3. Developers can export the openapi specifications from the ApiVersion they need. Especially in mobile development we must support multiple ApiVersions.

Would it be possible to make ApiVersions exportable as Openapi Specifications?

Best regards,
Fritz

In addition, is there a way to specify the version of the openapi specifications? We did create a couple of ApiVersions in ApiDog. But when exporting from main branch, the Version in the openapi specs is always 1.0.0

Hi Fritz , thanks for reaching out. We will look into this and let you know soon.

You can set the API version when exporting OpenAPI specifications from the Overview section, as shown in the screenshot below.


thank you for sharing. we have been using the export function in the settings and there is no way to set the API Version

Thank you for sharing. That is helpful. Any news on my request to be able to export ApiVersions?

The interesting point is, that i can export the openapi specs via settings after selecting an ApiVersion if i have clicked on the “export” button before switching branches (as the export button get’s deactivated on branch switching), because the export view stays alive. But i get a notice that main and this sprint version will be merged. This is an error, as i have not opened a sprint branch but a an ApiVersion branch. I should be able to export ApiVersions as they are definite.

Thank you for investing this issue and your support :slightly_smiling_face:

Thank you for your feedback. We’ve noted this requirement and will consider it in future updates.