functionbuilder

readme.md

@@ -0,0 +1,107 @@
+
+# export-xlsx 1.0
+
+Transform json input to xlsx spreadsheet
+
+---
+- #### Categories: unknown
+- #### Image: registry.coadcorp.com/export-xlsx:1.0 
+- #### License: [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0)
+- #### Issue Tracking: https://git.coadcorp.com/nathan/export-xlsx/issues
+- #### URL: https://git.coadcorp.com/nathan/export-xls
+- #### Maintainer: [nathan.coad@dell.com](nathan.coad@dell.com)
+---
+
+## About export-xlsx
+
+Transform json input to excel spreadsheet via json2excel command
+
+### Example(s)
+  #### Function Configuration
+```yaml
+functions:
+- id: export-xlsx
+  image: registry.coadcorp.com/export-xlsx:1.0
+  type: knative-workflow
+```
+   #### Basic
+```yaml
+- id: export-xlsx
+  type: action
+  action:
+    function: export-xlsx
+    input: 
+      files:
+      - name: input.json
+        data: |
+          jq(.input)                  
+      worksheet-name: "TestSpreadsheet"
+      out-filename: example.xlsx
+```
+
+   ### Secrets
+
+
+- **export-xlsxSecret**: This is a secret value
+
+
+
+
+
+
+### Request
+
+
+
+#### Request Attributes
+[PostParamsBody](#post-params-body)
+
+### Response
+  List of executed commands.
+#### Reponse Types
+    
+  
+
+[PostOKBody](#post-o-k-body)
+#### Example Reponses
+    
+```json
+"JVBERi0xLjUKJdDUxdgKNSAwIG9iago8PAov=="
+```
+
+### Errors
+| Type | Description
+|------|---------|
+| io.direktiv.command.error | Command execution failed |
+| io.direktiv.output.error | Template error for output generation of the service |
+| io.direktiv.ri.error | Can not create information object from request |
+
+
+### Types
+#### <span id="post-o-k-body"></span> postOKBody
+
+  
+
+
+
+**Properties**
+
+| Name | Type | Go type | Required | Default | Description | Example |
+|------|------|---------|:--------:| ------- |-------------|---------|
+| export-excel | string| `string` |  | |  |  |
+
+
+#### <span id="post-params-body"></span> postParamsBody
+
+  
+
+
+
+**Properties**
+
+| Name | Type | Go type | Required | Default | Description | Example |
+|------|------|---------|:--------:| ------- |-------------|---------|
+| out-filename | string| `string` |  | `"output.xlsx"`| the filename of the output spreadsheet |  |
+| worksheet-name | string| `string` |  | `"Sheet1"`| Label for the worksheet created in the spreadsheet |  |
+
+