aboutsummaryrefslogtreecommitdiff
path: root/cmd/web/swagger.go
blob: bf556d76f0589ae35de27e018e88aa3be39f0218 (plain) (blame)
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
// Package classification Steam Exporter API
//
// the purpose of this application is to allow one to easily and quickly
// export their steam games to disk or across a network
//
//
// Terms Of Service:
//
// there are no TOS at this moment, use at your own risk we take no
// responsibility
//
//     Schemes: http
//     Host: 127.0.0.1
//     BasePath: /api/v1
//     Version: 0.0.1
//     License: MIT http://opensource.org/licenses/MIT
//     Contact: Mitchell Riedstra <mitch@riedstra.dev> https://git.riedstra.dev/mitch/steam-export/about
//
//     Consumes:
//     - application/json
//
//     Produces:
//     - application/json
//     - application/tar
//
//     Security:
//
//     SecurityDefinitions:
//     api_key:
//          type: apiKey
//          name: KEY
//          in: header
//
// swagger:meta
package main

// statusConflict is returned by the API whenever there's a conflicting action
// swagger:response conflict
type statusConflict struct {
	// The error message
	// in: body
	Body struct {
		// The validation message
		//
		// Example: false
		OK bool
		// Example: Game $game has other jobs running
		Error string
	}
}

// statusOK is returned by the API whenever there's an OK response
// swagger:response ok
type statusOK struct {
	// The error message
	// in: body
	Body struct {
		// The validation message
		//
		// Example: true
		OK bool
	}
}

// swagger:parameters game-delete
type gameParam struct {
	// a BarSlice has bars which are strings
	//
	// in: query
	Game string `json:"game"`
}