Skip to content

Commit

Permalink
Merge pull request #10 from OS2borgerPC/script_metadata_add_version_a…
Browse files Browse the repository at this point in the history
…nd_metadata_documentation

add version and metadata documentation
  • Loading branch information
agnetemoos authored Dec 19, 2024
2 parents eef9230 + 2aa67d0 commit 82ea195
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/teknisk dokumentation/script_metadata.md
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 |


0 comments on commit 82ea195

Please sign in to comment.