feat(migration): generate swagger docs
This commit is contained in:
kolaente
parent
3af9855148
commit
5871d32c2d
3 changed files with 197 additions and 0 deletions
|
|
@ -2699,6 +2699,80 @@ const docTemplate = `{
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"/migration/ticktick/migrate": {
|
||||||
|
"post": {
|
||||||
|
"security": [
|
||||||
|
{
|
||||||
|
"JWTKeyAuth": []
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"description": "Imports all projects, tasks, notes, reminders, subtasks and files from a TickTick backup export into Vikunja.",
|
||||||
|
"consumes": [
|
||||||
|
"application/json"
|
||||||
|
],
|
||||||
|
"produces": [
|
||||||
|
"application/json"
|
||||||
|
],
|
||||||
|
"tags": [
|
||||||
|
"migration"
|
||||||
|
],
|
||||||
|
"summary": "Import all lists, tasks etc. from a TickTick backup export",
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"type": "string",
|
||||||
|
"description": "The TickTick backup csv file.",
|
||||||
|
"name": "import",
|
||||||
|
"in": "formData",
|
||||||
|
"required": true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": "A message telling you everything was migrated successfully.",
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/definitions/models.Message"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"500": {
|
||||||
|
"description": "Internal server error",
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/definitions/models.Message"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"/migration/ticktick/status": {
|
||||||
|
"get": {
|
||||||
|
"security": [
|
||||||
|
{
|
||||||
|
"JWTKeyAuth": []
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"description": "Returns if the current user already did the migation or not. This is useful to show a confirmation message in the frontend if the user is trying to do the same migration again.",
|
||||||
|
"produces": [
|
||||||
|
"application/json"
|
||||||
|
],
|
||||||
|
"tags": [
|
||||||
|
"migration"
|
||||||
|
],
|
||||||
|
"summary": "Get migration status",
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": "The migration status",
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/definitions/migration.Status"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"500": {
|
||||||
|
"description": "Internal server error",
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/definitions/models.Message"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
"/migration/todoist/auth": {
|
"/migration/todoist/auth": {
|
||||||
"get": {
|
"get": {
|
||||||
"security": [
|
"security": [
|
||||||
|
|
|
||||||
|
|
@ -2690,6 +2690,80 @@
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"/migration/ticktick/migrate": {
|
||||||
|
"post": {
|
||||||
|
"security": [
|
||||||
|
{
|
||||||
|
"JWTKeyAuth": []
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"description": "Imports all projects, tasks, notes, reminders, subtasks and files from a TickTick backup export into Vikunja.",
|
||||||
|
"consumes": [
|
||||||
|
"application/json"
|
||||||
|
],
|
||||||
|
"produces": [
|
||||||
|
"application/json"
|
||||||
|
],
|
||||||
|
"tags": [
|
||||||
|
"migration"
|
||||||
|
],
|
||||||
|
"summary": "Import all lists, tasks etc. from a TickTick backup export",
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"type": "string",
|
||||||
|
"description": "The TickTick backup csv file.",
|
||||||
|
"name": "import",
|
||||||
|
"in": "formData",
|
||||||
|
"required": true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": "A message telling you everything was migrated successfully.",
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/definitions/models.Message"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"500": {
|
||||||
|
"description": "Internal server error",
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/definitions/models.Message"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"/migration/ticktick/status": {
|
||||||
|
"get": {
|
||||||
|
"security": [
|
||||||
|
{
|
||||||
|
"JWTKeyAuth": []
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"description": "Returns if the current user already did the migation or not. This is useful to show a confirmation message in the frontend if the user is trying to do the same migration again.",
|
||||||
|
"produces": [
|
||||||
|
"application/json"
|
||||||
|
],
|
||||||
|
"tags": [
|
||||||
|
"migration"
|
||||||
|
],
|
||||||
|
"summary": "Get migration status",
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": "The migration status",
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/definitions/migration.Status"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"500": {
|
||||||
|
"description": "Internal server error",
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/definitions/models.Message"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
"/migration/todoist/auth": {
|
"/migration/todoist/auth": {
|
||||||
"get": {
|
"get": {
|
||||||
"security": [
|
"security": [
|
||||||
|
|
|
||||||
|
|
@ -3250,6 +3250,55 @@ paths:
|
||||||
summary: Get migration status
|
summary: Get migration status
|
||||||
tags:
|
tags:
|
||||||
- migration
|
- migration
|
||||||
|
/migration/ticktick/migrate:
|
||||||
|
post:
|
||||||
|
consumes:
|
||||||
|
- application/json
|
||||||
|
description: Imports all projects, tasks, notes, reminders, subtasks and files
|
||||||
|
from a TickTick backup export into Vikunja.
|
||||||
|
parameters:
|
||||||
|
- description: The TickTick backup csv file.
|
||||||
|
in: formData
|
||||||
|
name: import
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
produces:
|
||||||
|
- application/json
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: A message telling you everything was migrated successfully.
|
||||||
|
schema:
|
||||||
|
$ref: '#/definitions/models.Message'
|
||||||
|
"500":
|
||||||
|
description: Internal server error
|
||||||
|
schema:
|
||||||
|
$ref: '#/definitions/models.Message'
|
||||||
|
security:
|
||||||
|
- JWTKeyAuth: []
|
||||||
|
summary: Import all lists, tasks etc. from a TickTick backup export
|
||||||
|
tags:
|
||||||
|
- migration
|
||||||
|
/migration/ticktick/status:
|
||||||
|
get:
|
||||||
|
description: Returns if the current user already did the migation or not. This
|
||||||
|
is useful to show a confirmation message in the frontend if the user is trying
|
||||||
|
to do the same migration again.
|
||||||
|
produces:
|
||||||
|
- application/json
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: The migration status
|
||||||
|
schema:
|
||||||
|
$ref: '#/definitions/migration.Status'
|
||||||
|
"500":
|
||||||
|
description: Internal server error
|
||||||
|
schema:
|
||||||
|
$ref: '#/definitions/models.Message'
|
||||||
|
security:
|
||||||
|
- JWTKeyAuth: []
|
||||||
|
summary: Get migration status
|
||||||
|
tags:
|
||||||
|
- migration
|
||||||
/migration/todoist/auth:
|
/migration/todoist/auth:
|
||||||
get:
|
get:
|
||||||
description: Returns the auth url where the user needs to get its auth code.
|
description: Returns the auth url where the user needs to get its auth code.
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue