From aa084bedf0269a6964d6ea9a5fac744e9f739a57 Mon Sep 17 00:00:00 2001 From: Leonel Garcia Date: Wed, 27 Feb 2019 17:43:59 -0500 Subject: [PATCH] [spec] refs #16 #17 #18 - Added specs to 'espec.yml' --- espec.yml | 74 ++++++++++++++++++++++++++++++++- lagcleaner_specs.yml | 99 -------------------------------------------- 2 files changed, 73 insertions(+), 100 deletions(-) delete mode 100644 lagcleaner_specs.yml diff --git a/espec.yml b/espec.yml index 90f96f5..031e22b 100644 --- a/espec.yml +++ b/espec.yml @@ -24,4 +24,76 @@ components: format: int64 message: type: string -paths: \ No newline at end of file +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' \ No newline at end of file diff --git a/lagcleaner_specs.yml b/lagcleaner_specs.yml deleted file mode 100644 index 031e22b..0000000 --- a/lagcleaner_specs.yml +++ /dev/null @@ -1,99 +0,0 @@ -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: # arbitrary name for the security scheme - type: apiKey - in: header # can be "header", "query" or "cookie" - name: X-CSRF-TOKEN # name of the header, query parameter or cookie - 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' \ No newline at end of file