Package io.micronaut.controlpanel.ui

Interface ControlPanelApi

All Known Implementing Classes:
ControlPanelController
public interface ControlPanelApi
HTTP API for the control panel UI.
Since:
1.0.0
Author:
Álvaro Sánchez-Mariscal

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    PATH
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Model
    byCategory(String categoryId)
    Renders the category view.
    Model
    detail(String controlPanelName)
    Renders the control panel detailed view.
    Model
    index()
    Renders the index view.

  • Field Details

  • Method Details

    • index

      @Get Model index()
      Renders the index view.
      Returns:
      the model

    • byCategory

      @Get("/categories/{categoryId}") Model byCategory(String categoryId)
      Renders the category view.
      Parameters:
      categoryId - the category id.
      Returns:
      the model

    • detail

      @Get("/{controlPanelName}") Model detail(String controlPanelName)
      Renders the control panel detailed view.
      Parameters:
      controlPanelName - the control panel name.
      Returns:
      the model