openapi.yaml 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138
  1. openapi: 3.0.3
  2. info:
  3. title: null
  4. description: ''
  5. version: 3.9.9
  6. servers:
  7. -
  8. url: 'http://localhost'
  9. paths:
  10. /api/withDescription:
  11. get:
  12. summary: 'Example title.'
  13. description: "This will be the long description.\nIt can also be multiple lines long."
  14. parameters:
  15. -
  16. in: header
  17. name: Content-Type
  18. description: ''
  19. example: application/json
  20. schema:
  21. type: string
  22. -
  23. in: header
  24. name: Accept
  25. description: ''
  26. example: application/json
  27. schema:
  28. type: string
  29. responses: { }
  30. tags:
  31. - 'Group A'
  32. security: []
  33. /api/withResponseTag:
  34. get:
  35. summary: ''
  36. description: ''
  37. parameters:
  38. -
  39. in: header
  40. name: Content-Type
  41. description: ''
  42. example: application/json
  43. schema:
  44. type: string
  45. -
  46. in: header
  47. name: Accept
  48. description: ''
  49. example: application/json
  50. schema:
  51. type: string
  52. responses:
  53. 200:
  54. description: '200'
  55. content:
  56. application/json:
  57. schema:
  58. type: object
  59. example:
  60. id: 4
  61. name: banana
  62. color: red
  63. weight: '1 kg'
  64. delicious: true
  65. responseTag: true
  66. properties:
  67. id: { type: integer, example: 4 }
  68. name: { type: string, example: banana }
  69. color: { type: string, example: red }
  70. weight: { type: string, example: '1 kg' }
  71. delicious: { type: boolean, example: true }
  72. responseTag: { type: boolean, example: true }
  73. tags:
  74. - 'Group A'
  75. security: []
  76. /api/withQueryParameters:
  77. get:
  78. summary: ''
  79. description: ''
  80. parameters:
  81. -
  82. in: query
  83. name: location_id
  84. description: 'The id of the location.'
  85. example: consequatur
  86. required: true
  87. schema:
  88. type: string
  89. -
  90. in: query
  91. name: user_id
  92. description: 'The id of the user.'
  93. example: me
  94. required: true
  95. schema:
  96. type: string
  97. -
  98. in: query
  99. name: page
  100. description: 'The page number.'
  101. example: '4'
  102. required: true
  103. schema:
  104. type: string
  105. -
  106. in: query
  107. name: 'filters.*'
  108. description: 'The filters.'
  109. example: consequatur
  110. required: false
  111. schema:
  112. type: string
  113. -
  114. in: query
  115. name: url_encoded
  116. description: 'Used for testing that URL parameters will be URL-encoded where needed.'
  117. example: '+ []&='
  118. required: false
  119. schema:
  120. type: string
  121. -
  122. in: header
  123. name: Content-Type
  124. description: ''
  125. example: application/json
  126. schema:
  127. type: string
  128. -
  129. in: header
  130. name: Accept
  131. description: ''
  132. example: application/json
  133. schema:
  134. type: string
  135. responses: { }
  136. tags:
  137. - 'Group A'
  138. security: []