add docs make command

Author: devyetii

Makefile

@@ -188,3 +188,8 @@ else
 	sed -i "s/BUF_VERSION := [0-9][0-9]*\.[0-9][0-9]*\.[0-9][0-9]*/BUF_VERSION := $(VERSION)/g" Makefile
 endif
 endif
+
+.PHONY: markdown-docs
+markdown-docs:
+	swagger generate spec -o ./swagger.yaml -w ./code/go/0chain.net -m
+	swagger generate markdown -f ./swagger.yaml --output=swagger.md

swagger.md

@@ -34,7 +34,7 @@ Documentation of the blobber API.
 | GET | /v1/connection/create/{allocation} | [connection handler](#connection-handler) |  |
 | GET | /v1/file/copy/{allocation} | [copyallocation](#copyallocation) |  |
 | GET | /v1/dir/{allocation} | [createdirhandler](#createdirhandler) |  |
-| POST | /v1/file/download/{allocation} | [download file](#download-file) | DownloadHandler is the handler to respond to download requests from clients. |
+| POST | /v1/file/download/{allocation} | [download file](#download-file) |  |
 | GET | /v1/file/list/{allocation} | [list](#list) |  |
 | GET | /v1/file/move/{allocation} | [moveallocation](#moveallocation) |  |
 | GET | /v1/file/refs/recent/{allocation} | [recentalloc](#recentalloc) |  |
@@ -297,12 +297,14 @@ Status: Internal Server Error
 
 ###### <span id="createdirhandler-500-schema"></span> Schema
 
-### <span id="download-file"></span> DownloadHandler is the handler to respond to download requests from clients. (*downloadFile*)
+### <span id="download-file"></span> download file (*downloadFile*)
 
 ```
 POST /v1/file/download/{allocation}
 ```
 
+Download Handler (downloadFile)
+
 #### Parameters
 
 | Name | Source | Type | Go type | Separator | Required | Default | Description |
@@ -321,7 +323,7 @@ POST /v1/file/download/{allocation}
 | X-Path | `header` | string | `string` |  | ✓ |  | The path of the file to download. |
 | X-Path-Hash | `header` | string | `string` |  |  |  | The hash of the path of the file to download. If not provided, will be calculated from "X-Path" parameter. |
 | X-Read-Marker | `header` | string | `string` |  |  |  | The read marker to use for the download (check [ReadMarker](#/responses/ReadMarker)). |
-| X-Verify-Download | `header` | string | `string` |  |  |  | If set to "true", the download should be verified. If the mode is "thumbnail", |
+| X-Verify-Download | `header` | string | `string` |  |  |  | If set to "true", the download should be verified. If the mode is "thumbnail",\ |
 | X-Version | `header` | string | `string` |  |  |  | If its value is "v2" then both allocation_id and blobber url base are hashed and verified using X-App-Client-Signature-V2. |
 
 #### All responses

swagger.yaml

@@ -612,6 +612,7 @@ paths:
                     description: ""
     /v1/file/download/{allocation}:
         post:
+            description: Download Handler (downloadFile)
             operationId: downloadFile
             parameters:
                 - description: TxHash of the allocation in question.
@@ -665,14 +666,33 @@ paths:
                   in: header
                   name: X-Auth-Token
                   type: string
+                - description: Download mode. Either "full" for full file download, or "thumbnail" to download the thumbnail of the file
+                  in: header
+                  name: X-Mode
+                  type: string
+                - description: If set to "true", the download should be verified. If the mode is "thumbnail",\
+                  in: header
+                  name: X-Verify-Download
+                  type: string
+                - description: If its value is "v2" then both allocation_id and blobber url base are hashed and verified using X-App-Client-Signature-V2.
+                  in: header
+                  name: X-Version
+                  type: string
+                - description: Digital signature of the client used to verify the request if the X-Version is not "v2"
+                  in: header
+                  name: X-App-Client-Signature
+                  type: string
+                - description: Digital signature of the client used to verify the request if the X-Version is "v2"
+                  in: header
+                  name: X-App-Client-Signature-V2
+                  type: string
             responses:
                 "200":
-                    description: FileDownloadResponse
+                    description: '| []byte'
                     schema:
                         $ref: '#/definitions/FileDownloadResponse'
                 "400":
                     description: ""
-            summary: DownloadHandler is the handler to respond to download requests from clients.
     /v1/file/list/{allocation}:
         get:
             description: "ListHandler is the handler to respond to list requests from clients, \nit returns a list of files in the allocation,\nalong with the metadata of the files."