Marton Greber has posted comments on this change. ( http://gerrit.cloudera.org:8080/23224 )
Change subject: Add OpenAPI specification for REST API endpoints ...................................................................... Patch Set 3: (2 comments) http://gerrit.cloudera.org:8080/#/c/23224/3//COMMIT_MSG Commit Message: http://gerrit.cloudera.org:8080/#/c/23224/3//COMMIT_MSG@9 PS3, Line 9: Create a hand-written swagger/kudu-api.json specification rather than : implementing automated generation infrastructure. Please create a tracking jira for automating this task. You can describe that the intrusive way would be to automatically generate the swagger json file. Or that with the current approach a bit more safety is achieved by providing some sort of quick verification that the swagger doc matches the rest api source. (think of a quick script that cross checks the swagger json with the source) This is just to keep this patch's scope contained. http://gerrit.cloudera.org:8080/#/c/23224/3/src/kudu/master/rest_catalog_path_handlers.cc File src/kudu/master/rest_catalog_path_handlers.cc: http://gerrit.cloudera.org:8080/#/c/23224/3/src/kudu/master/rest_catalog_path_handlers.cc@233 PS3, Line 233: // If SPNEGO is enabled, provide alternative documentation since : // Swagger UI cannot work with authentication required for static resources : if (FLAGS_webserver_require_spnego) { : resp->status_code = HttpStatusCode::Ok; : resp->response_headers["Content-Type"] = "text/plain"; : resp->output : << "Interactive Swagger UI is not available when SPNEGO authentication is enabled.\n\n" : << "Alternatives:\n" : << "1. Download OpenAPI spec: /swagger/kudu-api.json\n" : << "2. Use external tools: Postman, Insomnia, or other API clients\n" : << "3. Command line: Use curl with --negotiate -u : for SPNEGO authentication\n\n"; : } else { Usually on secure deployments the webserver is accessed through Apache Knox for example. I'm curious whether you considered such case? Maybe with Knox this is possible? I'm not sure, just wanted to ask, because if that works that would be a really nice user experience. Thanks! -- To view, visit http://gerrit.cloudera.org:8080/23224 To unsubscribe, visit http://gerrit.cloudera.org:8080/settings Gerrit-Project: kudu Gerrit-Branch: master Gerrit-MessageType: comment Gerrit-Change-Id: I3981665c78f478e89d0300f3a2fc5d68b73b8762 Gerrit-Change-Number: 23224 Gerrit-PatchSet: 3 Gerrit-Owner: Gabriella Lotz <[email protected]> Gerrit-Reviewer: Gabriella Lotz <[email protected]> Gerrit-Reviewer: Kudu Jenkins (120) Gerrit-Reviewer: Marton Greber <[email protected]> Gerrit-Reviewer: Zoltan Chovan <[email protected]> Gerrit-Comment-Date: Thu, 11 Sep 2025 08:52:19 +0000 Gerrit-HasComments: Yes
