update additional files

Signed-off-by: James Russo <jrusso@brex.com>
This commit is contained in:
James Russo
2022-06-15 10:03:37 -04:00
parent 1380b389dc
commit 90fb26a514
2 changed files with 10 additions and 1 deletions
@@ -55,6 +55,7 @@ metadata:
- url: https://admin.example-org.com
title: Admin Dashboard
icon: dashboard
type: admin-dashboard
spec:
type: website
lifecycle: production
@@ -83,7 +84,8 @@ This is the same entity as returned in JSON from the software catalog API:
{
"url": "https://admin.example-org.com",
"title": "Admin Dashboard",
"icon": "dashboard"
"icon": "dashboard",
"type": "admin-dashboard"
}
],
"tags": ["java"],
@@ -353,6 +355,7 @@ Fields of a link are:
| `url` | String | [Required] A `url` in a standard `uri` format (e.g. `https://example.com/some/page`) |
| `title` | String | [Optional] A user friendly display name for the link. |
| `icon` | String | [Optional] A key representing a visual icon to be displayed in the UI. |
| `type` | String | [Optional] An optional value to categorize links into specific groups. |
_NOTE_: The `icon` field value is meant to be a semantic key that will map to a
specific icon that may be provided by an icon library (e.g. `material-ui`
@@ -108,6 +108,12 @@
"description": "A key representing a visual icon to be displayed in the UI.",
"examples": ["dashboard"],
"minLength": 1
},
"type": {
"type": "string",
"description": "An optional value to categorize links into specific groups.",
"examples": ["runbook", "documentation", "logs", "dashboard"],
"minLength": 1
}
}
}