Feat(Initial): Initial Go codebase
All checks were successful
Webhook-Everything/Webhook-Everything/pipeline/head This commit looks good
All checks were successful
Webhook-Everything/Webhook-Everything/pipeline/head This commit looks good
This commit is contained in:
114
backend/docs/swagger.json
Normal file
114
backend/docs/swagger.json
Normal file
@@ -0,0 +1,114 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"description": "API for frontend - built on Go-chi",
|
||||
"title": "Eyes of Twitterverse API",
|
||||
"contact": {
|
||||
"name": "Samuel Pua",
|
||||
"url": "https://git.samuelpua.com/telboon"
|
||||
},
|
||||
"version": "1.0"
|
||||
},
|
||||
"basePath": "/",
|
||||
"paths": {
|
||||
"/": {
|
||||
"get": {
|
||||
"description": "Description",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Base"
|
||||
],
|
||||
"summary": "This is test",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Not Found",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/webhook/routes/{webhookID}": {
|
||||
"post": {
|
||||
"description": "Description",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Webhook"
|
||||
],
|
||||
"summary": "Pre-generated webhooks",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Pre-registered Webhook Path",
|
||||
"name": "webhookID",
|
||||
"in": "path",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/common.TextResponse"
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/common.ErrResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"definitions": {
|
||||
"common.ErrResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"code": {
|
||||
"description": "application-specific error code",
|
||||
"type": "integer"
|
||||
},
|
||||
"error": {
|
||||
"description": "application-level error message, for debugging",
|
||||
"type": "string"
|
||||
},
|
||||
"status": {
|
||||
"description": "user-level status message",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"common.TextResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"status": {
|
||||
"description": "user-level status message",
|
||||
"type": "string"
|
||||
},
|
||||
"text": {
|
||||
"description": "application-specific error code",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user