Andreas/wekan
1
0
Fork 0
mirror of https://github.com/wekan/wekan.git synced 2025-09-22 01:50:48 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

fix: properly document /users/login

Browse source
This commit is contained in:
Yang, Bo 2025-06-12 01:30:43 +00:00
parent 7bf75b1ff7
commit e14a3f9c2d
2 changed files with 86 additions and 54 deletions
Download patch file Download diff file Expand all files Collapse all files

70
public/api/wekan.yml
View file

@ -31,47 +31,63 @@ paths:
operationId: login
summary: Login with REST API
consumes:
- application/x-www-form-urlencoded
- application/json
- application/x-www-form-urlencoded
tags:
- Login
parameters:
- name: username
in: formData
- name: loginRequest
in: body
required: true
description: |
Your username
type: string
- name: password
in: formData
required: true
description: |
Your password
type: string
format: password
description: Login credentials
schema:
type: object
required:
- username
- password
properties:
username:
type: string
description: |
Your username
password:
type: string
format: password
description: |
Your password
responses:
200:
description: |-
Successful authentication
schema:
items:
properties:
id:
type: string
token:
type: string
tokenExpires:
type: string
type: object
required:
- id
- token
- tokenExpires
properties:
id:
type: string
description: User ID
token:
type: string
description: |
Authentication token
tokenExpires:
type: string
format: date-time
description: |
Token expiration date
400:
description: |
Error in authentication
schema:
items:
properties:
error:
type: number
reason:
type: string
type: object
properties:
error:
type: string
reason:
type: string
default:
description: |
Error in authentication