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.4.0

Browse Source
This commit is contained in:
Patrick Nagurny
2020-01-14 14:22:15 -05:00
parent 0a91b19b5c
commit 83f3cfc983
11 changed files with 69 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
core/api/account.go
View File

@@ -14,12 +14,12 @@ import (
/**
* @api {get} /orgs/:orgId/accounts Get Accounts by Org id
* @apiVersion 1.3.0
* @apiVersion 1.4.0
* @apiName GetOrgAccounts
* @apiGroup Account
*
* @apiHeader {String} Authorization HTTP Basic Auth
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
* @apiHeader {String} Accept-Version ^1.4.0 semver versioning
*
* @apiSuccess {String} id Id of the Account.
* @apiSuccess {String} orgId Id of the Org.
@@ -86,12 +86,12 @@ func GetOrgAccounts(w rest.ResponseWriter, r *rest.Request) {
/**
* @api {get} /orgs/:orgId/accounts/:accountId Get Acount by Org id and Account id
* @apiVersion 1.3.0
* @apiVersion 1.4.0
* @apiName GetOrgAccount
* @apiGroup Account
*
* @apiHeader {String} Authorization HTTP Basic Auth
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
* @apiHeader {String} Accept-Version ^1.4.0 semver versioning
*
* @apiSuccess {String} id Id of the Account.
* @apiSuccess {String} orgId Id of the Org.
@@ -157,12 +157,12 @@ func GetOrgAccount(w rest.ResponseWriter, r *rest.Request) {
/**
* @api {post} /orgs/:orgId/accounts Create a new Account
* @apiVersion 1.3.0
* @apiVersion 1.4.0
* @apiName PostAccount
* @apiGroup Account
*
* @apiHeader {String} Authorization HTTP Basic Auth
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
* @apiHeader {String} Accept-Version ^1.4.0 semver versioning
*
* @apiParam {String} id Id 32 character hex string
* @apiParam {String} name Name of the Account.
@@ -270,12 +270,12 @@ func PostAccounts(w rest.ResponseWriter, r *rest.Request, content []byte) {
/**
* @api {put} /orgs/:orgId/accounts/:accountId Modify an Account
* @apiVersion 1.3.0
* @apiVersion 1.4.0
* @apiName PutAccount
* @apiGroup Account
*
* @apiHeader {String} Authorization HTTP Basic Auth
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
* @apiHeader {String} Accept-Version ^1.4.0 semver versioning
*
* @apiParam {String} id Id 32 character hex string
* @apiParam {String} name Name of the Account.
@@ -345,12 +345,12 @@ func PutAccount(w rest.ResponseWriter, r *rest.Request) {
/**
* @api {delete} /orgs/:orgId/accounts/:accountId Delete an Account
* @apiVersion 1.3.0
* @apiVersion 1.4.0
* @apiName DeleteAccount
* @apiGroup Account
*
* @apiHeader {String} Authorization HTTP Basic Auth
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
* @apiHeader {String} Accept-Version ^1.4.0 semver versioning
*
* @apiSuccessExample Success-Response:
* HTTP/1.1 200 OK

2
core/api/api.go
View File

@@ -12,7 +12,7 @@ import (
* - add `POST /orgs/:orgId/budget`
* - add `DELETE /orgs/:orgId/budget`
*
* 1.3.0
* 1.4.0
* - add org.timezone
*
* 1.2.0

16
core/api/apikey.go
View File

@@ -9,12 +9,12 @@ import (
/**
* @api {get} /apikeys Get API keys
* @apiVersion 1.3.0
* @apiVersion 1.4.0
* @apiName GetApiKeys
* @apiGroup ApiKey
*
* @apiHeader {String} Authorization HTTP Basic Auth
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
* @apiHeader {String} Accept-Version ^1.4.0 semver versioning
*
* @apiSuccess {String} id Id of the ApiKey.
* @apiSuccess {Date} inserted Date ApiKey was created
@@ -52,11 +52,11 @@ func GetApiKeys(w rest.ResponseWriter, r *rest.Request) {
/**
* @api {post} /apikeys Create a new API key
* @apiVersion 1.3.0
* @apiVersion 1.4.0
* @apiName PostApiKey
* @apiGroup ApiKey
*
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
* @apiHeader {String} Accept-Version ^1.4.0 semver versioning
* @apiHeader {String} Authorization HTTP Basic Auth
*
* @apiParam {String} id 32 character hex string
@@ -105,11 +105,11 @@ func PostApiKey(w rest.ResponseWriter, r *rest.Request) {
/**
* @api {put} /apikeys Modify an API key
* @apiVersion 1.3.0
* @apiVersion 1.4.0
* @apiName PutApiKey
* @apiGroup ApiKey
*
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
* @apiHeader {String} Accept-Version ^1.4.0 semver versioning
* @apiHeader {String} Authorization HTTP Basic Auth
*
* @apiParam {String} id 32 character hex string
@@ -160,12 +160,12 @@ func PutApiKey(w rest.ResponseWriter, r *rest.Request) {
/**
* @api {delete} /apikeys/:apiKeyId Delete an API key
* @apiVersion 1.3.0
* @apiVersion 1.4.0
* @apiName DeleteApiKey
* @apiGroup ApiKey
*
* @apiHeader {String} Authorization HTTP Basic Auth
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
* @apiHeader {String} Accept-Version ^1.4.0 semver versioning
*
* @apiSuccessExample Success-Response:
* HTTP/1.1 200 OK

32
core/api/org.go
View File

@@ -9,12 +9,12 @@ import (
/**
* @api {get} /org/:orgId Get Org by id
* @apiVersion 1.3.0
* @apiVersion 1.4.0
* @apiName GetOrg
* @apiGroup Org
*
* @apiHeader {String} Authorization HTTP Basic Auth
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
* @apiHeader {String} Accept-Version ^1.4.0 semver versioning
*
* @apiSuccess {String} id Id of the Org.
* @apiSuccess {Date} inserted Date Org was created
@@ -55,12 +55,12 @@ func GetOrg(w rest.ResponseWriter, r *rest.Request) {
/**
* @api {get} /orgs Get a User's Orgs
* @apiVersion 1.3.0
* @apiVersion 1.4.0
* @apiName GetOrgs
* @apiGroup Org
*
* @apiHeader {String} Authorization HTTP Basic Auth
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
* @apiHeader {String} Accept-Version ^1.4.0 semver versioning
*
* @apiSuccess {String} id Id of the Org.
* @apiSuccess {Date} inserted Date Org was created
@@ -102,12 +102,12 @@ func GetOrgs(w rest.ResponseWriter, r *rest.Request) {
/**
* @api {post} /orgs Create a new Org
* @apiVersion 1.3.0
* @apiVersion 1.4.0
* @apiName PostOrg
* @apiGroup Org
*
* @apiHeader {String} Authorization HTTP Basic Auth
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
* @apiHeader {String} Accept-Version ^1.4.0 semver versioning
*
* @apiParam {String} id Id 32 character hex string
* @apiParam {String} name Name of the Org.
@@ -159,12 +159,12 @@ func PostOrg(w rest.ResponseWriter, r *rest.Request) {
/**
* @api {put} /orgs/:orgId Modify an Org
* @apiVersion 1.3.0
* @apiVersion 1.4.0
* @apiName PutOrg
* @apiGroup Org
*
* @apiHeader {String} Authorization HTTP Basic Auth
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
* @apiHeader {String} Accept-Version ^1.4.0 semver versioning
*
* @apiParam {String} name Name of the Org.
*
@@ -216,12 +216,12 @@ func PutOrg(w rest.ResponseWriter, r *rest.Request) {
/**
* @api {post} /orgs/:orgId/invites Invite a user to an Org
* @apiVersion 1.3.0
* @apiVersion 1.4.0
* @apiName PostInvite
* @apiGroup Org
*
* @apiHeader {String} Authorization HTTP Basic Auth
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
* @apiHeader {String} Accept-Version ^1.4.0 semver versioning
*
* @apiParam {String} email Email address of user
*
@@ -272,12 +272,12 @@ func PostInvite(w rest.ResponseWriter, r *rest.Request) {
/**
* @api {put} /orgs/:orgId/invites/:inviteId Accept an invitation
* @apiVersion 1.3.0
* @apiVersion 1.4.0
* @apiName PutInvite
* @apiGroup Org
*
* @apiHeader {String} Authorization HTTP Basic Auth
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
* @apiHeader {String} Accept-Version ^1.4.0 semver versioning
*
* @apiParam {String} accepted true
*
@@ -329,12 +329,12 @@ func PutInvite(w rest.ResponseWriter, r *rest.Request) {
/**
* @api {get} /orgs/:orgId/invites Get Org invites
* @apiVersion 1.3.0
* @apiVersion 1.4.0
* @apiName GetInvites
* @apiGroup Org
*
* @apiHeader {String} Authorization HTTP Basic Auth
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
* @apiHeader {String} Accept-Version ^1.4.0 semver versioning
*
* @apiSuccess {String} id Id of the Invite
* @apiSuccess {orgId} id Id of the Org
@@ -375,12 +375,12 @@ func GetInvites(w rest.ResponseWriter, r *rest.Request) {
/**
* @api {delete} /orgs/:orgId/invites/:inviteId Delete Invite
* @apiVersion 1.3.0
* @apiVersion 1.4.0
* @apiName DeleteInvite
* @apiGroup Org
*
* @apiHeader {String} Authorization HTTP Basic Auth
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
* @apiHeader {String} Accept-Version ^1.4.0 semver versioning
*
* @apiSuccessExample Success-Response:
* HTTP/1.1 200 OK

12
core/api/price.go
View File

@@ -11,12 +11,12 @@ import (
/**
* @api {get} /org/:orgId/prices Get prices nearest in time or by currency
* @apiVersion 1.3.0
* @apiVersion 1.4.0
* @apiName GetPrices
* @apiGroup Price
*
* @apiHeader {String} Authorization HTTP Basic Auth
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
* @apiHeader {String} Accept-Version ^1.4.0 semver versioning
*
* @apiParam {Number} nearestDate Milliseconds since epoch
* @apiParam {String} currency Currency code
@@ -93,12 +93,12 @@ func GetPrices(w rest.ResponseWriter, r *rest.Request) {
/**
* @api {post} /orgs/:orgId/prices Create a new Price
* @apiVersion 1.3.0
* @apiVersion 1.4.0
* @apiName PostPrice
* @apiGroup Price
*
* @apiHeader {String} Authorization HTTP Basic Auth
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
* @apiHeader {String} Accept-Version ^1.4.0 semver versioning
*
* @apiParam {String} id Id 32 character hex string.
* @apiParam {String} orgId Id of the Org.
@@ -155,12 +155,12 @@ func PostPrice(w rest.ResponseWriter, r *rest.Request) {
/**
* @api {delete} /orgs/:orgId/prices/:priceId Delete a Price
* @apiVersion 1.3.0
* @apiVersion 1.4.0
* @apiName DeletePrice
* @apiGroup Price
*
* @apiHeader {String} Authorization HTTP Basic Auth
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
* @apiHeader {String} Accept-Version ^1.4.0 semver versioning
*
* @apiSuccessExample Success-Response:
* HTTP/1.1 200 OK

8
core/api/session.go
View File

@@ -9,11 +9,11 @@ import (
/**
* @api {post} /sessions Create a new Session
* @apiVersion 1.3.0
* @apiVersion 1.4.0
* @apiName PostSession
* @apiGroup Session
*
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
* @apiHeader {String} Accept-Version ^1.4.0 semver versioning
* @apiHeader {String} Authorization HTTP Basic Auth
*
* @apiParam {String} id 32 character hex string
@@ -59,12 +59,12 @@ func PostSession(w rest.ResponseWriter, r *rest.Request) {
/**
* @api {delete} /sessions/:sessionId Log out of a Session
* @apiVersion 1.3.0
* @apiVersion 1.4.0
* @apiName DeleteSession
* @apiGroup Session
*
* @apiHeader {String} Authorization HTTP Basic Auth
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
* @apiHeader {String} Accept-Version ^1.4.0 semver versioning
*
* @apiSuccessExample Success-Response:
* HTTP/1.1 200 OK

4
core/api/syshealth.go
View File

@@ -7,12 +7,12 @@ import (
/**
* @api {get} /health-check Get system health status
* @apiVersion 1.3.0
* @apiVersion 1.4.0
* @apiName GetSystemHealthStatus
* @apiGroup SystemHealth
*
*
* @apiHeader {String} Accept-Version: 1.3.0 semver versioning
* @apiHeader {String} Accept-Version: 1.4.0 semver versioning
*
* @apiSuccess {String} database Database status: "ok"; "fail"
* @apiSuccess {String} api API status: "ok"

20
core/api/transaction.go
View File

@@ -9,12 +9,12 @@ import (
/**
* @api {get} /orgs/:orgId/accounts/:accountId/transactions Get Transactions by Account Id
* @apiVersion 1.3.0
* @apiVersion 1.4.0
* @apiName GetAccountTransactions
* @apiGroup Transaction
*
* @apiHeader {String} Authorization HTTP Basic Auth
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
* @apiHeader {String} Accept-Version ^1.4.0 semver versioning
*
* @apiSuccess {String} id Id of the Transaction.
* @apiSuccess {String} orgId Id of the Org.
@@ -85,12 +85,12 @@ func GetTransactionsByAccount(w rest.ResponseWriter, r *rest.Request) {
/**
* @api {get} /orgs/:orgId/transactions Get Transactions by Org Id
* @apiVersion 1.3.0
* @apiVersion 1.4.0
* @apiName GetOrgTransactions
* @apiGroup Transaction
*
* @apiHeader {String} Authorization HTTP Basic Auth
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
* @apiHeader {String} Accept-Version ^1.4.0 semver versioning
*
* @apiSuccess {String} id Id of the Transaction.
* @apiSuccess {String} orgId Id of the Org.
@@ -160,12 +160,12 @@ func GetTransactionsByOrg(w rest.ResponseWriter, r *rest.Request) {
/**
* @api {post} /orgs/:orgId/transactions Create a new Transaction
* @apiVersion 1.3.0
* @apiVersion 1.4.0
* @apiName PostTransaction
* @apiGroup Transaction
*
* @apiHeader {String} Authorization HTTP Basic Auth
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
* @apiHeader {String} Accept-Version ^1.4.0 semver versioning
*
* @apiParam {String} id Id 32 character hex string
* @apiParam {Date} date Date of the Transaction
@@ -246,12 +246,12 @@ func PostTransaction(w rest.ResponseWriter, r *rest.Request) {
/**
* @api {put} /orgs/:orgId/transactions/:transactionId Modify a Transaction
* @apiVersion 1.3.0
* @apiVersion 1.4.0
* @apiName PutTransaction
* @apiGroup Transaction
*
* @apiHeader {String} Authorization HTTP Basic Auth
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
* @apiHeader {String} Accept-Version ^1.4.0 semver versioning
*
* @apiParam {String} id 32 character hex string
* @apiParam {Date} date Date of the Transaction
@@ -333,12 +333,12 @@ func PutTransaction(w rest.ResponseWriter, r *rest.Request) {
/**
* @api {delete} /orgs/:orgId/transactions/:transactionId Delete a Transaction
* @apiVersion 1.3.0
* @apiVersion 1.4.0
* @apiName DeleteTransaction
* @apiGroup Transaction
*
* @apiHeader {String} Authorization HTTP Basic Auth
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
* @apiHeader {String} Accept-Version ^1.4.0 semver versioning
*
* @apiSuccessExample Success-Response:
* HTTP/1.1 200 OK

20
core/api/user.go
View File

@@ -22,12 +22,12 @@ type ResetPasswordParams struct {
/**
* @api {get} /user Get Authenticated User
* @apiVersion 1.3.0
* @apiVersion 1.4.0
* @apiName GetUser
* @apiGroup User
*
* @apiHeader {String} Authorization HTTP Basic Auth
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
* @apiHeader {String} Accept-Version ^1.4.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.3.0
* @apiVersion 1.4.0
* @apiName PostUser
* @apiGroup User
*
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
* @apiHeader {String} Accept-Version ^1.4.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.3.0
* @apiVersion 1.4.0
* @apiName PutUser
* @apiGroup User
*
* @apiHeader {String} Authorization HTTP Basic Auth
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
* @apiHeader {String} Accept-Version ^1.4.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.3.0
* @apiVersion 1.4.0
* @apiName VerifyUser
* @apiGroup User
*
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
* @apiHeader {String} Accept-Version ^1.4.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.3.0
* @apiVersion 1.4.0
* @apiName ResetPassword
* @apiGroup User
*
* @apiHeader {String} Accept-Version ^1.3.0 semver versioning
* @apiHeader {String} Accept-Version ^1.4.0 semver versioning
*
* @apiParam {String} email Email address for user
*

2
core/api/version.go
View File

@@ -31,7 +31,7 @@ func (mw *VersionMiddleware) MiddlewareFunc(handler rest.HandlerFunc) rest.Handl
rest.Error(writer, "Invalid version", http.StatusBadRequest)
}
serverVersion, _ := semver.NewVersion("1.3.0")
serverVersion, _ := semver.NewVersion("1.4.0")
// Pre-release versions
compatVersion, _ := semver.NewVersion("0.1.8")

2
core/ws/ws.go
View File

@@ -14,7 +14,7 @@ import (
"sync"
)
const version = "1.3.0"
const version = "1.4.0"
//var upgrader = websocket.Upgrader{} // use default options
var txSubscriptions = make(map[string][]*websocket.Conn)