mirror of
https://github.com/go-shiori/shiori.git
synced 2025-01-15 20:37:44 +08:00
6f19c12c95
* added 404 template * added auth domain * added embed file for frontend * added base config and dependencies * added basic new http server * added separated server command * updated go modules * removed modd file * Added shortcut to send internal server error response * Added JWT support to Auth Domain * Added JWT support to API * docs: added comments to response struct * naming * inline returns * updated dependencies * production logger * bookmarks endpoint * reverted old views api path * frontend for api v1 * proper 404 error (not working atm) * use response * removed 404 html * server error handler * login and basic auth * adjusted session duration * properly retrieve tags * properly delete bookmark * cleanup * archiver domain * debug routes * bookmark routes * expiration by parameter * move to logrus * logout * frontend cache * updated dependencies * http: migrated to gin * linted * Added version command * unit tests, docs * response test utils and tests * remove logout handler * auth * createtag * improved http test utilities * assert message equals * Remove 1.19 from test matrix * moved api to v1 folder * docs: contribute docs * updated makefile * updated usage docs * warn in server command * updaed docs with shiori version command * Updated documentation * deps: update
121 lines
2.6 KiB
YAML
121 lines
2.6 KiB
YAML
definitions:
|
|
api.loginRequestPayload:
|
|
properties:
|
|
password:
|
|
type: string
|
|
remember_me:
|
|
type: boolean
|
|
username:
|
|
type: string
|
|
required:
|
|
- password
|
|
- username
|
|
type: object
|
|
api.loginResponseMessage:
|
|
properties:
|
|
token:
|
|
type: string
|
|
type: object
|
|
model.Account:
|
|
properties:
|
|
id:
|
|
type: integer
|
|
owner:
|
|
type: boolean
|
|
password:
|
|
type: string
|
|
username:
|
|
type: string
|
|
type: object
|
|
model.Tag:
|
|
properties:
|
|
id:
|
|
type: integer
|
|
nBookmarks:
|
|
type: integer
|
|
name:
|
|
type: string
|
|
type: object
|
|
info:
|
|
contact: {}
|
|
paths:
|
|
/api/v1/auth/login:
|
|
post:
|
|
consumes:
|
|
- application/json
|
|
parameters:
|
|
- description: Login data
|
|
in: body
|
|
name: payload
|
|
schema:
|
|
$ref: '#/definitions/api.loginRequestPayload'
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: Login successful
|
|
schema:
|
|
$ref: '#/definitions/api.loginResponseMessage'
|
|
"400":
|
|
description: Invalid login data
|
|
summary: Login to an account using username and password
|
|
tags:
|
|
- Auth
|
|
/api/v1/auth/me:
|
|
get:
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/model.Account'
|
|
"403":
|
|
description: Token not provided/invalid
|
|
summary: Get information for the current logged in user
|
|
tags:
|
|
- Auth
|
|
/api/v1/auth/refresh:
|
|
post:
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: Refresh successful
|
|
schema:
|
|
$ref: '#/definitions/api.loginResponseMessage'
|
|
"403":
|
|
description: Token not provided/invalid
|
|
summary: Refresh a token for an account
|
|
tags:
|
|
- Auth
|
|
/api/v1/tags:
|
|
get:
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: List of tags
|
|
schema:
|
|
$ref: '#/definitions/model.Tag'
|
|
"403":
|
|
description: Token not provided/invalid
|
|
summary: List tags
|
|
tags:
|
|
- Tags
|
|
post:
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: Created tag
|
|
schema:
|
|
$ref: '#/definitions/model.Tag'
|
|
"400":
|
|
description: Token not provided/invalid
|
|
"403":
|
|
description: Token not provided/invalid
|
|
summary: Create tag
|
|
tags:
|
|
- Tags
|
|
swagger: "2.0"
|