-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger-app.yaml
173 lines (173 loc) · 4.52 KB
/
swagger-app.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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
swagger: "2.0"
info:
description: "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters."
version: "1.0.0"
title: "Swagger Meli-App"
termsOfService: "http://swagger.io/terms/"
contact:
email: "jayjango@swagger.io"
license:
name: "Apache 2.0"
url: "http://www.apache.org/licenses/LICENSE-2.0.html"
host: "rescue.swagger.io"
basePath: "/v2"
tags:
- name: "rescue"
description: "Everything about rescue the different spaceships lost in the space"
externalDocs:
description: "Find out more"
url: "http://swagger.io"
schemes:
- "https"
- "http"
paths:
/topsecret:
post:
tags:
- "rescue"
summary: "Return information about position and message sent by some spaceship lost"
operationId: "searchPositionAndMessage"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "TransmissionRequest data necessary to find location and message of the spaceships lost"
required: true
schema:
$ref: "#/definitions/TransmissionRequest"
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/TransmissionResponse"
"405":
description: "Invalid input"
security:
- resceu_auth:
- "write:resceus"
- "read:resceus"
/topsecret_split/{satellite_name}/:
get:
tags:
- "rescue"
summary: "Search position and message of the spaceships lost"
description: ""
operationId: "makePositionAndMessage"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- name: "satellite_name"
in: "path"
description: "ID of pet to update"
required: true
type: "string"
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/TransmissionResponse"
"405":
description: "Invalid input"
post:
tags:
- "rescue"
summary: "Register position and message send by satellite"
description: ""
operationId: "searchPositionAndMessageSingle"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "path"
name: "satellite_name"
description: "Name Satellite who sent information"
required: true
type: "string"
- in: "body"
name: "body"
schema:
$ref: "#/definitions/Location"
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/TransmissionResponse"
"405":
description: "Invalid input"
security:
- resceu_auth:
- "write:resceus"
- "read:resceus"
securityDefinitions:
resceu_auth:
type: "oauth2"
authorizationUrl: "http://rescue.swagger.io/oauth/dialog"
flow: "implicit"
scopes:
write:resceus: "modify rescue information"
read:resceus: "read rescue information"
definitions:
Satellite:
type: "object"
properties:
name:
type: "string"
example: "Apollo"
distance:
type: "number"
format: "float"
example: 100.0
message:
type: array
items:
type: string
example: ["this", "", "", "message"]
Location:
type: "object"
properties:
distance:
type: "number"
format: "float"
example: 100.0
message:
type: array
items:
type: string
example: ["this", "", "", "message"]
Position:
type: "object"
properties:
x:
type: "number"
format: "float"
example: -100.0
y:
type: "number"
format: "float"
example: 75.5
TransmissionRequest:
type: "object"
required:
- "satellites"
properties:
satellites:
type: "array"
items:
$ref: "#/definitions/Satellite"
TransmissionResponse:
type: "object"
properties:
position:
$ref: "#/definitions/Position"
message:
type: "string"
example: "This is a secret message"
externalDocs:
description: "Find out more about Swagger"
url: "http://swagger.io"