diff --git a/debug-openapi-spec.json b/debug-openapi-spec.json index f2524c9b..c00e4fc1 100644 --- a/debug-openapi-spec.json +++ b/debug-openapi-spec.json @@ -1,74 +1,76 @@ { - "openapi" : "3.0.0", - "info" : { - "title" : "Debug API", - "version" : "1.0.0", - "license" : { - "name" : "Business Source License 1.1", - "url" : "https://github.com/primev/mev-commit/blob/main/LICENSE" + "openapi": "3.0.0", + "info": { + "title": "Debug API", + "version": "1.0.0", + "license": { + "name": "Business Source License 1.1", + "url": "https://github.com/primev/mev-commit/blob/main/LICENSE" } }, - "paths" : { - "/v1/debug/cancel_transaction/{txHash}" : { - "post" : { - "summary" : "CancelTransaction", - "description" : "CancelTransaction is called by the provider to cancel a transaction sent from this wallet.", - "operationId" : "DebugService_CancelTransaction", - "responses" : { - "200" : { - "description" : "A successful response.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/v1CancelTransactionResponse" + "paths": { + "/v1/debug/cancel_transaction/{txHash}": { + "post": { + "summary": "CancelTransaction", + "description": "CancelTransaction is called by the provider to cancel a transaction sent from this wallet.", + "operationId": "DebugService_CancelTransaction", + "responses": { + "200": { + "description": "A successful response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/v1CancelTransactionResponse" } } } }, - "default" : { - "description" : "An unexpected error response.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/googlerpcStatus" + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/googlerpcStatus" } } } } }, - "parameters" : [ { - "name" : "txHash", - "description" : "Hex string encoding of the hash of the transaction that the bidder wants to cancel.", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" + "parameters": [ + { + "name": "txHash", + "description": "Hex string encoding of the hash of the transaction that the bidder wants to cancel.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } } - } ] + ] } }, - "/v1/debug/pending_transactions" : { - "get" : { - "summary" : "GetPendingTransactions", - "description" : "GetPendingTransactions is called by the provider to get the pending transactions for the wallet.", - "operationId" : "DebugService_GetPendingTransactions", - "responses" : { - "200" : { - "description" : "A successful response.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/v1PendingTransactionsResponse" + "/v1/debug/pending_transactions": { + "get": { + "summary": "GetPendingTransactions", + "description": "GetPendingTransactions is called by the provider to get the pending transactions for the wallet.", + "operationId": "DebugService_GetPendingTransactions", + "responses": { + "200": { + "description": "A successful response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/v1PendingTransactionsResponse" } } } }, - "default" : { - "description" : "An unexpected error response.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/googlerpcStatus" + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/googlerpcStatus" } } } @@ -76,28 +78,28 @@ } } }, - "/v1/debug/topology" : { - "get" : { - "summary" : "GetTopology", - "description" : "GetTopology is called by the user to get the topology of the node. The topology\nincludes connectivity information about the node.", - "operationId" : "DebugService_GetTopology", - "responses" : { - "200" : { - "description" : "A successful response.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/v1TopologyResponse" + "/v1/debug/topology": { + "get": { + "summary": "GetTopology", + "description": "GetTopology is called by the user to get the topology of the node. The topology\nincludes connectivity information about the node.", + "operationId": "DebugService_GetTopology", + "responses": { + "200": { + "description": "A successful response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/v1TopologyResponse" } } } }, - "default" : { - "description" : "An unexpected error response.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/googlerpcStatus" + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/googlerpcStatus" } } } @@ -106,109 +108,109 @@ } } }, - "components" : { - "schemas" : { - "googlerpcStatus" : { - "type" : "object", - "properties" : { - "code" : { - "type" : "integer", - "format" : "int32" + "components": { + "schemas": { + "googlerpcStatus": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" }, - "message" : { - "type" : "string" + "message": { + "type": "string" }, - "details" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/protobufAny" + "details": { + "type": "array", + "items": { + "$ref": "#/components/schemas/protobufAny" } } } }, - "protobufAny" : { - "type" : "object", - "properties" : { - "@type" : { - "type" : "string" + "protobufAny": { + "type": "object", + "properties": { + "@type": { + "type": "string" } }, - "additionalProperties" : { } + "additionalProperties": {} }, - "protobufNullValue" : { - "type" : "string", - "description" : "`NullValue` is a singleton enumeration to represent the null value for the\n`Value` type union.\n\nThe JSON representation for `NullValue` is JSON `null`." + "protobufNullValue": { + "type": "string", + "description": "`NullValue` is a singleton enumeration to represent the null value for the\n`Value` type union.\n\nThe JSON representation for `NullValue` is JSON `null`." }, - "v1CancelTransactionResponse" : { - "type" : "object", - "example" : { - "txHash" : "71c1348f2d7ff7e814f9c3617983703435ea7446de420aeac488bf1de35737e8" + "v1CancelTransactionResponse": { + "type": "object", + "example": { + "txHash": "71c1348f2d7ff7e814f9c3617983703435ea7446de420aeac488bf1de35737e8" }, - "properties" : { - "txHash" : { - "type" : "string", - "description" : "Hex string encoding of the hash of the transaction that the bidder wants to cancel.", - "pattern" : "[a-fA-F0-9]{64}" + "properties": { + "txHash": { + "type": "string", + "description": "Hex string encoding of the hash of the transaction that the bidder wants to cancel.", + "pattern": "[a-fA-F0-9]{64}" } }, - "description" : "Hash of the cancellation transaction request.", - "title" : "Cancel response", - "required" : [ "txHash" ] + "description": "Hash of the cancellation transaction request.", + "title": "Cancel response", + "required": ["txHash"] }, - "v1PendingTransactionsResponse" : { - "type" : "object", - "properties" : { - "pendingTransactions" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/v1TransactionInfo" + "v1PendingTransactionsResponse": { + "type": "object", + "properties": { + "pendingTransactions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/v1TransactionInfo" }, - "description" : "List of pending transactions in the provider provider_registry." + "description": "List of pending transactions in the provider provider_registry." } }, - "description" : "Transaction info returned by the provider.", - "title" : "Pending transactions list", - "required" : [ "pendingTransactions" ] + "description": "Transaction info returned by the provider.", + "title": "Pending transactions list", + "required": ["pendingTransactions"] }, - "v1TopologyResponse" : { - "type" : "object", - "properties" : { - "topology" : { - "type" : "object", - "description" : "Topology of the node." + "v1TopologyResponse": { + "type": "object", + "properties": { + "topology": { + "type": "object", + "description": "Topology of the node." } }, - "description" : "Topology of the node.", - "title" : "Topology", - "required" : [ "topology" ] + "description": "Topology of the node.", + "title": "Topology", + "required": ["topology"] }, - "v1TransactionInfo" : { - "type" : "object", - "example" : { - "created" : "2009-11-10 23:00:00 +0000 UTC m=+0.000000001", - "nonce" : 1234, - "txHash" : "71c1348f2d7ff7e814f9c3617983703435ea7446de420aeac488bf1de35737e8" + "v1TransactionInfo": { + "type": "object", + "example": { + "created": "2009-11-10 23:00:00 +0000 UTC m=+0.000000001", + "nonce": 1234, + "txHash": "71c1348f2d7ff7e814f9c3617983703435ea7446de420aeac488bf1de35737e8" }, - "properties" : { - "txHash" : { - "type" : "string", - "description" : "Hex string encoding of the hash of the transaction that the bidder wants to include in the block.", - "pattern" : "[a-fA-F0-9]{64}" + "properties": { + "txHash": { + "type": "string", + "description": "Hex string encoding of the hash of the transaction that the bidder wants to include in the block.", + "pattern": "[a-fA-F0-9]{64}" }, - "nonce" : { - "type" : "string", - "format" : "int64", - "description" : "Nonce used for the transaction." + "nonce": { + "type": "string", + "format": "int64", + "description": "Nonce used for the transaction." }, - "created" : { - "type" : "string", - "description" : "Time when the transaction was created." + "created": { + "type": "string", + "description": "Time when the transaction was created." } }, - "description" : "Transaction info returned by the provider.", - "title" : "Transaction info", - "required" : [ "txHash", "nonce", "created" ] + "description": "Transaction info returned by the provider.", + "title": "Transaction info", + "required": ["txHash", "nonce", "created"] } } } -} \ No newline at end of file +}