From 2aa67d0e2c257349a01ba89c299f6cc2521fe51d Mon Sep 17 00:00:00 2001
From: sunekochhansen <34162776+sunekochhansen@users.noreply.github.com>
Date: Thu, 19 Dec 2024 09:39:47 +0100
Subject: [PATCH] add version and metadata documentation
---
docs/teknisk dokumentation/script_metadata.md | 2 ++
1 file changed, 2 insertions(+)
diff --git a/docs/teknisk dokumentation/script_metadata.md b/docs/teknisk dokumentation/script_metadata.md
index 8647492..aaf6210 100644
--- a/docs/teknisk dokumentation/script_metadata.md
+++ b/docs/teknisk dokumentation/script_metadata.md
@@ -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.
Each parameter is described by an array of 4 key/value pairs.
- `name`: The name of the parameter
- `type`: Supported values are `boolean`, `string`, `int`, `text_field`, `file`, `password`
- `default`: Default value of the parameter. `null` if none.
- `mandatory`: Required parameter? `true` or `false`
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.
Supported optional properties are:
`hidden`: Should the script be visible in admin-site UI? `true` or `false`. Defaults to `false`
`security`: Should the script be shown in 'Sikkerhedsscripts' in admin-site UI? `true` or `false`. Defaults to `false`
`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 |