Mess around with go-swagger annotations. Remove some commented out code.

1 files changed, 71 insertions, 0 deletions

diff --git a/cmd/web/swagger.go b/cmd/web/swagger.go
new file mode 100644
index 0000000..bf556d7
--- /dev/null
+++ b/cmd/web/swagger.go
@@ -0,0 +1,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"`
+}