github.com/s7techlab/cckit@v0.10.5/examples/cpaper_asservice/cpaper.swagger.json (about)

     1  {
     2    "swagger": "2.0",
     3    "info": {
     4      "title": "cpaper_asservice/cpaper.proto",
     5      "version": "version not set"
     6    },
     7    "consumes": [
     8      "application/json"
     9    ],
    10    "produces": [
    11      "application/json"
    12    ],
    13    "paths": {
    14      "/cpaper": {
    15        "get": {
    16          "summary": "List method returns all registered commercial papers",
    17          "operationId": "CPaperService_List",
    18          "responses": {
    19            "200": {
    20              "description": "A successful response.",
    21              "schema": {
    22                "$ref": "#/definitions/cpaper_asserviceCommercialPaperList"
    23              }
    24            },
    25            "default": {
    26              "description": "An unexpected error response.",
    27              "schema": {
    28                "$ref": "#/definitions/runtimeError"
    29              }
    30            }
    31          },
    32          "tags": [
    33            "CPaperService"
    34          ]
    35        }
    36      },
    37      "/cpaper/buy": {
    38        "post": {
    39          "summary": "Buy commercial paper",
    40          "operationId": "CPaperService_Buy",
    41          "responses": {
    42            "200": {
    43              "description": "A successful response.",
    44              "schema": {
    45                "$ref": "#/definitions/cpaper_asserviceCommercialPaper"
    46              }
    47            },
    48            "default": {
    49              "description": "An unexpected error response.",
    50              "schema": {
    51                "$ref": "#/definitions/runtimeError"
    52              }
    53            }
    54          },
    55          "parameters": [
    56            {
    57              "name": "body",
    58              "in": "body",
    59              "required": true,
    60              "schema": {
    61                "$ref": "#/definitions/cpaper_asserviceBuyCommercialPaper"
    62              }
    63            }
    64          ],
    65          "tags": [
    66            "CPaperService"
    67          ]
    68        }
    69      },
    70      "/cpaper/extid/{id}": {
    71        "get": {
    72          "summary": "GetByExternalId",
    73          "operationId": "CPaperService_GetByExternalId",
    74          "responses": {
    75            "200": {
    76              "description": "A successful response.",
    77              "schema": {
    78                "$ref": "#/definitions/cpaper_asserviceCommercialPaper"
    79              }
    80            },
    81            "default": {
    82              "description": "An unexpected error response.",
    83              "schema": {
    84                "$ref": "#/definitions/runtimeError"
    85              }
    86            }
    87          },
    88          "parameters": [
    89            {
    90              "name": "id",
    91              "in": "path",
    92              "required": true,
    93              "type": "string"
    94            }
    95          ],
    96          "tags": [
    97            "CPaperService"
    98          ]
    99        }
   100      },
   101      "/cpaper/issue": {
   102        "post": {
   103          "summary": "Issue commercial paper",
   104          "operationId": "CPaperService_Issue",
   105          "responses": {
   106            "200": {
   107              "description": "A successful response.",
   108              "schema": {
   109                "$ref": "#/definitions/cpaper_asserviceCommercialPaper"
   110              }
   111            },
   112            "default": {
   113              "description": "An unexpected error response.",
   114              "schema": {
   115                "$ref": "#/definitions/runtimeError"
   116              }
   117            }
   118          },
   119          "parameters": [
   120            {
   121              "name": "body",
   122              "in": "body",
   123              "required": true,
   124              "schema": {
   125                "$ref": "#/definitions/cpaper_asserviceIssueCommercialPaper"
   126              }
   127            }
   128          ],
   129          "tags": [
   130            "CPaperService"
   131          ]
   132        }
   133      },
   134      "/cpaper/redeem": {
   135        "post": {
   136          "summary": "Redeem commercial paper",
   137          "operationId": "CPaperService_Redeem",
   138          "responses": {
   139            "200": {
   140              "description": "A successful response.",
   141              "schema": {
   142                "$ref": "#/definitions/cpaper_asserviceCommercialPaper"
   143              }
   144            },
   145            "default": {
   146              "description": "An unexpected error response.",
   147              "schema": {
   148                "$ref": "#/definitions/runtimeError"
   149              }
   150            }
   151          },
   152          "parameters": [
   153            {
   154              "name": "body",
   155              "in": "body",
   156              "required": true,
   157              "schema": {
   158                "$ref": "#/definitions/cpaper_asserviceRedeemCommercialPaper"
   159              }
   160            }
   161          ],
   162          "tags": [
   163            "CPaperService"
   164          ]
   165        }
   166      },
   167      "/cpaper/{issuer}/{paper_number}": {
   168        "get": {
   169          "summary": "Get method returns commercial paper data by id",
   170          "operationId": "CPaperService_Get",
   171          "responses": {
   172            "200": {
   173              "description": "A successful response.",
   174              "schema": {
   175                "$ref": "#/definitions/cpaper_asserviceCommercialPaper"
   176              }
   177            },
   178            "default": {
   179              "description": "An unexpected error response.",
   180              "schema": {
   181                "$ref": "#/definitions/runtimeError"
   182              }
   183            }
   184          },
   185          "parameters": [
   186            {
   187              "name": "issuer",
   188              "in": "path",
   189              "required": true,
   190              "type": "string"
   191            },
   192            {
   193              "name": "paper_number",
   194              "in": "path",
   195              "required": true,
   196              "type": "string"
   197            }
   198          ],
   199          "tags": [
   200            "CPaperService"
   201          ]
   202        },
   203        "delete": {
   204          "summary": "Delete commercial paper",
   205          "operationId": "CPaperService_Delete",
   206          "responses": {
   207            "200": {
   208              "description": "A successful response.",
   209              "schema": {
   210                "$ref": "#/definitions/cpaper_asserviceCommercialPaper"
   211              }
   212            },
   213            "default": {
   214              "description": "An unexpected error response.",
   215              "schema": {
   216                "$ref": "#/definitions/runtimeError"
   217              }
   218            }
   219          },
   220          "parameters": [
   221            {
   222              "name": "issuer",
   223              "in": "path",
   224              "required": true,
   225              "type": "string"
   226            },
   227            {
   228              "name": "paper_number",
   229              "in": "path",
   230              "required": true,
   231              "type": "string"
   232            }
   233          ],
   234          "tags": [
   235            "CPaperService"
   236          ]
   237        }
   238      }
   239    },
   240    "definitions": {
   241      "CommercialPaperState": {
   242        "type": "string",
   243        "enum": [
   244          "STATE_ISSUED",
   245          "STATE_TRADING",
   246          "STATE_REDEEMED"
   247        ],
   248        "default": "STATE_ISSUED"
   249      },
   250      "cpaper_asserviceBuyCommercialPaper": {
   251        "type": "object",
   252        "properties": {
   253          "issuer": {
   254            "type": "string"
   255          },
   256          "paper_number": {
   257            "type": "string"
   258          },
   259          "current_owner": {
   260            "type": "string"
   261          },
   262          "new_owner": {
   263            "type": "string"
   264          },
   265          "price": {
   266            "type": "integer",
   267            "format": "int32"
   268          },
   269          "purchase_date": {
   270            "type": "string",
   271            "format": "date-time"
   272          }
   273        },
   274        "title": "BuyCommercialPaper event"
   275      },
   276      "cpaper_asserviceCommercialPaper": {
   277        "type": "object",
   278        "properties": {
   279          "issuer": {
   280            "type": "string",
   281            "title": "Issuer and Paper number comprises composite primary key of Commercial paper entry"
   282          },
   283          "paper_number": {
   284            "type": "string"
   285          },
   286          "owner": {
   287            "type": "string"
   288          },
   289          "issue_date": {
   290            "type": "string",
   291            "format": "date-time"
   292          },
   293          "maturity_date": {
   294            "type": "string",
   295            "format": "date-time"
   296          },
   297          "face_value": {
   298            "type": "integer",
   299            "format": "int32"
   300          },
   301          "state": {
   302            "$ref": "#/definitions/CommercialPaperState"
   303          },
   304          "external_id": {
   305            "type": "string",
   306            "title": "Additional unique field for entry"
   307          }
   308        },
   309        "title": "Commercial Paper state entry"
   310      },
   311      "cpaper_asserviceCommercialPaperList": {
   312        "type": "object",
   313        "properties": {
   314          "items": {
   315            "type": "array",
   316            "items": {
   317              "$ref": "#/definitions/cpaper_asserviceCommercialPaper"
   318            }
   319          }
   320        },
   321        "title": "Container for returning multiple entities"
   322      },
   323      "cpaper_asserviceIssueCommercialPaper": {
   324        "type": "object",
   325        "properties": {
   326          "issuer": {
   327            "type": "string"
   328          },
   329          "paper_number": {
   330            "type": "string"
   331          },
   332          "issue_date": {
   333            "type": "string",
   334            "format": "date-time"
   335          },
   336          "maturity_date": {
   337            "type": "string",
   338            "format": "date-time"
   339          },
   340          "face_value": {
   341            "type": "integer",
   342            "format": "int32"
   343          },
   344          "external_id": {
   345            "type": "string",
   346            "title": "external_id  - once more uniq id of state entry"
   347          }
   348        },
   349        "title": "IssueCommercialPaper event"
   350      },
   351      "cpaper_asserviceRedeemCommercialPaper": {
   352        "type": "object",
   353        "properties": {
   354          "issuer": {
   355            "type": "string"
   356          },
   357          "paper_number": {
   358            "type": "string"
   359          },
   360          "redeeming_owner": {
   361            "type": "string"
   362          },
   363          "redeem_date": {
   364            "type": "string",
   365            "format": "date-time"
   366          }
   367        },
   368        "title": "RedeemCommercialPaper event"
   369      },
   370      "protobufAny": {
   371        "type": "object",
   372        "properties": {
   373          "type_url": {
   374            "type": "string"
   375          },
   376          "value": {
   377            "type": "string",
   378            "format": "byte"
   379          }
   380        }
   381      },
   382      "runtimeError": {
   383        "type": "object",
   384        "properties": {
   385          "error": {
   386            "type": "string"
   387          },
   388          "code": {
   389            "type": "integer",
   390            "format": "int32"
   391          },
   392          "message": {
   393            "type": "string"
   394          },
   395          "details": {
   396            "type": "array",
   397            "items": {
   398              "$ref": "#/definitions/protobufAny"
   399            }
   400          }
   401        }
   402      }
   403    }
   404  }