1
0

Add link share password authentication (#831)

Reviewed-on: https://kolaente.dev/vikunja/api/pulls/831
Co-authored-by: konrad <konrad@kola-entertainments.de>
Co-committed-by: konrad <konrad@kola-entertainments.de>
This commit is contained in:
konrad
2021-04-11 13:17:50 +00:00
parent 6a927c0703
commit b3c604fd2f
20 changed files with 471 additions and 40 deletions

View File

@ -4141,6 +4141,15 @@ var doc = `{
],
"summary": "Get an auth token for a share",
"parameters": [
{
"description": "The password for link shares which require one.",
"name": "password",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.LinkShareAuth"
}
},
{
"type": "string",
"description": "The share hash",
@ -7493,6 +7502,10 @@ var doc = `{
"description": "The name of this link share. All actions someone takes while being authenticated with that link will appear with that name.",
"type": "string"
},
"password": {
"description": "The password of this link share. You can only set it, not retrieve it after the link share has been created.",
"type": "string"
},
"right": {
"description": "The right this list is shared with. 0 = Read only, 1 = Read \u0026 Write, 2 = Admin. See the docs for more details.",
"type": "integer",
@ -7504,7 +7517,7 @@ var doc = `{
"$ref": "#/definitions/user.User"
},
"sharing_type": {
"description": "The kind of this link. 0 = undefined, 1 = without password, 2 = with password (currently not implemented).",
"description": "The kind of this link. 0 = undefined, 1 = without password, 2 = with password.",
"type": "integer",
"default": 0,
"maximum": 2
@ -8511,6 +8524,14 @@ var doc = `{
}
}
},
"v1.LinkShareAuth": {
"type": "object",
"properties": {
"password": {
"type": "string"
}
}
},
"v1.UserAvatarProvider": {
"type": "object",
"properties": {

View File

@ -4124,6 +4124,15 @@
],
"summary": "Get an auth token for a share",
"parameters": [
{
"description": "The password for link shares which require one.",
"name": "password",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.LinkShareAuth"
}
},
{
"type": "string",
"description": "The share hash",
@ -7476,6 +7485,10 @@
"description": "The name of this link share. All actions someone takes while being authenticated with that link will appear with that name.",
"type": "string"
},
"password": {
"description": "The password of this link share. You can only set it, not retrieve it after the link share has been created.",
"type": "string"
},
"right": {
"description": "The right this list is shared with. 0 = Read only, 1 = Read \u0026 Write, 2 = Admin. See the docs for more details.",
"type": "integer",
@ -7487,7 +7500,7 @@
"$ref": "#/definitions/user.User"
},
"sharing_type": {
"description": "The kind of this link. 0 = undefined, 1 = without password, 2 = with password (currently not implemented).",
"description": "The kind of this link. 0 = undefined, 1 = without password, 2 = with password.",
"type": "integer",
"default": 0,
"maximum": 2
@ -8494,6 +8507,14 @@
}
}
},
"v1.LinkShareAuth": {
"type": "object",
"properties": {
"password": {
"type": "string"
}
}
},
"v1.UserAvatarProvider": {
"type": "object",
"properties": {

View File

@ -313,6 +313,9 @@ definitions:
name:
description: The name of this link share. All actions someone takes while being authenticated with that link will appear with that name.
type: string
password:
description: The password of this link share. You can only set it, not retrieve it after the link share has been created.
type: string
right:
default: 0
description: The right this list is shared with. 0 = Read only, 1 = Read & Write, 2 = Admin. See the docs for more details.
@ -323,7 +326,7 @@ definitions:
description: The user who shared this list
sharing_type:
default: 0
description: The kind of this link. 0 = undefined, 1 = without password, 2 = with password (currently not implemented).
description: The kind of this link. 0 = undefined, 1 = without password, 2 = with password.
maximum: 2
type: integer
updated:
@ -1064,6 +1067,11 @@ definitions:
minLength: 1
type: string
type: object
v1.LinkShareAuth:
properties:
password:
type: string
type: object
v1.UserAvatarProvider:
properties:
avatar_provider:
@ -3850,6 +3858,12 @@ paths:
- application/json
description: Get a jwt auth token for a shared list from a share hash.
parameters:
- description: The password for link shares which require one.
in: body
name: password
required: true
schema:
$ref: '#/definitions/v1.LinkShareAuth'
- description: The share hash
in: path
name: share