Code review changes for comments and reorganizing functions.

Author: nmaludy

actions/files.upload.yaml

@@ -17,16 +17,16 @@ parameters:
     type: string
   content:
     required: false
-    description: "File contents via a POST variable. If omitting this parameter, you must provide a `file`."
+    description: "File contents via a POST variable. If omitting this parameter, you must provide either `file` or `content`."
     type: string
   file:
     required: false
-    description: "File contents via `multipart/form-data`. If omitting this parameter, you must submit `content`."
+    description: "File contents via `multipart/form-data`. If omitting this parameter, you must provide either `file` or `content`."
     type: string
   file_path:
     required: false
     default: ""
-    description: "Path to the file on the local filesystem that will be opened, read and uploaded to Slack. If omitting this parameter, you must submit either `file` or `content`."
+    description: "Path to the file on the local filesystem that will be opened, read and uploaded to Slack. If omitting this parameter, you must provide either `file` or `content`."
     type: string
   filename:
     required: false

actions/files_upload.py

@@ -20,4 +20,4 @@ def run(self, **kwargs):
             kwargs.pop('file', None)
             kwargs.pop('file_path')
 
-        self._do_request(kwargs, files)
+        super(FilesUploadAction, self).run(files=files, **kwargs)

actions/run.py

@@ -12,10 +12,8 @@
 
 class SlackAction(Action):
 
-    def run(self, **kwargs):
-        return self._do_request(kwargs)
-
-    def _do_request(self, params, files=None):
+    def run(self, files=None, **kwargs):
+        params = kwargs
         if params.get('token', None) is None:
             params['token'] = self.config['action_token']
 
@@ -67,12 +65,12 @@ def encode_dict(in_dict):
                 # upload files. Instead we need requests to create a unique
                 # Content-Type: multipart/formdata; boundary-----XYZ123
                 # This Content-Type and boundary string is unique will be generated
-                # automatically for us if we do no specify a Content-Type.
+                # automatically for us if we do not specify a Content-Type.
                 # If we specify headers here with a Content-Type then file uploads
                 # will not work and return mysterious errors
                 headers.pop('Content-Type', None)
 
-                # We're passing data as the params dict instead of
+                # We're passing the params dict into the data parameter instead of
                 # the URL encoded string 'data' from above, this is critical too
                 # so that all of the additional parameters will be included as
                 # multipart/formdata pieces. If you pass in the URL encoded data string

bin/generate_openapi.py

@@ -20,11 +20,24 @@
     'files.upload': {
         'entry_point': 'files_upload.py',
         'parameters': {
+            # overriding content and file to modify their descriptions
+            'content': {
+                'name': 'content',
+                'type': 'string',
+                'required': False,
+                'description': 'File contents via a POST variable. If omitting this parameter, you must provide either `file` or `content`.',  # noqa: E501
+            },
+            'file': {
+                'name': 'file',
+                'type': 'string',
+                'required': False,
+                'description': 'File contents via `multipart/form-data`. If omitting this parameter, you must provide either `file` or `content`.',  # noqa: E501
+            },
             'file_path': {
                 'name': 'file_path',
                 'type': 'string',
                 'required': False,
-                'description': 'Path to the file on the local filesystem that will be opened, read and uploaded to Slack. If omitting this parameter, you must submit either `file` or `content`.',  # noqa: E501
+                'description': 'Path to the file on the local filesystem that will be opened, read and uploaded to Slack. If omitting this parameter, you must provide either `file` or `content`.',  # noqa: E501
             }
         }
     }