[
https://issues.apache.org/jira/browse/KUDU-3700?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Abhishek Chennaka reassigned KUDU-3700:
---------------------------------------
Assignee: Gabriella Lotz
> Add validation for manual OpenAPI specification
> -----------------------------------------------
>
> Key: KUDU-3700
> URL: https://issues.apache.org/jira/browse/KUDU-3700
> Project: Kudu
> Issue Type: Improvement
> Reporter: Gabriella Lotz
> Assignee: Gabriella Lotz
> Priority: Major
>
> h2. Problem
> The hand-written swagger/kudu-api.json file could drift out of sync with the
> actual REST API source code, leading to inaccurate documentation.
> h2. Solution
> Create a verification script that cross-checks the swagger.json against REST
> API source code to catch inconsistencies early. This maintains the current
> manual approach while adding safety validation.
> h2. Alternative considered
> Full automation by generating swagger from source code, but this would be
> more intrusive and exceeds current scope.
> h2. Acceptance Criteria
> - Script validates endpoint paths, HTTP methods, and parameters match
> between swagger.json and source
> - Script provides clear error messages for inconsistencies
> - Can be run manually and integrated into CI pipeline
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
