Navigation Route Config

List all registered route configurations

{
  "data": [
    {
      "id": "rc-001",
      "route_name": "HomeScreen",
      "is_modal": false,
      "dismissal_policy": null,
      "component": "HomeScreen",
      "created_at": "2026-03-20T10:00:00Z"
    },
    {
      "id": "rc-002",
      "route_name": "SettingsModal",
      "is_modal": true,
      "dismissal_policy": "swipe_down_or_button",
      "component": "SettingsModal",
      "created_at": "2026-03-20T10:05:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 2
  }
}

Get metadata for a specific route (getRouteMetadata)

{
  "id": "rc-002",
  "route_name": "SettingsModal",
  "is_modal": true,
  "dismissal_policy": "swipe_down_or_button",
  "component": "SettingsModal",
  "accessibility": {
    "has_close_button": true,
    "supports_gesture_dismiss": true
  },
  "created_at": "2026-03-20T10:05:00Z"
}

Register a new route configuration (registerRoute)

{
  "route_name": "NotificationsScreen",
  "component": "NotificationsScreen",
  "is_modal": false,
  "dismissal_policy": null
}

{
  "id": "rc-003",
  "route_name": "NotificationsScreen",
  "is_modal": false,
  "dismissal_policy": null,
  "component": "NotificationsScreen",
  "created_at": "2026-03-26T09:00:00Z"
}

Update an existing route configuration

{
  "component": "NotificationsScreenV2",
  "is_modal": false
}

{
  "id": "rc-003",
  "route_name": "NotificationsScreen",
  "component": "NotificationsScreenV2",
  "is_modal": false,
  "dismissal_policy": null,
  "updated_at": "2026-03-26T09:30:00Z"
}

Remove a route from the router configuration

{
  "deleted": true,
  "route_name": "NotificationsScreen"
}

Build or rebuild the router from current configuration (buildRouter)

{
  "success": true,
  "routes_registered": 3,
  "built_at": "2026-03-26T09:35:00Z"
}

Set the modal dismissal policy for a route (setModalDismissalPolicy)

{
  "policy": "swipe_down_or_button"
}

{
  "route_name": "SettingsModal",
  "dismissal_policy": "swipe_down_or_button",
  "updated_at": "2026-03-26T09:40:00Z"
}

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}