4587.yaml 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127
  1. ---
  2. swagger: '2.0'
  3. info:
  4. version: 0.0.1
  5. title: DDErl REST interface
  6. description: RESTful access to IMEM DB and DDErl
  7. schemes:
  8. - http
  9. - https
  10. securityDefinitions:
  11. basicAuth:
  12. type: basic
  13. description: HTTP Basic Authentication Username:Password
  14. basePath: "/dderlrest/0.0.1"
  15. paths:
  16. "/sql/":
  17. get:
  18. tags:
  19. - sql
  20. security:
  21. - basicAuth: []
  22. summary: execute sql
  23. operationId: execSql
  24. description: Prepare and execute SQL statements
  25. parameters:
  26. - name: x-irest-conn
  27. in: header
  28. required: false
  29. description: ErlImem connection identifier
  30. type: string
  31. produces:
  32. - application/json
  33. responses:
  34. '200':
  35. description: OK
  36. schema:
  37. type: object
  38. headers:
  39. x-irest-conn:
  40. description: ErlImem connection identifier
  41. type: string
  42. '403':
  43. description: Malformed/Invalid
  44. schema:
  45. "$ref": "#/definitions/ErrorResponse"
  46. definitions:
  47. ErrorResponse:
  48. readOnly: true
  49. type: object
  50. required:
  51. - errorCode
  52. - errorMessage
  53. - errorDetails
  54. properties:
  55. errorCode:
  56. description: Error Code
  57. type: number
  58. example: 1400
  59. errorMessage:
  60. description: Error Message
  61. type: string
  62. example: malformed
  63. errorDetails:
  64. description: Error Details
  65. type: string
  66. example: mandatory properties missing or bad type
  67. ViewParams:
  68. readOnly: true
  69. type: array
  70. items:
  71. type: object
  72. required:
  73. - typ
  74. - value
  75. - name
  76. properties:
  77. name:
  78. description: Name
  79. type: string
  80. example: ":atom_user"
  81. value:
  82. description: Value
  83. type: string
  84. example: system
  85. typ:
  86. description: Datatype
  87. type: string
  88. enum:
  89. - atom
  90. - binary
  91. - raw
  92. - blob
  93. - rowid
  94. - binstr
  95. - clob
  96. - nclob
  97. - varchar2
  98. - nvarchar2
  99. - char
  100. - nchar
  101. - boolean
  102. - datetime
  103. - decimal
  104. - float
  105. - fun
  106. - integer
  107. - ipaddr
  108. - list
  109. - map
  110. - number
  111. - pid
  112. - ref
  113. - string
  114. - term
  115. - binterm
  116. - timestamp
  117. - tuple
  118. - userid
  119. example: atom
  120. dir:
  121. description: Direction
  122. type: string
  123. enum:
  124. - in
  125. - out
  126. default: in