From c418494cf3b689e9d51607ec6d0163e3975803b3 Mon Sep 17 00:00:00 2001 From: Luis Mastrangelo Date: Wed, 10 Jan 2024 18:31:46 -0300 Subject: [PATCH 1/4] Comment out session endpoints and fix server drop-down Signed-off-by: Luis Mastrangelo --- openapi.yaml | 46 ++++++++++++++++++++++++++-------------------- 1 file changed, 26 insertions(+), 20 deletions(-) diff --git a/openapi.yaml b/openapi.yaml index fdb8b314..c5b9577e 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -7,35 +7,41 @@ info: name: MIT url: https://github.com/hashgraph/hedera-sourcify/blob/master/LICENSE servers: - - url: http://localhost:5002 - description: Local development server address on default port 5002. + - description: The current REST API server + url: "" + - description: The production REST API server + url: "https://server-verify.hashscan.io" + - description: The integration REST API server + url: "https://server-sourcify.hedera-devops.com" + - description: Local development server address on default port 5002 + url: "http://localhost:5002" paths: - /session/data: - $ref: "src/server/controllers/verification/session-state/data.session-state.paths.yaml#/paths/~1session~1data" - /session/clear: - $ref: "src/server/controllers/verification/session-state/clear.session-state.paths.yaml#/paths/~1session~1clear" - /session/input-files: - $ref: "src/server/controllers/verification/session-state/input-files.session-state.paths.yaml#/paths/~1session~1input-files" - /session/input-contract: - $ref: "src/server/controllers/verification/session-state/input-contract.session-state.paths.yaml#/paths/~1session~1input-contract" + # /session/data: + # $ref: "src/server/controllers/verification/session-state/data.session-state.paths.yaml#/paths/~1session~1data" + # /session/clear: + # $ref: "src/server/controllers/verification/session-state/clear.session-state.paths.yaml#/paths/~1session~1clear" + # /session/input-files: + # $ref: "src/server/controllers/verification/session-state/input-files.session-state.paths.yaml#/paths/~1session~1input-files" + # /session/input-contract: + # $ref: "src/server/controllers/verification/session-state/input-contract.session-state.paths.yaml#/paths/~1session~1input-contract" + # /session/verify-checked: + # $ref: "src/server/controllers/verification/verify/session/verify.session.paths.yaml#/paths/~1session~1verify-checked" + # /session/input-solc-json: + # $ref: "src/server/controllers/verification/solc-json/session/solc-json.session.paths.yaml#/paths/~1session~1input-solc-json" + # /session/verify/create2: + # $ref: "src/server/controllers/verification/create2/session/create2.session.paths.yaml#/paths/~1session~1verify~1create2" + # /session/verify/create2/compile: + # $ref: "src/server/controllers/verification/create2/session/compile.create2.session.paths.yaml#/paths/~1session~1verify~1create2~1compile" + # /session/verify/etherscan: + # $ref: "src/server/controllers/verification/etherscan/session/etherscan.session.paths.yaml#/paths/~1session~1verify~1etherscan" /verify: $ref: "src/server/controllers/verification/verify/stateless/verify.stateless.paths.yaml#/paths/~1verify" - /session/verify-checked: - $ref: "src/server/controllers/verification/verify/session/verify.session.paths.yaml#/paths/~1session~1verify-checked" /verify/solc-json: $ref: "src/server/controllers/verification/solc-json/stateless/solc-json.stateless.paths.yaml#/paths/~1verify~1solc-json" - /session/input-solc-json: - $ref: "src/server/controllers/verification/solc-json/session/solc-json.session.paths.yaml#/paths/~1session~1input-solc-json" /verify/create2: $ref: "src/server/controllers/verification/create2/stateless/create2.stateless.paths.yaml#/paths/~1verify~1create2" - /session/verify/create2: - $ref: "src/server/controllers/verification/create2/session/create2.session.paths.yaml#/paths/~1session~1verify~1create2" - /session/verify/create2/compile: - $ref: "src/server/controllers/verification/create2/session/compile.create2.session.paths.yaml#/paths/~1session~1verify~1create2~1compile" /verify/etherscan: $ref: "src/server/controllers/verification/etherscan/stateless/etherscan.stateless.paths.yaml#/paths/~1verify~1etherscan" - /session/verify/etherscan: - $ref: "src/server/controllers/verification/etherscan/session/etherscan.session.paths.yaml#/paths/~1session~1verify~1etherscan" /check-all-by-addresses: $ref: "src/server/controllers/repository/check-all-by-addresses.stateless.paths.yaml#/paths/~1check-all-by-addresses" /check-by-addresses: From 25112fff49008fefaec5b6606140295ee5d6f83c Mon Sep 17 00:00:00 2001 From: Luis Mastrangelo Date: Thu, 11 Jan 2024 14:32:34 -0300 Subject: [PATCH 2/4] Use tags to mark endpoints as not supported Signed-off-by: Luis Mastrangelo --- openapi.yaml | 41 +++++++++++++++++++++-------------------- 1 file changed, 21 insertions(+), 20 deletions(-) diff --git a/openapi.yaml b/openapi.yaml index c5b9577e..75feec2e 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -11,29 +11,30 @@ servers: url: "" - description: The production REST API server url: "https://server-verify.hashscan.io" - - description: The integration REST API server - url: "https://server-sourcify.hedera-devops.com" - description: Local development server address on default port 5002 url: "http://localhost:5002" +tags: + - name: Session Verification + description: Not supported endpoints. Use with caution. paths: - # /session/data: - # $ref: "src/server/controllers/verification/session-state/data.session-state.paths.yaml#/paths/~1session~1data" - # /session/clear: - # $ref: "src/server/controllers/verification/session-state/clear.session-state.paths.yaml#/paths/~1session~1clear" - # /session/input-files: - # $ref: "src/server/controllers/verification/session-state/input-files.session-state.paths.yaml#/paths/~1session~1input-files" - # /session/input-contract: - # $ref: "src/server/controllers/verification/session-state/input-contract.session-state.paths.yaml#/paths/~1session~1input-contract" - # /session/verify-checked: - # $ref: "src/server/controllers/verification/verify/session/verify.session.paths.yaml#/paths/~1session~1verify-checked" - # /session/input-solc-json: - # $ref: "src/server/controllers/verification/solc-json/session/solc-json.session.paths.yaml#/paths/~1session~1input-solc-json" - # /session/verify/create2: - # $ref: "src/server/controllers/verification/create2/session/create2.session.paths.yaml#/paths/~1session~1verify~1create2" - # /session/verify/create2/compile: - # $ref: "src/server/controllers/verification/create2/session/compile.create2.session.paths.yaml#/paths/~1session~1verify~1create2~1compile" - # /session/verify/etherscan: - # $ref: "src/server/controllers/verification/etherscan/session/etherscan.session.paths.yaml#/paths/~1session~1verify~1etherscan" + /session/data: + $ref: "src/server/controllers/verification/session-state/data.session-state.paths.yaml#/paths/~1session~1data" + /session/clear: + $ref: "src/server/controllers/verification/session-state/clear.session-state.paths.yaml#/paths/~1session~1clear" + /session/input-files: + $ref: "src/server/controllers/verification/session-state/input-files.session-state.paths.yaml#/paths/~1session~1input-files" + /session/input-contract: + $ref: "src/server/controllers/verification/session-state/input-contract.session-state.paths.yaml#/paths/~1session~1input-contract" + /session/verify-checked: + $ref: "src/server/controllers/verification/verify/session/verify.session.paths.yaml#/paths/~1session~1verify-checked" + /session/input-solc-json: + $ref: "src/server/controllers/verification/solc-json/session/solc-json.session.paths.yaml#/paths/~1session~1input-solc-json" + /session/verify/create2: + $ref: "src/server/controllers/verification/create2/session/create2.session.paths.yaml#/paths/~1session~1verify~1create2" + /session/verify/create2/compile: + $ref: "src/server/controllers/verification/create2/session/compile.create2.session.paths.yaml#/paths/~1session~1verify~1create2~1compile" + /session/verify/etherscan: + $ref: "src/server/controllers/verification/etherscan/session/etherscan.session.paths.yaml#/paths/~1session~1verify~1etherscan" /verify: $ref: "src/server/controllers/verification/verify/stateless/verify.stateless.paths.yaml#/paths/~1verify" /verify/solc-json: From a3279017d5de0296cfd960d7bc1629ca6fcff3b5 Mon Sep 17 00:00:00 2001 From: Luis Mastrangelo Date: Tue, 16 Jan 2024 17:32:34 -0300 Subject: [PATCH 3/4] Improve session endpoints message Signed-off-by: Luis Mastrangelo --- openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openapi.yaml b/openapi.yaml index 75feec2e..1f351030 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -15,7 +15,7 @@ servers: url: "http://localhost:5002" tags: - name: Session Verification - description: Not supported endpoints. Use with caution. + description: Endpoints behind CORS validation. Unable to use them from outside the domain `hashscan.io`. paths: /session/data: $ref: "src/server/controllers/verification/session-state/data.session-state.paths.yaml#/paths/~1session~1data" From 1b791f910b8480a134f974b628cd2334b8f473e8 Mon Sep 17 00:00:00 2001 From: Luis Mastrangelo Date: Thu, 18 Jan 2024 21:17:06 +0100 Subject: [PATCH 4/4] Include Nana's suggestion Co-authored-by: Nana Essilfie-Conduah <56320167+Nana-EC@users.noreply.github.com> Signed-off-by: Luis Mastrangelo --- openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openapi.yaml b/openapi.yaml index 1f351030..3500278c 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -15,7 +15,7 @@ servers: url: "http://localhost:5002" tags: - name: Session Verification - description: Endpoints behind CORS validation. Unable to use them from outside the domain `hashscan.io`. + description: Endpoints behind CORS validation. Unable to use them from outside the deployed domain e.g `example.io`. paths: /session/data: $ref: "src/server/controllers/verification/session-state/data.session-state.paths.yaml#/paths/~1session~1data"