cybercinch/openaccounting-server
0
0
Fork 1
mirror of https://github.com/openaccounting/oa-server.git synced 2025-12-09 00:50:59 +13:00
Code Issues Actions Packages Projects Releases Wiki Activity

api version 1.3.0

Browse Source
This commit is contained in:
Patrick Nagurny
2019-06-27 16:54:24 -04:00
parent a67f270b6d
commit 553e639519
11 changed files with 71 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
core/api/user.go
View File

@@ -22,12 +22,12 @@ type ResetPasswordParams struct {
/**
* @api {get} /user Get Authenticated User
* @apiVersion 1.2.0
* @apiVersion 1.3.0
* @apiName GetUser
* @apiGroup User
*
* @apiHeader {String} Authorization HTTP Basic Auth
* @apiHeader {String} Accept-Version ^1.2.0 semver versioning
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
*
* @apiSuccess {String} id Id of the User.
* @apiSuccess {Date} inserted Date User was created
@@ -64,11 +64,11 @@ func GetUser(w rest.ResponseWriter, r *rest.Request) {
/**
* @api {post} /users Create a new User
* @apiVersion 1.2.0
* @apiVersion 1.3.0
* @apiName PostUser
* @apiGroup User
*
* @apiHeader {String} Accept-Version ^1.2.0 semver versioning
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
*
* @apiParam {String} id 32 character hex string
* @apiParam {String} firstName First name of the User.
@@ -123,12 +123,12 @@ func PostUser(w rest.ResponseWriter, r *rest.Request) {
/**
* @api {put} /user Modify User
* @apiVersion 1.2.0
* @apiVersion 1.3.0
* @apiName PutUser
* @apiGroup User
*
* @apiHeader {String} Authorization HTTP Basic Auth
* @apiHeader {String} Accept-Version ^1.2.0 semver versioning
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
*
* @apiParam {String} password New password
* @apiParam {String} code Password reset code. (Instead of Authorization header)
@@ -204,11 +204,11 @@ func PutUser(w rest.ResponseWriter, r *rest.Request) {
/**
* @api {post} /user/verify Verify user email address
* @apiVersion 1.2.0
* @apiVersion 1.3.0
* @apiName VerifyUser
* @apiGroup User
*
* @apiHeader {String} Accept-Version ^1.2.0 semver versioning
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
*
* @apiParam {String} code Email verification code
*
@@ -238,11 +238,11 @@ func VerifyUser(w rest.ResponseWriter, r *rest.Request) {
/**
* @api {post} /user/reset-password Send reset password email
* @apiVersion 1.2.0
* @apiVersion 1.3.0
* @apiName ResetPassword
* @apiGroup User
*
* @apiHeader {String} Accept-Version ^1.2.0 semver versioning
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
*
* @apiParam {String} email Email address for user
*