example.swagger.yaml 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127
  1. swagger: "2.0"
  2. info:
  3. description: |
  4. This is an API documentation of example.
  5. version: "0.1.0"
  6. title: Example
  7. termsOfService: 'http://www.example.com/terms/'
  8. contact:
  9. email: developer@example.com
  10. license:
  11. name: Proprietary license
  12. url: 'http://www.example.com/license/'
  13. paths:
  14. /one:
  15. put:
  16. parameters:
  17. - in: query
  18. name: NotValidParam
  19. type: integer
  20. example: 12345
  21. required: true
  22. description: This example **should not** have an effect
  23. - in: query
  24. name: ValidParam
  25. type: integer
  26. x-example: 12345
  27. description: This example **should** have an effect
  28. - in: body
  29. name: body
  30. description: property-level examples
  31. schema:
  32. type: object
  33. properties:
  34. one:
  35. type: string
  36. example: hello!
  37. two:
  38. type: object
  39. properties:
  40. uno:
  41. type: string
  42. example: wow!
  43. dos:
  44. type: string
  45. example: hey there!
  46. - in: body
  47. name: body2
  48. description: root schema-level example
  49. schema:
  50. type: object
  51. properties:
  52. foo:
  53. type: string
  54. bar:
  55. type: integer
  56. example:
  57. foo: hey
  58. bar: 123
  59. - in: body
  60. name: body3
  61. description: nested schema-level example
  62. schema:
  63. type: object
  64. properties:
  65. one:
  66. type: object
  67. properties:
  68. uno:
  69. type: string
  70. dos:
  71. type: string
  72. example:
  73. uno: woohoo!
  74. dos: amazing!
  75. responses:
  76. '201':
  77. description: schema-level example
  78. schema:
  79. type: object
  80. properties:
  81. code:
  82. type: integer
  83. format: int64
  84. payload:
  85. type: array
  86. items:
  87. type: object
  88. properties:
  89. id:
  90. type: integer
  91. format: int64
  92. readOnly: true
  93. code:
  94. type: string
  95. name:
  96. type: string
  97. example:
  98. code: 201
  99. payload:
  100. - id: 1
  101. code: AE2
  102. name: Yono
  103. '202':
  104. description: property-level example
  105. schema:
  106. type: object
  107. properties:
  108. code:
  109. type: integer
  110. format: int64
  111. example: 202
  112. payload:
  113. type: array
  114. items:
  115. type: object
  116. properties:
  117. id:
  118. type: integer
  119. format: int64
  120. readOnly: true
  121. example: 1
  122. code:
  123. type: string
  124. example: AE2
  125. name:
  126. type: string
  127. example: Yono