Zum Inhalt

Dateistruktur

Eine Datei beschreibt eine Funktion. Legen Sie die Datei an einer beliebigen Stelle innerhalb Ihres function_directory ab, auch in einem Unterordner, und verwenden Sie die Endung .yaml oder .yml. Der Dateiname selbst ist unerheblich: Der Funktionsname stammt aus dem Feld name in der Datei.

Eine eigene Funktion pro Datei definieren

Datei einer eigenen Funktion
name: my-function          # required, must be unique and not reserved
run: "echo {{.args}}"      # required, the command to run
params:                    # optional list of parameters
  - name: args             # required for each parameter
    type: string           # optional: string (default), int, or bool
    required: true         # optional, default false
    default: ""            # optional value used when not provided
    description: Ein Text  # optional note for yourself

Felder auf oberster Ebene

Feld Erforderlich Bedeutung
name ja Der Name, den Schaltflächen in ihrem Feld function verwenden
run ja Der auszuführende Befehl mit Platzhaltern für Werte
params nein Liste der benannten Werte, die die Funktion akzeptiert

Eine Funktion ganz ohne params ist gültig; run ist dann ein fester Befehl.

Parameterfelder

Feld Erforderlich Standardwert Bedeutung
name ja — Der in {{.name}} innerhalb von run verwendete Name
type nein string Werttyp: string, int oder bool
required nein false Eine Schaltfläche muss einen Wert bereitstellen
default nein leer Wird verwendet, wenn kein Wert angegeben wurde
description nein leer Eine Notiz für Sie selbst, die nicht in Telegram angezeigt wird

type wird geprüft

Als int deklarierte Werte und Standardwerte müssen eine Ganzzahl enthalten. Als bool deklarierte Werte und Standardwerte müssen einen gültigen booleschen Wert enthalten. Ungültige Werte lassen validate fehlschlagen.

Schaltflächenschlüssel entsprechen den Parameternamen

Schreiben Sie jeden Parameter mit demselben Namen direkt auf eine Schaltfläche. Namen wie url, host und lines funktionieren neben command, path und args. Siehe Werte von einer Schaltfläche übergeben.

Ordnerstruktur

Sie können den Ordner beliebig organisieren:

Unterordner werden ebenfalls gelesen

functions/
functions/
  disk.yaml
  logs/
    nginx.yaml
    app.yml

Alle drei Dateien werden geladen. Dateien mit anderen Endungen werden übersprungen.

Verwandte Themen