search

redskap / swagger-brake

Swagger contract checker for breaking API changes
Apache License 2.0
57 stars 16 forks source link

Add support for packaging type .yaml #128

Open robert-franz opened 4 months ago

robert-franz commented 4 months ago

I tried to use the gradle plugin but i got stuck as when having a look to the source code the packaging types jarand war are supported. In our repository we're storing the openapi spec directly as packaing type yaml. Unfortunately this is not supported. Is there a way to also support that packaging type?

galovics commented 4 months ago

Hi @robert-franz,

I don't see a problem with supporting straight yamls. Do you mind sharing your workflow so I can better understand whats going on?

Thanks.

robert-franz commented 4 months ago

@galovics In the end we're directly uploading the .yamls to our repository as we're working api first. So we don't have yaml inside .jars. So when performing the backwards compatiblity check there is only a straight yaml in the repo.

galovics commented 1 month ago

@robert-franz I've got the idea of deploying yamls directly but question; which type of repository are you deploying to? Generic? Maven repo?

swagger-brake uses the maven-metadata.xml file to decide which is the latest version of a package and I'm not sure how this will work with a plain yaml unless you hack the deployment pipeline in your Java project to generate maven-metadata as well.

Let me know.