From e0b24bdaf7fc700aba0a2f41da968c060ef6a84e Mon Sep 17 00:00:00 2001
From: Megan Henning <meganhenning@flywheel.io>
Date: Thu, 22 Feb 2018 17:21:09 -0600
Subject: [PATCH] Add range read and other info to file swagger
---
swagger/templates/file-item.yaml | 34 +++++++++++++++++++++++++-------
1 file changed, 27 insertions(+), 7 deletions(-)
diff --git a/swagger/templates/file-item.yaml b/swagger/templates/file-item.yaml
index cfd5a903..a6e436b3 100644
--- a/swagger/templates/file-item.yaml
+++ b/swagger/templates/file-item.yaml
@@ -18,11 +18,15 @@ template: |
get:
summary: Download a file.
description: |
- If "ticket" is specified by empty, a download ticket will be created
- If "ticket" is not specified, the file will be download
- If "ticket" is specified and not empty, the file will be downloaded
+ Files can be downloaded directly from this endpoint with a valid "Authorization" header or via a ticket id.
+
+ To generate a ticket:
+ - Make a request with an empty "ticket" parameter and a valid "Authorization" header. The server will respond with a generated ticket id.
+ - Make another request with the received ticket id in the "ticket" parameter. A valid "Authorization" header is no longer required.
+
+ When "view" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported.
operationId: download_{{resource}}_file
- tags:
+ tags:
- '{{tag}}'
produces:
- application/json
@@ -31,8 +35,24 @@ template: |
- name: ticket
in: query
type: string
- description: ticket id of the file to download
-
+ description: The generated ticket id for the download, or present but empty to generate a ticket id.
+ - name: view
+ in: query
+ type: boolean
+ default: false
+ description: |
+ If true, the proper "Content-Type" header based on the file's mimetype is set on response
+ If false, the "Content-Type" header is set to "application/octet-stream"
+ - name: info
+ in: query
+ type: boolean
+ default: false
+ description: If the file is a zipfile, return a json response of zipfile member information
+ - name: member
+ in: query
+ type: string
+ description: The filename of a zipfile member to download rather than the entire file
+
responses:
'200':
description: ''
@@ -44,7 +64,7 @@ template: |
post:
summary: Replace a file
operationId: replace_{{resource}}_file
- tags:
+ tags:
- '{{tag}}'
responses:
default:
--
GitLab