Web Route Analyser

Overview

Detects HTTP route changes in Flask or FastAPI apps.

Dependencies

Flask or FastAPI

Framework providing HTTP routes

Enable/Disable

bumpwright --enable-analyser web_routes
bumpwright --disable-analyser web_routes
[analysers]
web_routes = true  # set to false to disable

See also

For configuration options, see concepts/configuration#analysers.

Severity Rules

Change

Bump

Added route

minor

Removed route

major

Added optional param

minor

Added required param

major

Removed optional param

minor

Removed required param

major

Param became optional

minor

Param became required

major

Example

@@
@app.get("/users/{user_id}")
-def get_user(user_id: int):
-    ...
+def get_user(user_id: int, verbose: bool = False):
+    ...
- [MINOR] GET /users/{user_id}: Added optional param 'verbose'