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:
76
backend/docs/swagger.yaml
Normal file
76
backend/docs/swagger.yaml
Normal file
@@ -0,0 +1,76 @@
|
||||
basePath: /
|
||||
definitions:
|
||||
common.ErrResponse:
|
||||
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
|
||||
type: object
|
||||
common.TextResponse:
|
||||
properties:
|
||||
status:
|
||||
description: user-level status message
|
||||
type: string
|
||||
text:
|
||||
description: application-specific error code
|
||||
type: string
|
||||
type: object
|
||||
info:
|
||||
contact:
|
||||
name: Samuel Pua
|
||||
url: https://git.samuelpua.com/telboon
|
||||
description: API for frontend - built on Go-chi
|
||||
title: Eyes of Twitterverse API
|
||||
version: "1.0"
|
||||
paths:
|
||||
/:
|
||||
get:
|
||||
consumes:
|
||||
- application/json
|
||||
description: Description
|
||||
produces:
|
||||
- application/json
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
schema:
|
||||
type: string
|
||||
"404":
|
||||
description: Not Found
|
||||
schema:
|
||||
type: string
|
||||
summary: This is test
|
||||
tags:
|
||||
- Base
|
||||
/webhook/routes/{webhookID}:
|
||||
post:
|
||||
consumes:
|
||||
- application/json
|
||||
description: Description
|
||||
parameters:
|
||||
- description: Pre-registered Webhook Path
|
||||
in: path
|
||||
name: webhookID
|
||||
required: true
|
||||
type: string
|
||||
produces:
|
||||
- application/json
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
schema:
|
||||
$ref: '#/definitions/common.TextResponse'
|
||||
"500":
|
||||
description: Internal Server Error
|
||||
schema:
|
||||
$ref: '#/definitions/common.ErrResponse'
|
||||
summary: Pre-generated webhooks
|
||||
tags:
|
||||
- Webhook
|
||||
swagger: "2.0"
|
||||
Reference in New Issue
Block a user