centurion-ui
    Preparing search index...

    Interface apiRootMetadata

    API root metadata is provided by the backend and must be accessible via it's base URL (UIEnvironment.API_URL). This object is obtained via a HTTP/OPTIONS request and must be returned as a JSON object that matches this interface.

    This object is only to be fetched once on the UI loading and is responsible for providing the necessary descriptions so the UI can be setup.

    0.1.0

    interface apiRootMetadata {
        allowed_methods: [
            "DELETE"?,
            "GET"?,
            "HEAD"?,
            "PATCH"?,
            "POST"?,
            "PUT"?,
            "OPTIONS"?,
        ];
        navigation: NavigationEntryDescription[];
        routes: RouteDescription[];
        version: BackendVersion;
    }

    Hierarchy (View Summary)

    Index
    allowed_methods navigation routes version
    allowed_methods: [
        "DELETE"?,
        "GET"?,
        "HEAD"?,
        "PATCH"?,
        "POST"?,
        "PUT"?,
        "OPTIONS"?,
    ]

    Allowed HTTP methods.

    The backend should update these as per the users permissions.

    navigation: NavigationEntryDescription[]

    Navigation structure for the UI.

    Type Declaration

    Describes the structure of the navigation menu.

    • display_name: string

      Human readable name to use as the navigation entry.

    • Optionalicon?: string

      Icon name to display.

    • Relative url to the page this navigation entry gos to.

    • name: string

      Unique identifier for this navigation entry.

    • Optionalpages?: NavigationEntryDescription[]

      Children navigation entries. These will be added underneath this entry.

    routes: RouteDescription[]

    Route layout description the UI will use to create the route layout.

    Type Declaration

    0.13.0

    version: BackendVersion

    Backend version information

    Type Declaration

    • project_url: string

      URL of the software used by the backend.

    • sha: string

      GIT SHA hash for the current version of the backend.

    • version: string

      Software version number of the backend.

    Settings
    Member Visibility

    On This Page
    Properties