snazy opened a new pull request, #3752:
URL: https://github.com/apache/polaris/pull/3752
This change adds a custom task implementation to compare two OpenAPI specs
and fail if there is a breaking change. Follow-ups are planned to compare
against an already released version and to actually wire it into the build
process and therefore CI.
This would work from a module's `build.gradle.kts` file along the lines of:
```kotlin
tasks.register<OpenApiCompatibilityCheckTask>("openApiCompatibilityCheck") {
// dependency on a task to generate the OpenAPI spec from Java code
annotations
dependsOn(generateOpenApiSpec)
// the generated OpenAPI spec
currentSpec =
layout.buildDirectory.file("generated/openapi/$openApiBaseDir/my-openapi.yaml")
// a reference OpenAPI spec to compare against
referenceSpec =
layout.projectDirectory.file("src/openapi/reference/my-openapi.yaml")
}
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
