functionbuilder

build/app/models/post_params_body.go

@@ -8,8 +8,10 @@ package models
 import (
 	"context"
 
+	"github.com/go-openapi/errors"
 	"github.com/go-openapi/strfmt"
 	"github.com/go-openapi/swag"
+	"github.com/go-openapi/validate"
 )
 
 // PostParamsBody post params body
@@ -21,14 +23,47 @@ type PostParamsBody struct {
 	Infile string `json:"infile,omitempty"`
 
 	// the filename of the output spreadsheet
-	OutFilename *string `json:"out-filename,omitempty"`
+	// Required: true
+	OutFilename *string `json:"out-filename"`
 
 	// Label for the worksheet created in the spreadsheet
-	WorksheetName *string `json:"worksheet-name,omitempty"`
+	// Required: true
+	WorksheetName *string `json:"worksheet-name"`
 }
 
 // Validate validates this post params body
 func (m *PostParamsBody) Validate(formats strfmt.Registry) error {
+	var res []error
+
+	if err := m.validateOutFilename(formats); err != nil {
+		res = append(res, err)
+	}
+
+	if err := m.validateWorksheetName(formats); err != nil {
+		res = append(res, err)
+	}
+
+	if len(res) > 0 {
+		return errors.CompositeValidationError(res...)
+	}
+	return nil
+}
+
+func (m *PostParamsBody) validateOutFilename(formats strfmt.Registry) error {
+
+	if err := validate.Required("out-filename", "body", m.OutFilename); err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func (m *PostParamsBody) validateWorksheetName(formats strfmt.Registry) error {
+
+	if err := validate.Required("worksheet-name", "body", m.WorksheetName); err != nil {
+		return err
+	}
+
 	return nil
 }
 

build/app/restapi/embedded_spec.go

@@ -67,6 +67,10 @@ func init() {
             "in": "body",
             "schema": {
               "type": "object",
+              "required": [
+                "worksheet-name",
+                "out-filename"
+              ],
               "properties": {
                 "infile": {
                   "description": "Name of the json input file to utilise",
@@ -99,7 +103,7 @@ func init() {
               "additionalProperties": false
             },
             "examples": {
-              "export-excel": "JVBERi0xLjUKJdDUxdgKNSAwIG9iago8PAov=="
+              "export-excel": "{\"export-excel\": \"JVBERi0xLjUKJdDUxdgKNSAwIG9iago8PAov==\"}"
             }
           },
           "default": {
@@ -258,7 +262,7 @@ func init() {
               "$ref": "#/definitions/postOKBody"
             },
             "examples": {
-              "export-excel": "JVBERi0xLjUKJdDUxdgKNSAwIG9iago8PAov=="
+              "export-excel": "{\"export-excel\": \"JVBERi0xLjUKJdDUxdgKNSAwIG9iago8PAov==\"}"
             }
           },
           "default": {
@@ -367,6 +371,10 @@ func init() {
     },
     "postParamsBody": {
       "type": "object",
+      "required": [
+        "worksheet-name",
+        "out-filename"
+      ],
       "properties": {
         "infile": {
           "description": "Name of the json input file to utilise",

readme.md

@@ -66,7 +66,7 @@ functions:
 #### Example Reponses
     
 ```json
-"JVBERi0xLjUKJdDUxdgKNSAwIG9iago8PAov=="
+"{\"export-excel\": \"JVBERi0xLjUKJdDUxdgKNSAwIG9iago8PAov==\"}"
 ```
 
 ### Errors
@@ -102,7 +102,7 @@ functions:
 | Name | Type | Go type | Required | Default | Description | Example |
 |------|------|---------|:--------:| ------- |-------------|---------|
 | infile | string| `string` |  | | Name of the json input file to utilise |  |
-| 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 |  |
+| 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 |  |