-
Notifications
You must be signed in to change notification settings - Fork 8
/
swagger.yaml
64 lines (64 loc) · 1.47 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
basePath: /
consumes:
- application/json
definitions:
FooBarRequest:
properties:
bar:
items:
format: int64
type: integer
type: array
x-go-name: Bar
foo:
type: string
x-go-name: Foo
title: FooBarRequest represents body of FooBar request.
type: object
x-go-package: github.com/pdrum/swagger-automation/api
FooBarResponse:
properties:
baz:
properties:
prop:
type: string
x-go-name: Prop
type: object
x-go-name: Baz
title: FooBarResponse represents body of FooBar response.
type: object
x-go-package: github.com/pdrum/swagger-automation/api
host: some-url.com
info:
description: Documentation of our awesome API.
title: awesome.
version: 1.0.0
paths:
/foobar:
post:
operationId: idOfFoobarEndpoint
parameters:
- description: This text will appear as description of your request body.
in: body
name: Body
schema:
$ref: '#/definitions/FooBarRequest'
responses:
"200":
$ref: '#/responses/foobarResponse'
summary: Foobar does some amazing stuff.
tags:
- foobar-tag
produces:
- application/json
responses:
foobarResponse:
description: This text will appear as description of your response body.
schema:
$ref: '#/definitions/FooBarResponse'
schemes:
- http
securityDefinitions:
basic:
type: basic
swagger: "2.0"