Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add version and metadata documentation #10

Merged
merged 1 commit into from
Dec 19, 2024
Merged

add version and metadata documentation #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/teknisk dokumentation/script_metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,12 @@ Script metadata variables
| Variable | Description | Required |
| ------------- | ------------------------------------------------------------ | --------- |
| `title` | The title of the script. | Required |
| `version` | The version of the script. | Required |
| `parent` | The script category. There can be only one. Supported values are: `Browser`, `Desktop`, `Fejlfinding`, `Kiosk`, `Login`, `Lyd`, `Opgradering`, `Printer`, `Programmer`, `Sikkerhed`, `Skanner`, `System`, `Udfases`| Required |
| `source` | The relative path to the script-file (.sh/.py) from the metadata-file. | Required |
| `parameters` | The list of parameters that the script expects to receive. <br> Each parameter is described by an array of 4 key/value pairs. <br> - `name`: The name of the parameter<br> - `type`: Supported values are `boolean`, `string`, `int`, `text_field`, `file`, `password`<br> - `default`: Default value of the parameter. `null` if none.<br> - `mandatory`: Required parameter? `true` or `false` <br> If the script expects leave the parameters-variable empty. | Required |
| `compatibility` | Info about image and version compatibility. Supported values are: `20.04`, `22.04`, `24.04`, `BorgerPC` and `Kiosk`. More than one value can be supplied.| Optional |
|`in_image`| Sometimes scripts get absorbed by the images, meaning that the script functionality is built into the image (borgerpc/kiosk) thereby making the script obsolete. When this happens please provide the image name and version tag here.| Optional |
| `metadata` | Information that is used to control how the script is referenced and displayed in the admin-site. <br> Supported optional properties are: <br> `hidden`: Should the script be visible in admin-site UI? `true` or `false`. Defaults to `false` <br> `security`: Should the script be shown in 'Sikkerhedsscripts' in admin-site UI? `true` or `false`. Defaults to `false` <br> `uid`: Special scripts that the admin-site needs to reference. The uid *must* be unique, which also implies that only one version can be present in admin-site at any given time. `string`. Defaults to `null` | Optional |


Loading