Enhance documentation generation with parameter details and return types for GLS functions

Author: Knerio

actions/gls-action/scripts/generateDocs.ts

@@ -255,6 +255,54 @@ interface FunctionDefinition {
 }
 
 async function generateFunctions(sdk: ActionSdk): Promise<string> {
+    function getParamInfo(signature: string, paramName: string): { optional: boolean; type: string | null } {
+        const paramsMatch = signature.match(/\((.*)\)/s);
+        if (!paramsMatch) {
+            return {optional: false, type: null};
+        }
+
+        const params = paramsMatch[1].split(",");
+
+        for (const param of params) {
+            const trimmed = param.trim();
+
+            // Match: name?: type OR name: type
+            const match = trimmed.match(new RegExp(`${paramName}\s*(\\?)?\\s*:\\s*(.+)`));
+            if (match) {
+                const isOptional = match[1] === "?";
+                const type = match[2].trim();
+
+                return {
+                    optional: isOptional,
+                    type
+                };
+            }
+        }
+
+        return {optional: false, type: null};
+    }
+
+    function generateMarkdownTable(headers: string[], rows: string[][]) {
+        const headerRow = `| ${headers.join(' | ')} |`;
+        const separator = `| ${headers.map(() => '---').join(' | ')} |`;
+        const bodyRows = rows.map(row => `| ${row.join(' | ')} |`);
+
+        return [headerRow, separator, ...bodyRows].join('\n');
+    }
+    function getLinkFromType(typeName?: string) {
+        if (!typeName || !typeName.startsWith("GLS_")) return typeName
+        switch (typeName) { // Some edge cases
+            case "SHIPMENT_UNIT_SERVICE": {
+                typeName = "SHIPMENT_UNIT$Service"
+                break
+            }
+        }
+        const normalizedName = typeName.toLowerCase()
+            .replace(/-/g, "_")
+            .replace(/\$/g, "");
+        return `[${typeName}](./types.mdx#${normalizedName})`
+    }
+
     async function loadFunctions(modules: Record<string, () => Promise<unknown>>) {
         for (const path in modules) {
 
@@ -343,9 +391,33 @@ All shipment functions accept a common set of parameters in addition to their ty
                 displayMessages: definition.displayMessage
             }
 
+            const headers = ["Parameter", "Name", "Type", "Required", "Description"]
+
+            let rows = []
+
+            definition.parameters.forEach(param => {
+                const paramInfo = getParamInfo(definition.signature, param.runtimeName);
+
+                paramInfo.type = getLinkFromType(paramInfo.type);
+
+                rows.push([
+                    param.runtimeName,
+                    param.name[0].content,
+                    paramInfo.type?.replace(/\|/g, "\\|") || "Unknown",
+                    paramInfo.optional ? "No" : "Yes",
+                    param.description[0].content
+                ])
+            })
+
             generatedDoc += `
 ### \`${definition.runtimeName}\`
 
+${generateMarkdownTable(headers, rows)}
+
+Return Type: ${getLinkFromType(definition.signature.split("):")[1].trim())}
+
+#
+
 ${definition.documentation?.at(0).content || ""}
         
 <FunctionCard definition={

actions/gls-action/src/functions/services/createShopReturnShipment.ts

@@ -42,17 +42,17 @@ export default (sdk: ActionSdk) => {
                 signature: `(numberOfLabels: number, ${DEFAULT_SIGNATURE_FOR_SERVICES}, returnQR: "PDF" | "PNG" | "ZPL"): GLS_CREATE_PARCELS_RESPONSE`,
                 parameters: [
                     {
-                        runtimeName: "parcelShopId",
+                        runtimeName: "numberOfLabels",
                         name: [
                             {
                                 code: "en-US",
-                                content: "Parcel shop Id",
+                                content: "The number of labels",
                             }
                         ],
                         description: [
                             {
                                 code: "en-US",
-                                content: "The ID of the parcel shop where the shipment should be delivered.",
+                                content: "The number of labels to be created for the return shipment.",
                             }
                         ]
                     },

actions/gls-action/src/functions/utils/createAddress.ts

@@ -18,7 +18,7 @@ export default (sdk: ActionSdk) => {
                         content: "Create address"
                     }
                 ],
-                signature: "Name1: string, CountryCode: string, City: string, Street: string, ZIPCode: string, Name2?: string, Name3?: string, Province?: string, StreetNumber?: string, ContactPerson?: string, FixedLinePhonenumber?: string, MobilePhonenumber?: string, Email?: string): GLS_ADDRESS",
+                signature: "(Name1: string, CountryCode: string, City: string, Street: string, ZIPCode: string, Name2?: string, Name3?: string, Province?: string, StreetNumber?: string, ContactPerson?: string, FixedLinePhonenumber?: string, MobilePhonenumber?: string, Email?: string): GLS_ADDRESS",
                 name: [
                     {
                         code: "en-US",