routes.json Field Descriptions

This document provides detailed descriptions of the fields used in the routes.json file.

Common Fields

path: (String) The URL path for the route. Example: "/login" or "/o/:orgName/dashboard"
componentPath: (String) The path to the component to be rendered for this route. Example: "@adminide-stack/user-auth0-browser-ant/lib/pages/Login/Login.js"
key: (String) A unique identifier for the route. Example: "login" or "organizations.dashboard"
name: (String) A human-readable name for the route, often used in menus or breadcrumbs. Example: "Login Page" or "Organization Dashboard"
exact: (Boolean) If true, the path must be an exact match. Example: true

auth: (Boolean or String) Represents the authentication requirement for the route. Possible values: true, false, or "optional"
authority: (Array of Strings) Authority strings required to access the route. Example: ["organization.settings.view"]
extraPermissions: (Array of Strings) Additional permissions required for certain actions on the route. Example: ["organization.settings.edit"]

hasComponent: (Boolean) Indicates if the component exists for the route. Example: true
hasLoader: (Boolean) If true, the route has a server-side loader. Example: true
hasClientLoader: (Boolean) If true, the route has a client-side loader. Example: true
hasAction: (Boolean) If true, the route has an action for form submissions or mutations. Example: true
hasServerCode: (Boolean) Indicates if the route has server-specific code. Example: true

queries: (Object) GraphQL queries that need to be run as part of the loader. Each query can have associated parameters. Example:
```
"queries": {
  "GetAllCountriesDocument": "{}"
}
```

configurations: (Object) Additional configuration options for the route. (This field was not explicitly defined in the provided documentation, but it's mentioned as a possibility)
resourceUri: (String) URI for specific resources associated with the route. (This field was not explicitly defined in the provided documentation, but it's mentioned as a possibility)