Gabriella Lotz has uploaded this change for review. (
http://gerrit.cloudera.org:8080/23904
Change subject: KUDU-3700 Add swagger verification script docs
......................................................................
KUDU-3700 Add swagger verification script docs
Document usage and expected output for the swagger verification helper to
make it easy to run manually and possibly in CI.
Manual testing:
- ./build-support/verify_swagger_spec.py
- Manual negative checks by temporarily changing swagger path/method/param
confirmed mismatch output
Examples:
- Path coverage: swagger paths (with server base /api/v1) must match
registered /api/... handlers in source.
Swagger verification failed with 2 issue(s):
- Swagger path missing in source: /api/v1/leaders
- Source path missing in swagger: /api/v1/leader
- HTTP methods: methods inferred from req.request_method checks must match
swagger operations.
Swagger verification failed with 2 issue(s):
- Swagger missing methods for /api/v1/tables: POST
- Swagger has extra methods for /api/v1/tables: PUT
- Path parameters: swagger path params must match <param> names in the
handler path.
Swagger verification failed with 1 issue(s):
- Parameter mismatch for GET /api/v1/tables/{table_id}:
swagger=['table_uuid'] source=['table_id']
Change-Id: I3ca60becef11eb2170544f87fafc5d9aa4110a31
---
A build-support/verify_swagger_spec.py
1 file changed, 249 insertions(+), 0 deletions(-)
git pull ssh://gerrit.cloudera.org:29418/kudu refs/changes/04/23904/1
--
To view, visit http://gerrit.cloudera.org:8080/23904
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings
Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-MessageType: newchange
Gerrit-Change-Id: I3ca60becef11eb2170544f87fafc5d9aa4110a31
Gerrit-Change-Number: 23904
Gerrit-PatchSet: 1
Gerrit-Owner: Gabriella Lotz <[email protected]>
