diff options
| author | Mitchell Riedstra <mitch@riedstra.dev> | 2021-08-18 20:20:13 -0400 |
|---|---|---|
| committer | Mitchell Riedstra <mitch@riedstra.dev> | 2021-08-18 20:20:13 -0400 |
| commit | f4fcd237b2d0eb950fc15a8af1fb0894b6ad6359 (patch) | |
| tree | fd923697ff46cd00da1daa311f9f6504ebb66c5e /cmd/web/swagger.go | |
| parent | 3156765985f2e7ad7b533c893de9d5ce56aab0ee (diff) | |
| download | steam-export-f4fcd237b2d0eb950fc15a8af1fb0894b6ad6359.tar.gz steam-export-f4fcd237b2d0eb950fc15a8af1fb0894b6ad6359.tar.xz | |
Start poking at swaggo instead of go-swagger
Diffstat (limited to 'cmd/web/swagger.go')
| -rw-r--r-- | cmd/web/swagger.go | 79 |
1 files changed, 12 insertions, 67 deletions
diff --git a/cmd/web/swagger.go b/cmd/web/swagger.go index bf556d7..ac0601c 100644 --- a/cmd/web/swagger.go +++ b/cmd/web/swagger.go @@ -1,71 +1,16 @@ -// 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 - } -} +// @title Swagger Example API +// @version 1.0 +// @description This is a sample server Petstore server. +// @termsOfService http://swagger.io/terms/ -// 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 - } -} +// @contact.name API Support +// @contact.url http://www.swagger.io/support +// @contact.email support@swagger.io -// swagger:parameters game-delete -type gameParam struct { - // a BarSlice has bars which are strings - // - // in: query - Game string `json:"game"` -} +// @license.name Apache 2.0 +// @license.url http://www.apache.org/licenses/LICENSE-2.0.html + +// @host petstore.swagger.io +// @BasePath /v2 |