Opensearch dashboards.routeconfig.path

Home > opensearch-dashboards > RouteConfig > path

RouteConfig.path property

The endpoint _within_ the router path to register the route.

Signature:

path: string;

Remarks

E.g. if the router is registered at /opensearch and the route path is /search, the full path for the route is /opensearch/search. Supports: - named path segments path/{name}. - optional path segments path/{position?}. - multi-segments path/{coordinates*2}. Segments are accessible within a handler function as params property of OpenSearchDashboardsRequest object. To have read access to params you *must* specify validation schema with RouteConfig.validate.