fix: API v2 Transaction links (#805)

This fixes the API v2 Transaction links by performing the same refactor
that was already performed for the Accounts.

Author: morremeyer

api/docs.go

@@ -251,28 +251,202 @@ definitions:
     properties:
       data:
         allOf:
-        - $ref: '#/definitions/models.Transaction'
+        - $ref: '#/definitions/controllers.TransactionV2'
         description: This field contains the transaction data
       error:
         description: This field contains a human readable error message
         example: A human readable error message
         type: string
     type: object
+  controllers.Transaction:
+    properties:
+      amount:
+        description: The maximum value is "999999999999.99999999", swagger unfortunately
+          rounds this.
+        example: 14.03
+        maximum: 1000000000000
+        minimum: 1e-08
+        multipleOf: 1e-08
+        type: number
+      availableFrom:
+        description: The date from which on the transaction amount is available for
+          budgeting. Only used for income transactions. Defaults to the transaction
+          date.
+        example: "2021-11-17T00:00:00Z"
+        type: string
+      budgetId:
+        description: ID of the budget
+        example: 55eecbd8-7c46-4b06-ada9-f287802fb05e
+        type: string
+      createdAt:
+        description: Time the resource was created
+        example: "2022-04-02T19:28:44.491514Z"
+        type: string
+      date:
+        description: Date of the transaction. Time is currently only used for sorting
+        example: "1815-12-10T18:43:00.271152Z"
+        type: string
+      deletedAt:
+        description: Time the resource was marked as deleted
+        example: "2022-04-22T21:01:05.058161Z"
+        type: string
+      destinationAccountId:
+        description: ID of the destination account
+        example: 8e16b456-a719-48ce-9fec-e115cfa7cbcc
+        type: string
+      envelopeId:
+        description: ID of the envelope
+        example: 2649c965-7999-4873-ae16-89d5d5fa972e
+        type: string
+      id:
+        description: UUID for the resource
+        example: 65392deb-5e92-4268-b114-297faad6cdce
+        type: string
+      importHash:
+        description: The SHA256 hash of a unique combination of values to use in duplicate
+          detection
+        example: 867e3a26dc0baf73f4bff506f31a97f6c32088917e9e5cf1a5ed6f3f84a6fa70
+        type: string
+      links:
+        description: Links for the transaction
+        properties:
+          self:
+            description: The transaction itself
+            example: https://example.com/api/v1/transactions/d430d7c3-d14c-4712-9336-ee56965a6673
+            type: string
+        type: object
+      note:
+        description: A note
+        example: Lunch
+        type: string
+      reconciled:
+        default: false
+        description: DEPRECATED. Do not use, this field does not work as intended.
+          See https://github.com/envelope-zero/backend/issues/528. Use reconciledSource
+          and reconciledDestination instead.
+        example: true
+        type: boolean
+      reconciledDestination:
+        default: false
+        description: Is the transaction reconciled in the destination account?
+        example: true
+        type: boolean
+      reconciledSource:
+        default: false
+        description: Is the transaction reconciled in the source account?
+        example: true
+        type: boolean
+      sourceAccountId:
+        description: ID of the source account
+        example: fd81dc45-a3a2-468e-a6fa-b2618f30aa45
+        type: string
+      updatedAt:
+        description: Last time the resource was updated
+        example: "2022-04-17T20:14:01.048145Z"
+        type: string
+    type: object
   controllers.TransactionListResponse:
     properties:
       data:
         description: List of transactions
         items:
-          $ref: '#/definitions/models.Transaction'
+          $ref: '#/definitions/controllers.Transaction'
         type: array
     type: object
   controllers.TransactionResponse:
     properties:
       data:
         allOf:
-        - $ref: '#/definitions/models.Transaction'
+        - $ref: '#/definitions/controllers.Transaction'
         description: Data for the transaction
     type: object
+  controllers.TransactionV2:
+    properties:
+      amount:
+        description: The maximum value is "999999999999.99999999", swagger unfortunately
+          rounds this.
+        example: 14.03
+        maximum: 1000000000000
+        minimum: 1e-08
+        multipleOf: 1e-08
+        type: number
+      availableFrom:
+        description: The date from which on the transaction amount is available for
+          budgeting. Only used for income transactions. Defaults to the transaction
+          date.
+        example: "2021-11-17T00:00:00Z"
+        type: string
+      budgetId:
+        description: ID of the budget
+        example: 55eecbd8-7c46-4b06-ada9-f287802fb05e
+        type: string
+      createdAt:
+        description: Time the resource was created
+        example: "2022-04-02T19:28:44.491514Z"
+        type: string
+      date:
+        description: Date of the transaction. Time is currently only used for sorting
+        example: "1815-12-10T18:43:00.271152Z"
+        type: string
+      deletedAt:
+        description: Time the resource was marked as deleted
+        example: "2022-04-22T21:01:05.058161Z"
+        type: string
+      destinationAccountId:
+        description: ID of the destination account
+        example: 8e16b456-a719-48ce-9fec-e115cfa7cbcc
+        type: string
+      envelopeId:
+        description: ID of the envelope
+        example: 2649c965-7999-4873-ae16-89d5d5fa972e
+        type: string
+      id:
+        description: UUID for the resource
+        example: 65392deb-5e92-4268-b114-297faad6cdce
+        type: string
+      importHash:
+        description: The SHA256 hash of a unique combination of values to use in duplicate
+          detection
+        example: 867e3a26dc0baf73f4bff506f31a97f6c32088917e9e5cf1a5ed6f3f84a6fa70
+        type: string
+      links:
+        description: Links for the transaction
+        properties:
+          self:
+            description: The transaction itself
+            example: https://example.com/api/v1/transactions/d430d7c3-d14c-4712-9336-ee56965a6673
+            type: string
+        type: object
+      note:
+        description: A note
+        example: Lunch
+        type: string
+      reconciled:
+        default: false
+        description: DEPRECATED. Do not use, this field does not work as intended.
+          See https://github.com/envelope-zero/backend/issues/528. Use reconciledSource
+          and reconciledDestination instead.
+        example: true
+        type: boolean
+      reconciledDestination:
+        default: false
+        description: Is the transaction reconciled in the destination account?
+        example: true
+        type: boolean
+      reconciledSource:
+        default: false
+        description: Is the transaction reconciled in the source account?
+        example: true
+        type: boolean
+      sourceAccountId:
+        description: ID of the source account
+        example: fd81dc45-a3a2-468e-a6fa-b2618f30aa45
+        type: string
+      updatedAt:
+        description: Last time the resource was updated
+        example: "2022-04-17T20:14:01.048145Z"
+        type: string
+    type: object
   httperrors.HTTPError:
     properties:
       error:
@@ -982,93 +1156,6 @@ definitions:
     x-enum-varnames:
     - AffectAvailable
     - AffectEnvelope
-  models.Transaction:
-    properties:
-      amount:
-        description: The maximum value is "999999999999.99999999", swagger unfortunately
-          rounds this.
-        example: 14.03
-        maximum: 1000000000000
-        minimum: 1e-08
-        multipleOf: 1e-08
-        type: number
-      availableFrom:
-        description: The date from which on the transaction amount is available for
-          budgeting. Only used for income transactions. Defaults to the transaction
-          date.
-        example: "2021-11-17T00:00:00Z"
-        type: string
-      budgetId:
-        description: ID of the budget
-        example: 55eecbd8-7c46-4b06-ada9-f287802fb05e
-        type: string
-      createdAt:
-        description: Time the resource was created
-        example: "2022-04-02T19:28:44.491514Z"
-        type: string
-      date:
-        description: Date of the transaction. Time is currently only used for sorting
-        example: "1815-12-10T18:43:00.271152Z"
-        type: string
-      deletedAt:
-        description: Time the resource was marked as deleted
-        example: "2022-04-22T21:01:05.058161Z"
-        type: string
-      destinationAccountId:
-        description: ID of the destination account
-        example: 8e16b456-a719-48ce-9fec-e115cfa7cbcc
-        type: string
-      envelopeId:
-        description: ID of the envelope
-        example: 2649c965-7999-4873-ae16-89d5d5fa972e
-        type: string
-      id:
-        description: UUID for the resource
-        example: 65392deb-5e92-4268-b114-297faad6cdce
-        type: string
-      importHash:
-        description: The SHA256 hash of a unique combination of values to use in duplicate
-          detection
-        example: 867e3a26dc0baf73f4bff506f31a97f6c32088917e9e5cf1a5ed6f3f84a6fa70
-        type: string
-      links:
-        description: Links for the transaction
-        properties:
-          self:
-            description: The transaction itself
-            example: https://example.com/api/v1/transactions/d430d7c3-d14c-4712-9336-ee56965a6673
-            type: string
-        type: object
-      note:
-        description: A note
-        example: Lunch
-        type: string
-      reconciled:
-        default: false
-        description: DEPRECATED. Do not use, this field does not work as intended.
-          See https://github.com/envelope-zero/backend/issues/528. Use reconciledSource
-          and reconciledDestination instead.
-        example: true
-        type: boolean
-      reconciledDestination:
-        default: false
-        description: Is the transaction reconciled in the destination account?
-        example: true
-        type: boolean
-      reconciledSource:
-        default: false
-        description: Is the transaction reconciled in the source account?
-        example: true
-        type: boolean
-      sourceAccountId:
-        description: ID of the source account
-        example: fd81dc45-a3a2-468e-a6fa-b2618f30aa45
-        type: string
-      updatedAt:
-        description: Last time the resource was updated
-        example: "2022-04-17T20:14:01.048145Z"
-        type: string
-    type: object
   models.TransactionCreate:
     properties:
       amount:

api/swagger.json

@@ -1,4 +1,11 @@
 module.exports = {
   extends: ["@commitlint/config-conventional"],
-  rules: {},
+  rules: {
+    "subject-case": () => [
+      2,
+      "never",
+      ["snake-case", "pascal-case", "upper-case"],
+    ],
+    "body-max-line-length": [0, "always", Infinity],
+  },
 };

api/swagger.yaml

@@ -8,8 +8,8 @@ import (
 )
 
 type ResponseTransactionV2 struct {
-	Error string             `json:"error" example:"A human readable error message"` // This field contains a human readable error message
-	Data  models.Transaction `json:"data"`                                           // This field contains the transaction data
+	Error string        `json:"error" example:"A human readable error message"` // This field contains a human readable error message
+	Data  TransactionV2 `json:"data"`                                           // This field contains the transaction data
 }
 
 type ResponseMatchRule struct {