Version controlling generated docs
This commit is contained in:
		
							parent
							
								
									13c12b424a
								
							
						
					
					
						commit
						ae0b0895b2
					
				
					 1 changed files with 80 additions and 0 deletions
				
			
		
							
								
								
									
										80
									
								
								backend/docs/docs.go
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										80
									
								
								backend/docs/docs.go
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,80 @@ | |||
| // Package docs Code generated by swaggo/swag. DO NOT EDIT | ||||
| package docs | ||||
| 
 | ||||
| import "github.com/swaggo/swag" | ||||
| 
 | ||||
| const docTemplate = `{ | ||||
|     "schemes": {{ marshal .Schemes }}, | ||||
|     "swagger": "2.0", | ||||
|     "info": { | ||||
|         "description": "{{escape .Description}}", | ||||
|         "title": "{{.Title}}", | ||||
|         "contact": {}, | ||||
|         "license": { | ||||
|             "name": "AGPL", | ||||
|             "url": "https://www.gnu.org/licenses/agpl-3.0.html" | ||||
|         }, | ||||
|         "version": "{{.Version}}" | ||||
|     }, | ||||
|     "host": "{{.Host}}", | ||||
|     "basePath": "{{.BasePath}}", | ||||
|     "paths": { | ||||
|         "/api/register": { | ||||
|             "post": { | ||||
|                 "description": "Register a new user", | ||||
|                 "consumes": [ | ||||
|                     "application/json" | ||||
|                 ], | ||||
|                 "produces": [ | ||||
|                     "application/json" | ||||
|                 ], | ||||
|                 "tags": [ | ||||
|                     "User" | ||||
|                 ], | ||||
|                 "summary": "Register a new user", | ||||
|                 "responses": { | ||||
|                     "200": { | ||||
|                         "description": "User added", | ||||
|                         "schema": { | ||||
|                             "type": "string" | ||||
|                         } | ||||
|                     }, | ||||
|                     "400": { | ||||
|                         "description": "Bad request", | ||||
|                         "schema": { | ||||
|                             "type": "string" | ||||
|                         } | ||||
|                     }, | ||||
|                     "500": { | ||||
|                         "description": "Internal server error", | ||||
|                         "schema": { | ||||
|                             "type": "string" | ||||
|                         } | ||||
|                     } | ||||
|                 } | ||||
|             } | ||||
|         } | ||||
|     }, | ||||
|     "externalDocs": { | ||||
|         "description": "OpenAPI", | ||||
|         "url": "https://swagger.io/resources/open-api/" | ||||
|     } | ||||
| }` | ||||
| 
 | ||||
| // SwaggerInfo holds exported Swagger Info so clients can modify it | ||||
| var SwaggerInfo = &swag.Spec{ | ||||
| 	Version:          "0.0.1", | ||||
| 	Host:             "localhost:8080", | ||||
| 	BasePath:         "/api", | ||||
| 	Schemes:          []string{}, | ||||
| 	Title:            "TTime API", | ||||
| 	Description:      "This is the API for TTime, a time tracking application.", | ||||
| 	InfoInstanceName: "swagger", | ||||
| 	SwaggerTemplate:  docTemplate, | ||||
| 	LeftDelim:        "{{", | ||||
| 	RightDelim:       "}}", | ||||
| } | ||||
| 
 | ||||
| func init() { | ||||
| 	swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo) | ||||
| } | ||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue
	
	 Imbus
						Imbus