// 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}}", "termsOfService": "http://swagger.io/terms/", "contact": { "name": "API Support", "email": "support@yourapp.com" }, "license": { "name": "MIT", "url": "https://opensource.org/licenses/MIT" }, "version": "{{.Version}}" }, "host": "{{.Host}}", "basePath": "{{.BasePath}}", "paths": { "/contacts": { "get": { "description": "Get a list of all contacts", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "contacts" ], "summary": "Get all contacts", "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/handler.APIResponse" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/models.Contact" } } } } ] } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/handler.APIResponse" } } } }, "post": { "description": "Create a new contact with the provided data", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "contacts" ], "summary": "Create a new contact", "parameters": [ { "description": "Contact object", "name": "contact", "in": "body", "required": true, "schema": { "$ref": "#/definitions/models.Contact" } } ], "responses": { "201": { "description": "Created", "schema": { "allOf": [ { "$ref": "#/definitions/handler.APIResponse" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/models.Contact" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/handler.APIResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/handler.APIResponse" } } } } }, "/contacts/{id}": { "get": { "description": "Get a single contact by its ID", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "contacts" ], "summary": "Get a contact by ID", "parameters": [ { "type": "integer", "description": "Contact ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/handler.APIResponse" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/models.Contact" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/handler.APIResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/handler.APIResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/handler.APIResponse" } } } }, "put": { "description": "Update an existing contact by ID", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "contacts" ], "summary": "Update a contact", "parameters": [ { "type": "integer", "description": "Contact ID", "name": "id", "in": "path", "required": true }, { "description": "Contact object", "name": "contact", "in": "body", "required": true, "schema": { "$ref": "#/definitions/models.Contact" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/handler.APIResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/handler.APIResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/handler.APIResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/handler.APIResponse" } } } }, "delete": { "description": "Delete a contact by ID", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "contacts" ], "summary": "Delete a contact", "parameters": [ { "type": "integer", "description": "Contact ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/handler.APIResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/handler.APIResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/handler.APIResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/handler.APIResponse" } } } } } }, "definitions": { "handler.APIError": { "type": "object", "properties": { "code": { "description": "Error code", "type": "integer" }, "details": { "description": "Additional error details", "type": "string" }, "message": { "description": "Human-readable error message", "type": "string" } } }, "handler.APIResponse": { "type": "object", "properties": { "data": { "description": "The response data" }, "errors": { "description": "List of errors if any occurred", "type": "array", "items": { "$ref": "#/definitions/handler.APIError" } }, "message": { "description": "Optional message", "type": "string" }, "success": { "description": "Indicates if the request was successful", "type": "boolean" } } }, "models.Contact": { "type": "object", "properties": { "company": { "description": "Company the contact works for", "type": "string" }, "id": { "description": "ID is the unique identifier for the contact", "type": "integer" }, "name": { "description": "Name of the contact", "type": "string" }, "phone": { "description": "Phone number in international format", "type": "string" } } } } }` // SwaggerInfo holds exported Swagger Info so clients can modify it var SwaggerInfo = &swag.Spec{ Version: "1.0", Host: "localhost:8080", BasePath: "/", Schemes: []string{}, Title: "Contacts API", Description: "A simple Contacts CRUD API", InfoInstanceName: "swagger", SwaggerTemplate: docTemplate, LeftDelim: "{{", RightDelim: "}}", } func init() { swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo) }