added swagger doc
parent
525360229d
commit
95ef156125
14
main.go
14
main.go
|
@ -1,3 +1,17 @@
|
|||
// Package classification Janex API Documentation.
|
||||
//
|
||||
// Schemes: https
|
||||
// Host: janex
|
||||
// BasePath: /v1
|
||||
// Version: 0.0.1
|
||||
//
|
||||
// Consumes:
|
||||
// - application/json
|
||||
//
|
||||
// Produces:
|
||||
// - application/json
|
||||
//
|
||||
// swagger:meta
|
||||
package main
|
||||
|
||||
import (
|
||||
|
|
|
@ -0,0 +1 @@
|
|||
Subproject commit afb9610f411d273474c018bca60725cf6afa6472
|
|
@ -13,6 +13,30 @@ import (
|
|||
)
|
||||
|
||||
func StartGroupTask(c *fiber.Ctx) error {
|
||||
// swagger:operation POST /grouptasks/start grouptasks grouptasksStart
|
||||
// ---
|
||||
// summary: Start a new group task
|
||||
// consumes:
|
||||
// - application/json
|
||||
// produces:
|
||||
// - application/json
|
||||
// parameters:
|
||||
// - name: X-Api-Key
|
||||
// in: header
|
||||
// description: You can create a new api key in your user profile
|
||||
// - name: body
|
||||
// in: body
|
||||
// description: JSON -> Category str, GroupId str, Description str, GlobalInputs [{key, value}, {...}]
|
||||
// responses:
|
||||
// '200':
|
||||
// description: New group task created successfully
|
||||
// '400':
|
||||
// description: Invalid request body
|
||||
// '401':
|
||||
// description: No permissions
|
||||
// '422':
|
||||
// description: No group tasks in this category or provided global inputs incomplete
|
||||
|
||||
var body structs.ApiGroupTaskRequest
|
||||
|
||||
if err := c.BodyParser(&body); err != nil {
|
||||
|
|
Loading…
Reference in New Issue