abicoderv2_example.swagger.json

{
  "schemes": [
    "http",
    "https"
  ],
  "swagger": "2.0",
  "info": {
    "description": "Challenges the swagger generator to use lots of types",
    "title": "abicoderv2",
    "version": "1.0"
  },
  "host": "localhost",
  "basePath": "/contracts/0x0123456789abcdef0123456789abcdef0123456",
  "paths": {
    "/inOutType1": {
      "get": {
        "produces": [
          "application/json"
        ],
        "summary": "inOutType1((string,uint232,(string,string,address,bytes),(string,string,address,bytes)[])) [read only]",
        "operationId": "inOutType1_get",
        "parameters": [
          {
            "type": "string",
            "description": "(string,uint232,(string,string,address,bytes),(string,string,address,bytes)[])",
            "name": "arg1",
            "in": "query",
            "required": true
          },
          {
            "$ref": "#/parameters/idParam"
          },
          {
            "$ref": "#/parameters/fromParam"
          },
          {
            "$ref": "#/parameters/valueParam"
          },
          {
            "$ref": "#/parameters/gasParam"
          },
          {
            "$ref": "#/parameters/gaspriceParam"
          },
          {
            "$ref": "#/parameters/transactionParam"
          }
        ],
        "responses": {
          "200": {
            "description": "successful response",
            "schema": {
              "$ref": "#/definitions/inOutType1_outputs"
            }
          },
          "default": {
            "description": "error",
            "schema": {
              "$ref": "#/definitions/error"
            }
          }
        }
      },
      "post": {
        "consumes": [
          "application/json",
          "application/x-yaml"
        ],
        "produces": [
          "application/json"
        ],
        "summary": "inOutType1((string,uint232,(string,string,address,bytes),(string,string,address,bytes)[])) [read only]",
        "operationId": "inOutType1_post",
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/inOutType1_inputs"
            }
          },
          {
            "$ref": "#/parameters/idParam"
          },
          {
            "$ref": "#/parameters/fromParam"
          },
          {
            "$ref": "#/parameters/valueParam"
          },
          {
            "$ref": "#/parameters/gasParam"
          },
          {
            "$ref": "#/parameters/gaspriceParam"
          },
          {
            "$ref": "#/parameters/syncParam"
          },
          {
            "$ref": "#/parameters/callParam"
          },
          {
            "$ref": "#/parameters/privateFromParam"
          },
          {
            "$ref": "#/parameters/privateForParam"
          },
          {
            "$ref": "#/parameters/blocknumberParam"
          },
          {
            "$ref": "#/parameters/acktypeParam"
          }
        ],
        "responses": {
          "200": {
            "description": "successful response",
            "schema": {
              "$ref": "#/definitions/inOutType1_outputs"
            }
          },
          "default": {
            "description": "error",
            "schema": {
              "$ref": "#/definitions/error"
            }
          }
        }
      }
    }
  },
  "definitions": {
    "error": {
      "properties": {
        "error": {
          "description": "Error message",
          "type": "string"
        }
      }
    },
    "inOutType1_inputs": {
      "type": "object",
      "properties": {
        "arg1": {
          "description": "(string,uint232,(string,string,address,bytes),(string,string,address,bytes)[])",
          "type": "object"
        }
      }
    },
    "inOutType1_outputs": {
      "type": "object",
      "properties": {
        "out1": {
          "description": "(string,uint232,(string,string,address,bytes),(string,string,address,bytes)[])",
          "type": "object"
        }
      }
    }
  },
  "parameters": {
    "acktypeParam": {
      "type": "string",
      "description": "Set to 'receipt' to store a receipt before acknowledging an async request (header: x-firefly-acktype)",
      "name": "fly-acktype",
      "in": "query",
      "allowEmptyValue": true
    },
    "blocknumberParam": {
      "type": "string",
      "description": "The target block number for eth_call requests. One of 'earliest/latest/pending', a number or a hex string (header: x-firefly-blocknumber)",
      "name": "fly-blocknumber",
      "in": "query"
    },
    "callParam": {
      "type": "boolean",
      "description": "Perform a read-only call with the same parameters that would be used to invoke, and return result (header: x-firefly-call)",
      "name": "fly-call",
      "in": "query",
      "allowEmptyValue": true
    },
    "fromParam": {
      "type": "string",
      "description": "The 'from' address (header: x-firefly-from)",
      "name": "fly-from",
      "in": "query"
    },
    "gasParam": {
      "type": "integer",
      "description": "Gas to send with the transaction (auto-calculated if not set) (header: x-firefly-gas)",
      "name": "fly-gas",
      "in": "query",
      "allowEmptyValue": true
    },
    "gaspriceParam": {
      "type": "integer",
      "description": "Gas Price offered (header: x-firefly-gasprice)",
      "name": "fly-gasprice",
      "in": "query",
      "allowEmptyValue": true
    },
    "idParam": {
      "type": "string",
      "description": "Optionally set the ID for this request - must be unique if set (header: x-firefly-id)",
      "name": "fly-id",
      "in": "query"
    },
    "privacyGroupIdParam": {
      "type": "string",
      "description": "Private transaction group ID (header: x-firefly-privacyGroupId)",
      "name": "fly-privacygroupid",
      "in": "query"
    },
    "privateForParam": {
      "type": "string",
      "description": "Private transaction recipients (comma separated or multiple params) (header: x-firefly-privatefor)",
      "name": "fly-privatefor",
      "in": "query"
    },
    "privateFromParam": {
      "type": "string",
      "description": "Private transaction sender (header: x-firefly-privatefrom)",
      "name": "fly-privatefrom",
      "in": "query"
    },
    "registerParam": {
      "type": "string",
      "description": "Register the installed contract on a friendly path (overwrites existing) (header: x-firefly-register)",
      "name": "fly-register",
      "in": "query"
    },
    "syncParam": {
      "type": "boolean",
      "default": true,
      "description": "Block the HTTP request until the tx is mined (does not store the receipt) (header: x-firefly-sync)",
      "name": "fly-sync",
      "in": "query",
      "allowEmptyValue": true
    },
    "transactionParam": {
      "type": "string",
      "description": "Query the details for the provided transaction hash (header: x-firefly-transaction)",
      "name": "fly-transaction",
      "in": "query",
      "allowEmptyValue": true
    },
    "valueParam": {
      "type": "integer",
      "description": "Ether value to send with the transaction (header: x-firefly-ethvalue)",
      "name": "fly-ethvalue",
      "in": "query",
      "allowEmptyValue": true
    }
  }
}