Lagcleaner specs

lagcleaner_specs.yml

@@ -0,0 +1,99 @@
+openapi: 3.0.0
+info:
+  title: Python to .Net
+  description: Still whitout description.
+  version: 0.25.1
+servers:
+  - url: 'http://www.skycoin.net'
+    description: Main Skycoin server
+  - url: 'http://staging.node.skycoin.net'
+    description: Internal staging server for developer.
+components:
+  securitySchemes:
+    CsrfTokenAuth:
+      type: apiKey
+      in: header
+      name: X-CSRF-TOKEN
+  schemas:
+    genericError:
+      description: This is a generic error that should be default response
+      type: object
+      properties:
+        code:
+          type: integer
+          format: int64
+        message:
+          type: string
+paths:
+# - 16
+    /api/transactions/history/to/{address}/observation:
+      post:
+        parameters:
+          - in: path
+            name: address
+            required: true
+            schema:
+              type: string
+            description: Address to which funds are transferred.
+
+        summary: Starts observation of the transactions.
+
+        description: Should starts observation of the transactions that transfer fund to the address, and affect the result of the [GET] /api/transactions/history/to/{address}.
+
+        security:
+          - CsrfTokenAuth: []
+
+        responses:
+          '200':
+            description: Successfully stored in observation list.
+
+          default:
+            $ref: '#/components/schemas/genericError'
+  # - 17
+    /api/transactions/history/from/{address}/observation:
+      post:
+        parameters:
+          - in: path
+            name: address
+            required: true
+            schema:
+              type: string
+            description: Address from which funds are transferred.
+
+        summary: Starts observation of the transactions.
+
+        description: Should starts observation of the transactions that transfer fund from the address, and affect the result of the [GET] /api/transactions/history/from/{address}.
+
+        security:
+          - CsrfTokenAuth: []
+
+        responses:
+          '200':
+            description: Successfully stored in observation list.
+
+          default:
+            $ref: '#/components/schemas/genericError'
+  # - 18
+    /api/transactions/broadcast/{operationId}:
+      delete:
+        parameters:
+          - in: path
+            name: operationId
+            required: true
+            schema:
+              type: string
+            description: Specified transaction from the broadcasted transactions.
+
+        summary: Remove an specified transaction from the broadcasted transactions.
+
+        description: Should remove specified transaction from the broadcasted transactions, and affect transactions returned by the [GET] /api/transactions/broadcast/{operatioId}.
+
+        security:
+          - CsrfTokenAuth: []
+
+        responses:
+          '200':
+            description: Successfully removed from broadcasted transactions list.
+
+          default:
+            $ref: '#/components/schemas/genericError'