paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 40 Packages Projects Releases Wiki Activity

Update descriptor-format.md

Browse Source 
Adding table for profile fields.

Signed-off-by: Tyler Wray <wraytw@gmail.com>
This commit is contained in:
Tyler Wray
2024-02-13 15:30:53 -07:00
committed by GitHub
parent 04547bc042
commit c04d4bcc9d
1 changed files with 16 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/features/software-catalog/descriptor-format.md
+16
View File
@@ -955,6 +955,14 @@ some form, that the group may wish to be used for contacting them. The picture
is expected to be a URL pointing to an image that's representative of the group,
and that a browser could fetch and render on a group page or similar.
The fields of a profile are:
| Field | Type | Description |
| ------------------------ | ------ | -------------------------------------------------------------- |
| `displayName` (optional) | String | A human-readable name for the group. |
| `email` (optional) | String | An email the group may wish to be used for contacting them. |
| `picture` (optional) | String | A URL pointing to an image that's representative of the group. |
### `spec.parent` [optional]
The immediate parent group in the hierarchy, if any. Not all groups must have a
@@ -1040,6 +1048,14 @@ of some form, that the user may wish to be used for contacting them. The picture
is expected to be a URL pointing to an image that's representative of the user,
and that a browser could fetch and render on a profile page or similar.
The fields of a profile are:
| Field | Type | Description |
| ------------------------ | ------ | -------------------------------------------------------------- |
| `displayName` (optional) | String | A human-readable name for the group. |
| `email` (optional) | String | An email the group may wish to be used for contacting them. |
| `picture` (optional) | String | A URL pointing to an image that's representative of the group. |
### `spec.memberOf` [required]
The list of groups that the user is a direct member of (i.e., no transitive