-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger.yaml
83 lines (82 loc) · 2.4 KB
/
swagger.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
swagger: "2.0"
info:
description: "This is a small application to display file information from a user's file system"
version: "1.0.0"
title: "Directory Hunt"
termsOfService: "http://swagger.io/terms/"
contact:
email: "[email protected]"
license:
name: "Apache 2.0"
url: "http://www.apache.org/licenses/LICENSE-2.0.html"
schemes:
- "http"
paths:
/:
get:
summary: "Returns information regarding files in a directory"
description: "Specifics include permissions, owner, group, size of file, names of files"
produces:
- "application/json"
parameters: []
responses:
"200":
description: "successful operation"
schema:
type: "array"
items:
type: "object"
properties:
permission:
type: "string"
example: "drwxr-xr-x"
owner:
type: "string"
example: "therealslimhsiehdy"
group:
type: "string"
example: "staff"
size:
type: "integer"
example: 256
name:
type: "string"
example: "file_name"
/{path}:
get:
summary: "Returns information regarding files in a directory"
description: "Specifics include permissions, owner, group, size of file, names of files"
produces:
- "application/json"
parameters:
- in: path
name: path
type: "string"
required: true
description: "an added path folder provided by user"
responses:
"200":
description: "successful operation"
schema:
type: "array"
items:
type: "object"
properties:
permission:
type: "string"
example: "drwxr-xr-x"
owner:
type: "string"
example: "therealslimhsiehdy"
group:
type: "string"
example: "staff"
size:
type: "integer"
example: 512
name:
type: "string"
example: "file_name"
externalDocs:
description: "Find out more about Swagger"
url: "http://swagger.io"