harakat/backend
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add invite api docs

Browse Source
This commit is contained in:
kalipso
2026-04-07 11:11:53 +02:00
parent abe247e46f
commit e6f0170644
4 changed files with 452 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
controllers/userController.go
View File

@@ -222,3 +222,43 @@ func (rc *UserController) InitAdmin(c *gin.Context) {
fmt.Println("FOOO")
rc.Register(c)
}
// Register godoc
// @Summary List active invite tokens
// @Description List active invite tokens
// @Tags user
// @Accept json
// @Produce json
// @Success 200 {array} models.RegisterToken
// @Failure 400 {object} httputil.HTTPError
// @Failure 404 {object} httputil.HTTPError
// @Failure 500 {object} httputil.HTTPError
// @Router /user/invite [get]
func (uc *UserController) ListInvite(c *gin.Context) {}
// Register godoc
// @Summary Create new invite token
// @Description Create new invite token
// @Tags user
// @Accept json
// @Produce json
// @Success 200 {object} models.RegisterToken
// @Failure 400 {object} httputil.HTTPError
// @Failure 404 {object} httputil.HTTPError
// @Failure 500 {object} httputil.HTTPError
// @Router /user/invite [post]
func (uc *UserController) CreateInvite(c *gin.Context) {}
// Register godoc
// @Summary Delete invite token
// @Description Delete invite token
// @Tags user
// @Accept json
// @Produce json
// @Param id path string false "invite token id"
// @Success 200 {object} EmptyResponse
// @Failure 400 {object} httputil.HTTPError
// @Failure 404 {object} httputil.HTTPError
// @Failure 500 {object} httputil.HTTPError
// @Router /user/invite/{id} [delete]
func (uc *UserController) DeleteInvite(c *gin.Context) {}

155
docs/docs.go
View File

@@ -1290,6 +1290,138 @@ const docTemplate = `{
}
}
},
"/user/invite": {
"get": {
"description": "List active invite tokens",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "List active invite tokens",
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/models.RegisterToken"
}
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/httputil.HTTPError"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/httputil.HTTPError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/httputil.HTTPError"
}
}
}
},
"post": {
"description": "Create new invite token",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Create new invite token",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/models.RegisterToken"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/httputil.HTTPError"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/httputil.HTTPError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/httputil.HTTPError"
}
}
}
}
},
"/user/invite/{id}": {
"delete": {
"description": "Delete invite token",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Delete invite token",
"parameters": [
{
"type": "string",
"description": "invite token id",
"name": "id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/controllers.EmptyResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/httputil.HTTPError"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/httputil.HTTPError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/httputil.HTTPError"
}
}
}
}
},
"/user/login": {
"post": {
"description": "Login user",
@@ -1644,6 +1776,29 @@ const docTemplate = `{
}
}
},
"models.RegisterToken": {
"type": "object",
"required": [
"token"
],
"properties": {
"createdAt": {
"type": "string"
},
"deletedAt": {
"$ref": "#/definitions/gorm.DeletedAt"
},
"id": {
"type": "integer"
},
"token": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
}
},
"models.Ressource": {
"type": "object",
"properties": {

155
docs/swagger.json
View File

@@ -1284,6 +1284,138 @@
}
}
},
"/user/invite": {
"get": {
"description": "List active invite tokens",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "List active invite tokens",
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/models.RegisterToken"
}
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/httputil.HTTPError"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/httputil.HTTPError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/httputil.HTTPError"
}
}
}
},
"post": {
"description": "Create new invite token",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Create new invite token",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/models.RegisterToken"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/httputil.HTTPError"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/httputil.HTTPError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/httputil.HTTPError"
}
}
}
}
},
"/user/invite/{id}": {
"delete": {
"description": "Delete invite token",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Delete invite token",
"parameters": [
{
"type": "string",
"description": "invite token id",
"name": "id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/controllers.EmptyResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/httputil.HTTPError"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/httputil.HTTPError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/httputil.HTTPError"
}
}
}
}
},
"/user/login": {
"post": {
"description": "Login user",
@@ -1638,6 +1770,29 @@
}
}
},
"models.RegisterToken": {
"type": "object",
"required": [
"token"
],
"properties": {
"createdAt": {
"type": "string"
},
"deletedAt": {
"$ref": "#/definitions/gorm.DeletedAt"
},
"id": {
"type": "integer"
},
"token": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
}
},
"models.Ressource": {
"type": "object",
"properties": {

102
docs/swagger.yaml
View File

@@ -138,6 +138,21 @@ definitions:
- code
- name
type: object
models.RegisterToken:
properties:
createdAt:
type: string
deletedAt:
$ref: '#/definitions/gorm.DeletedAt'
id:
type: integer
token:
type: string
updatedAt:
type: string
required:
- token
type: object
models.Ressource:
properties:
category:
@@ -1132,6 +1147,93 @@ paths:
summary: Update an existing ressource translation
tags:
- ressource
/user/invite:
get:
consumes:
- application/json
description: List active invite tokens
produces:
- application/json
responses:
"200":
description: OK
schema:
items:
$ref: '#/definitions/models.RegisterToken'
type: array
"400":
description: Bad Request
schema:
$ref: '#/definitions/httputil.HTTPError'
"404":
description: Not Found
schema:
$ref: '#/definitions/httputil.HTTPError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/httputil.HTTPError'
summary: List active invite tokens
tags:
- user
post:
consumes:
- application/json
description: Create new invite token
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.RegisterToken'
"400":
description: Bad Request
schema:
$ref: '#/definitions/httputil.HTTPError'
"404":
description: Not Found
schema:
$ref: '#/definitions/httputil.HTTPError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/httputil.HTTPError'
summary: Create new invite token
tags:
- user
/user/invite/{id}:
delete:
consumes:
- application/json
description: Delete invite token
parameters:
- description: invite token id
in: path
name: id
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/controllers.EmptyResponse'
"400":
description: Bad Request
schema:
$ref: '#/definitions/httputil.HTTPError'
"404":
description: Not Found
schema:
$ref: '#/definitions/httputil.HTTPError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/httputil.HTTPError'
summary: Delete invite token
tags:
- user
/user/login:
post:
consumes: