Merge pull request #83 from ca-scribner/add-kubeflow-dashboard-sideba…

…r-interface

add kubeflow-dashboard-sidebar interface

README.md

@@ -11,6 +11,7 @@ To contribute a new interface specification, open a pull request containing:
   - `charms.yaml` file consisting of a list of any `providers` and `requirers` known to adhere to the specification.
   - a `interface_tests` directory in which you can put python files containing interface tests. Read more about interface tests [here](./README_INTERFACE_TESTS.md)
 - under `docs/`, the json schemas generated from the pydantic schemas. You can use command `tox -e build-json-schemas` to generate them automatically. Do not edit those files manually.
+- in this repo's root `README.md`, add the interface to the table, if applicable.  
 
 To quickly get started, see the [template interface](https://github.com/canonical/charm-relation-interfaces/tree/main/interfaces/__template__/v0) for a template of what to include and how it should be structured. 
 
@@ -48,6 +49,7 @@ To quickly get started, see the [template interface](https://github.com/canonica
 | Category      | Interface                                                                    |                               Status                                |
 |---------------|:-----------------------------------------------------------------------------|:-------------------------------------------------------------------:|
 | Metadata      | [`k8s-service`](interfaces/k8s-service/v0/README.md)                         | ![Status: Draft](https://img.shields.io/badge/Status-Draft-orange)  |
+| Metadata      | [`kubeflow-dashboard-sidebar`](interfaces/kubeflow_dashboard_sidebar/v0/README.md) | ![Status: Live](https://img.shields.io/badge/Status-Live-darkgreen) |
 
 ### Identity
 

docs/json_schemas/kubeflow_dashboard_sidebar/v0/requirer.json

@@ -0,0 +1,56 @@
+{
+  "title": "RequirerSchema",
+  "description": "Requirer schema for Ingress.",
+  "type": "object",
+  "properties": {
+    "unit": {
+      "$ref": "#/definitions/BaseModel"
+    },
+    "app": {
+      "title": "App",
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/SidebarItem"
+      }
+    }
+  },
+  "required": [
+    "app"
+  ],
+  "definitions": {
+    "BaseModel": {
+      "title": "BaseModel",
+      "type": "object",
+      "properties": {}
+    },
+    "SidebarItem": {
+      "title": "SidebarItem",
+      "description": "Representation of a Kubeflow Dashboard sidebar entry.\n\nSee https://www.kubeflow.org/docs/components/central-dash/customizing-menu/ for more details.\n\nArgs:\n    text: The text shown in the sidebar\n    link: The relative link within the host (eg: /runs, not http://.../runs)\n    type: A type of sidebar entry (typically, \"item\")\n    icon: An icon for the link, from\n          https://kevingleason.me/Polymer-Todo/bower_components/iron-icons/demo/index.html",
+      "type": "object",
+      "properties": {
+        "text": {
+          "title": "Text",
+          "type": "string"
+        },
+        "link": {
+          "title": "Link",
+          "type": "string"
+        },
+        "type": {
+          "title": "Type",
+          "type": "string"
+        },
+        "icon": {
+          "title": "Icon",
+          "type": "string"
+        }
+      },
+      "required": [
+        "text",
+        "link",
+        "type",
+        "icon"
+      ]
+    }
+  }
+}

interfaces/kubeflow_dashboard_sidebar/v0/README.md

@@ -0,0 +1,48 @@
+# `kubeflow-dashboard-sidebar/v0`
+
+## Usage
+
+This relation interface describes the expected behavior of any charm claiming to be able to provide 
+or consume the `kubeflow-dashboard-sidebar`.  `kubeflow-dashboard-sidebar` is an interface for defining links in the format of Kubeflow Dashboard's sidebar. 
+
+## Behavior
+
+### Provider
+
+- Is expected to create a sidebar link in the dashboard UI for each link entry sent by the `requirer` over the relation
+
+### Requirer
+
+- Is expected to send zero or more sidebar items to the `provider` in the below-defined format. 
+
+## Relation Data
+
+### Requirer
+
+[\[JSON Schema\]](./schemas/requirer.json)
+
+The requirer specifies zero or more sidebar items in the required format.
+
+#### Example
+
+```json
+[
+  {
+    "text": "Some link text",
+    "link": "/some-relative-link",
+    "type": "item",
+    "icon": "assessment"
+  },
+  {
+    "text": "Some other link text",
+    "link": "/some-other-relative-link",
+    "type": "item",
+    "icon": "book"
+  }
+
+]
+```
+
+### Provider
+
+The `provider` sends no data on this interface.

interfaces/kubeflow_dashboard_sidebar/v0/charms.yaml

@@ -0,0 +1,4 @@
+providers:
+  - name: kubeflow-dashboard
+    url: https://github.com/canonical/kubeflow-dashboard-operator
+requirers: []

interfaces/kubeflow_dashboard_sidebar/v0/schema.py

@@ -0,0 +1,46 @@
+# Copyright 2023 Canonical
+# See LICENSE file for licensing details.
+"""This file defines the schemas for the provider and requirer sides of the kubeflow-dashboard-sidebar interface.
+
+Examples:
+    RequirerSchema:
+        unit: <empty>
+        app: [
+                {
+                    "text": "some link text",
+                    "link": "/some-link",
+                    "type": "item",
+                    "icon": "book"
+                }
+            ]
+"""
+from typing import List
+import yaml
+from pydantic import BaseModel, AnyHttpUrl, validator
+
+from interface_tester.schema_base import DataBagSchema
+
+
+class SidebarItem(BaseModel):
+    """Representation of a Kubeflow Dashboard sidebar entry.
+
+    See https://www.kubeflow.org/docs/components/central-dash/customizing-menu/ for more details.
+
+    Args:
+        text: The text shown in the sidebar
+        link: The relative link within the host (eg: /runs, not http://.../runs)
+        type: A type of sidebar entry (typically, "item")
+        icon: An icon for the link, from
+              https://kevingleason.me/Polymer-Todo/bower_components/iron-icons/demo/index.html
+    """
+
+    text: str
+    link: str
+    type: str  # noqa: A003
+    icon: str
+
+
+class RequirerSchema(DataBagSchema):
+    """Requirer schema for Ingress."""
+
+    app: List[SidebarItem]