You are viewing a plain text version of this content. The canonical link for it is here.

Posted to jira@kafka.apache.org by GitBox <gi...@apache.org> on 2022/06/08 16:05:56 UTC

[GitHub] [kafka] mimaison commented on pull request #12067: KAFKA-13780: Generate OpenAPI file for Connect REST API

mimaison commented on PR #12067:
URL: https://github.com/apache/kafka/pull/12067#issuecomment-1150112610

   Thanks @tombentley for taking a look!
   
   
   > Do you have any plans for generating some HTML from the YAML?
   
   I did take a look at generating HTML when working on this weeks ago but I did not find any generators that I really liked. I tried the htnl, html2 and dynamic-html generators from https://openapi-generator.tech/docs/generators#documentation-generators but found they were either buggy or required quite a bit of template customization to be nicely readable. So for now I'm sticking to only generating the spec file. 
   
   > What about documenting the expected non-200 response codes?
   
   Yes definitively something we need to do. I'm tempted to do it in a separate PR where we'll also use types that describe the response schemas.
   
   
   


-- 
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: jira-unsubscribe@kafka.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org