Note: These flows are deprecated in the architectural documentation
The backend for the dashboard is node REST server that performs k8s calls on behalf of the frontend. The following are a list of current apis and their functionality.
GET - Gets the list of current builds status. This returns an array of build status objects
GET - Retrieves the current cluster settings. This get returns a cluster settings object.
GET - Used to update the cluster settings. The url parameters for this get are each of the fields in the cluster settings object. Note that this GET will be updated to a POST in a future release.
GET - Retrieves the list of installed components. The payload for this is an array of ODHApplication objects
GET - Retrieves the dashboard config. This returns a Dashboard config object
GET - Retrieves the list of console objects available for switching between apps. The returns an array of console link objects
GET - Retrieves the list of docs. The returns an array of document objects
GET - Retrieves the list of notebooks. The returns an array of notebook objects
POST - Creates a notebook. The payload should be notebook object
GET - Retrieves a specific notebook by its id. This returns a single notebook object
DELETE - Deletes a specific notebook image using its notebook id.
PUT - Updates a specific notebook by its id. The payload should be the updated fields as shown in a notebook object
GET - Retrieves the quick starts. This returns an array of QuickStart object
GET - Retrieves the segment key if tracking is enabled and a key is available. This returns a Segment Key object
GET - Retrieves the current status of the odh dashboard application. This returns a Kube Status object
GET - Use to validate if an ISV is enabled. Note that this should be updated to a put in a future release.
GET - Retrieves the current status of an ISV.