Skip to content

Commit 4308b38

Browse files
authored
chore: deprecate /v1/transactions and /v2/transactions endpoints (#841)
1 parent 6f71fad commit 4308b38

File tree

5 files changed

+16
-0
lines changed

5 files changed

+16
-0
lines changed

api/docs.go

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2637,6 +2637,7 @@ const docTemplate = `{
26372637
"Transactions"
26382638
],
26392639
"summary": "Get transactions",
2640+
"deprecated": true,
26402641
"parameters": [
26412642
{
26422643
"type": "string",
@@ -2804,6 +2805,7 @@ const docTemplate = `{
28042805
"Transactions"
28052806
],
28062807
"summary": "Allowed HTTP verbs",
2808+
"deprecated": true,
28072809
"responses": {
28082810
"204": {
28092811
"description": "No Content"
@@ -3737,6 +3739,7 @@ const docTemplate = `{
37373739
"Transactions"
37383740
],
37393741
"summary": "Create transactions",
3742+
"deprecated": true,
37403743
"parameters": [
37413744
{
37423745
"description": "Transactions",
@@ -3793,6 +3796,7 @@ const docTemplate = `{
37933796
"Transactions"
37943797
],
37953798
"summary": "Allowed HTTP verbs",
3799+
"deprecated": true,
37963800
"responses": {
37973801
"204": {
37983802
"description": "No Content"

api/swagger.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2626,6 +2626,7 @@
26262626
"Transactions"
26272627
],
26282628
"summary": "Get transactions",
2629+
"deprecated": true,
26292630
"parameters": [
26302631
{
26312632
"type": "string",
@@ -2793,6 +2794,7 @@
27932794
"Transactions"
27942795
],
27952796
"summary": "Allowed HTTP verbs",
2797+
"deprecated": true,
27962798
"responses": {
27972799
"204": {
27982800
"description": "No Content"
@@ -3726,6 +3728,7 @@
37263728
"Transactions"
37273729
],
37283730
"summary": "Create transactions",
3731+
"deprecated": true,
37293732
"parameters": [
37303733
{
37313734
"description": "Transactions",
@@ -3782,6 +3785,7 @@
37823785
"Transactions"
37833786
],
37843787
"summary": "Allowed HTTP verbs",
3788+
"deprecated": true,
37853789
"responses": {
37863790
"204": {
37873791
"description": "No Content"

api/swagger.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3323,6 +3323,7 @@ paths:
33233323
- Months
33243324
/v1/transactions:
33253325
get:
3326+
deprecated: true
33263327
description: Returns a list of transactions
33273328
parameters:
33283329
- description: Date of the transaction. Ignores exact time, matches on the day
@@ -3408,6 +3409,7 @@ paths:
34083409
tags:
34093410
- Transactions
34103411
options:
3412+
deprecated: true
34113413
description: Returns an empty response with the HTTP Header "allow" set to the
34123414
allowed HTTP verbs
34133415
responses:
@@ -4073,6 +4075,7 @@ paths:
40734075
- RenameRules
40744076
/v2/transactions:
40754077
options:
4078+
deprecated: true
40764079
description: Returns an empty response with the HTTP Header "allow" set to the
40774080
allowed HTTP verbs
40784081
responses:
@@ -4082,6 +4085,7 @@ paths:
40824085
tags:
40834086
- Transactions
40844087
post:
4088+
deprecated: true
40854089
description: Creates transactions from the list of submitted transaction data.
40864090
The response code is the highest response code number that a single transaction
40874091
creation would have caused. If it is not equal to 201, at least one transaction

pkg/controllers/transaction_v1.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,7 @@ func (co Controller) RegisterTransactionRoutes(r *gin.RouterGroup) {
9898
// @Tags Transactions
9999
// @Success 204
100100
// @Router /v1/transactions [options]
101+
// @Deprecated true
101102
func (co Controller) OptionsTransactionList(c *gin.Context) {
102103
httputil.OptionsGetPost(c)
103104
}
@@ -193,6 +194,7 @@ func (co Controller) CreateTransaction(c *gin.Context) {
193194
// @Param reconciled query bool false "DEPRECATED. Filter by reconcilication state"
194195
// @Param reconciledSource query bool false "Reconcilication state in source account"
195196
// @Param reconciledDestination query bool false "Reconcilication state in destination account"
197+
// @Deprecated true
196198
func (co Controller) GetTransactions(c *gin.Context) {
197199
var filter TransactionQueryFilterV1
198200
if err := c.Bind(&filter); err != nil {

pkg/controllers/transaction_v2.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ func (co Controller) RegisterTransactionRoutesV2(r *gin.RouterGroup) {
5555
// @Tags Transactions
5656
// @Success 204
5757
// @Router /v2/transactions [options]
58+
// @Deprecated true
5859
func (co Controller) OptionsTransactionsV2(c *gin.Context) {
5960
httputil.OptionsPost(c)
6061
}
@@ -71,6 +72,7 @@ func (co Controller) OptionsTransactionsV2(c *gin.Context) {
7172
// @Failure 500 {object} []ResponseTransactionV2
7273
// @Param transactions body []models.TransactionCreate true "Transactions"
7374
// @Router /v2/transactions [post]
75+
// @Deprecated true
7476
func (co Controller) CreateTransactionsV2(c *gin.Context) {
7577
var transactions []models.Transaction
7678

0 commit comments

Comments
 (0)