-
Notifications
You must be signed in to change notification settings - Fork 120
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
Replaced swagger2markup maven plugin with openapi-generator #928
Conversation
Signed-off-by: Paolo Patierno <[email protected]>
I also noticed that this happened to Keycloack project in the past and they fixed by pushing the missing artifact in a personal namespace dropping JCenter. To be honest I am not so keed to this approach keycloak/keycloak#5070 |
Signed-off-by: Paolo Patierno <[email protected]>
Fixed OpenAPI v3 spec for missing items def under array types Signed-off-by: Paolo Patierno <[email protected]>
Signed-off-by: Paolo Patierno <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, I guess I do not have a strong opinion on this.
Signed-off-by: Paolo Patierno <[email protected]>
…ucer records Signed-off-by: Paolo Patierno <[email protected]>
producer records on OpenAPI v2 Signed-off-by: Paolo Patierno <[email protected]>
producer record definitions Signed-off-by: Paolo Patierno <[email protected]>
Signed-off-by: Paolo Patierno <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good to find a solution to this ongoing issue. The content maps to what we have currently. If we want to maintain a single bridge doc including the API content, considering the API is stable so we don't need to change it much, this works fine.
Otherwise, we could consider spinning off the API content and hosting HTML output that we link to from the main bridge docs. Or it is possible to include HTML content in an asciidoc book (but that might introduce other issues).
) * Replaced swagger2markup maven plugin with openapi-generator Signed-off-by: Paolo Patierno <[email protected]> * Fixed local path issue to the snippet dir Signed-off-by: Paolo Patierno <[email protected]> * Added OpenAPI validation during documentation build Fixed OpenAPI v3 spec for missing items def under array types Signed-off-by: Paolo Patierno <[email protected]> * Fixed scholzj comments Signed-off-by: Paolo Patierno <[email protected]> * Removed JCenter repository Signed-off-by: Paolo Patierno <[email protected]> * Fixed key and value schemas to be consistent across consumer and producer records Signed-off-by: Paolo Patierno <[email protected]> * Fixed key and value schemas to be consistent across consumer and producer records on OpenAPI v2 Signed-off-by: Paolo Patierno <[email protected]> * Extracted a common RecordKey and RecordValue components for consumer and producer record definitions Signed-off-by: Paolo Patierno <[email protected]> * Fixed openapi related test Signed-off-by: Paolo Patierno <[email protected]> --------- Signed-off-by: Paolo Patierno <[email protected]>
The current build of the bridge is broken, more specifically the part related to the documentation generation.
This is because the Maven plugin we use, swagger2markup, has been abandoned (since years) and lately some of its dependencies were removed from JCenter (which seems to be also going to be dismissed by JFrog).
Several times we tried to replace it and now it's the right time.
This PR is an attempt to use the openapi-generator project to do so. This project provides several generators for clients and documentation. It's able to generate code and content starting from the OpenAPI specification.
The generator used in this PR is the
asciidoc
one in order to generate the documentation for our OpenAPI specification in asciidoc format without making any change in the documentation flow generation we have today (through the Makefile).The output I have got for the official website is pretty similar to the current one with some caviets:
asciidoc
generator generates duplicated documentation for the same operation id OpenAPITools/openapi-generator#19659) but I also noticed that the final rendering in HTML (through the asciidoctor) contains just one, so it's not a big issue.In general, we should continue to investigate how to improve and fix the above "issues" but right now this is the only way I see to unlock the bridge build.