From c54786b950734b46bf1f06564679124f0e6beb5b Mon Sep 17 00:00:00 2001 From: flemming-it Date: Mon, 1 Jun 2026 22:46:14 +0200 Subject: [PATCH] feat: schema_version 3 with DE/EN field descriptions Signed-off-by: flemming-it --- module.yaml | 112 +++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 80 insertions(+), 32 deletions(-) diff --git a/module.yaml b/module.yaml index cb84768..fbca848 100644 --- a/module.yaml +++ b/module.yaml @@ -1,46 +1,94 @@ -schema_version: 2 +schema_version: 3 provider: fai name: http-request version: 0.1.0 -# Capability provided by this module. provides: - capability: http.request version: 0.1.0 -# Inputs the invoke function accepts. inputs: - # HTTP method as uppercase string. Supported: GET, POST, - # PUT, PATCH, DELETE, HEAD, OPTIONS. - method: text - # Full URL including scheme. Must be https:// for production - # use; http:// is permitted so loopback and air-gapped - # internal services work, but operator policy can clamp it. - url: text - # Optional headers as JSON object string, e.g. - # '{"Accept":"application/json","X-Tenant":"acme"}'. Empty - # string means no extra headers (Content-Type is auto-set - # when `body` is non-empty and the input is not already a - # JSON-shaped string). - headers: text - # Optional request body. Treated as UTF-8 text — binary - # payloads should use a future `http.request-bytes` variant. - body: text + method: + type: text + description: + en: | + HTTP method as uppercase string. Supported: GET, POST, + PUT, PATCH, DELETE, HEAD, OPTIONS. + de: | + HTTP-Methode in Großbuchstaben. Unterstützt: GET, POST, + PUT, PATCH, DELETE, HEAD, OPTIONS. + url: + type: text + description: + en: | + Full URL including scheme. Use https:// for production; + http:// is permitted so loopback and air-gapped internal + services work, but operator policy can clamp it. + de: | + Vollständige URL inkl. Schema. https:// für Produktion; + http:// erlaubt für Loopback / interne Services, kann + per Operator-Policy eingeschränkt werden. + headers: + type: text + description: + en: | + Optional headers as JSON object string, e.g. + '{"Accept":"application/json","X-Tenant":"acme"}'. + Empty = no extra headers (Content-Type is auto-set when + body is non-empty and not already JSON-shaped). + de: | + Optionale Header als JSON-Objekt-String, z. B. + '{"Accept":"application/json","X-Tenant":"acme"}'. + Leer = keine zusätzlichen Header (Content-Type wird + automatisch gesetzt, wenn body nicht-leer und nicht + bereits JSON-geformt ist). + body: + type: text + description: + en: | + Optional request body. Treated as UTF-8 text — binary + payloads should use a future `http.request-bytes` + variant. + de: | + Optionaler Request-Body. UTF-8-Text — binäre Payloads + sollen eine künftige `http.request-bytes`-Variante + nutzen. -# Outputs produced. outputs: - # HTTP status code as decimal text (e.g. "200", "404"). - # Text rather than number so the audit-log entry stays - # operator-readable without JSON re-parsing. - status: text - # Response headers serialised as a JSON object (same shape - # as the input format) so downstream flow steps can pluck - # values like Content-Type or rate-limit headers. - headers: text - # Response body as UTF-8 text. Non-UTF-8 responses come - # through with replacement characters; that's acceptable - # for v0.1.0 since the bytes-shaped variant covers binary. - body: text + status: + type: text + description: + en: | + HTTP status code as decimal text (e.g. "200", "404"). + Text rather than number so the audit-log entry stays + operator-readable without JSON re-parsing. + de: | + HTTP-Statuscode als Dezimal-Text (z. B. "200", "404"). + Text statt Zahl, damit der Audit-Log-Eintrag ohne + JSON-Re-Parsing operator-lesbar bleibt. + headers: + type: text + description: + en: | + Response headers serialised as a JSON object (same shape + as the input format) so downstream flow steps can pluck + values like Content-Type or rate-limit headers. + de: | + Response-Header als JSON-Objekt serialisiert (gleiche + Form wie das Input-Format), damit nachgelagerte Schritte + Werte wie Content-Type oder Rate-Limit-Header abgreifen + können. + body: + type: text + description: + en: | + Response body as UTF-8 text. Non-UTF-8 responses come + through with replacement characters; binary uses the + bytes-shaped variant (future). + de: | + Response-Body als UTF-8-Text. Nicht-UTF-8-Antworten + kommen mit Replacement-Zeichen durch; binär verwendet + die bytes-Variante (zukünftig). # Permissions required. #