Advertisement
Guest User

3.0

a guest
Apr 12th, 2018
222
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 5.80 KB | None | 0 0
  1. swagger: "2.0"
  2. info:
  3. description: "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters."
  4. version: "1.0.0"
  5. title: "Swagger Petstore"
  6. termsOfService: "http://swagger.io/terms/"
  7. contact:
  8. email: "apiteam@swagger.io"
  9. license:
  10. name: "Apache 2.0"
  11. url: "http://www.apache.org/licenses/LICENSE-2.0.html"
  12. host: "dados.ufrn.br"
  13. basePath: "/api/3/action/"
  14. tags:
  15. - name: "DataSet"
  16. description: "Everything about your DataSet"
  17. externalDocs:
  18. description: "Find out more"
  19. url: "http://swagger.io"
  20. - name: "store"
  21. description: "Access to Petstore orders"
  22. - name: "user"
  23. description: "Operations about user"
  24. externalDocs:
  25. description: "Find out more about our store"
  26. url: "http://swagger.io"
  27. schemes:
  28. - "http"
  29. paths:
  30. /package_list:
  31. get:
  32. tags:
  33. - "DataSet"
  34. summary: "Retorna uma lista dos nomes dos conjuntos de dados do site"
  35. description: "Retorna uma lista dos nomes dos conjuntos de dados do site (pacotes)."
  36. operationId: ""
  37. consumes:
  38. - "application/json"
  39. - "application/xml"
  40. produces:
  41. - "application/json"
  42. parameters:
  43. - in: "body"
  44. name: "limit"
  45. description: "se fornecido, a lista de conjuntos de dados será dividida em páginas de no máximo conjuntos de dados por página e somente uma página será retornada por vez."
  46. required: false
  47. schema:
  48. $ref: "#/definitions/DataSet"
  49. responses:
  50. 200:
  51. description: "successful operation"
  52. schema:
  53. type: "array"
  54. items:
  55. $ref: "#/definitions/DataSet"
  56. 400:
  57. description: "Invalid status value"
  58. 404:
  59. description: "Invalid resource_id"
  60. security:
  61. - petstore_auth:
  62. - "write:pets"
  63. - "read:pets"
  64.  
  65. /datastore_search/{resource_id}:
  66. get:
  67. tags:
  68. - "DataSet"
  69. summary: "Finds datasets by UFRN"
  70. description: "Multiple status values can be provided with comma separated strings"
  71. operationId: "findPetsByStatus"
  72. produces:
  73. - "application/xml"
  74. - "application/json"
  75. parameters:
  76. - name: "resource_id"
  77. in: "path"
  78. description: "ID of dateSet"
  79. required: true
  80. type: "string"
  81. format: "int64"
  82. responses:
  83. 200:
  84. description: "successful operation"
  85. schema:
  86. type: "array"
  87. items:
  88. $ref: "#/definitions/DataSet"
  89. 400:
  90. description: "Invalid status value"
  91. 404:
  92. description: "Invalid resource_id"
  93. security:
  94. - petstore_auth:
  95. - "write:pets"
  96. - "read:pets"
  97.  
  98. securityDefinitions:
  99. petstore_auth:
  100. type: "oauth2"
  101. authorizationUrl: "http://petstore.swagger.io/oauth/dialog"
  102. flow: "implicit"
  103. scopes:
  104. write:pets: "modify pets in your account"
  105. read:pets: "read your pets"
  106. api_key:
  107. type: "apiKey"
  108. name: "api_key"
  109. in: "header"
  110. definitions:
  111. Order:
  112. type: "object"
  113. properties:
  114. id:
  115. type: "integer"
  116. format: "int64"
  117. petId:
  118. type: "integer"
  119. format: "int64"
  120. quantity:
  121. type: "integer"
  122. format: "int32"
  123. shipDate:
  124. type: "string"
  125. format: "date-time"
  126. status:
  127. type: "string"
  128. description: "Order Status"
  129. enum:
  130. - "placed"
  131. - "approved"
  132. - "delivered"
  133. complete:
  134. type: "boolean"
  135. default: false
  136. xml:
  137. name: "Order"
  138. Category:
  139. type: "object"
  140. properties:
  141. id:
  142. type: "integer"
  143. format: "int64"
  144. name:
  145. type: "string"
  146. xml:
  147. name: "Category"
  148. User:
  149. type: "object"
  150. properties:
  151. id:
  152. type: "integer"
  153. format: "int64"
  154. username:
  155. type: "string"
  156. firstName:
  157. type: "string"
  158. lastName:
  159. type: "string"
  160. email:
  161. type: "string"
  162. password:
  163. type: "string"
  164. phone:
  165. type: "string"
  166. userStatus:
  167. type: "integer"
  168. format: "int32"
  169. description: "User Status"
  170. xml:
  171. name: "User"
  172. Tag:
  173. type: "object"
  174. properties:
  175. id:
  176. type: "integer"
  177. format: "int64"
  178. name:
  179. type: "string"
  180. xml:
  181. name: "Tag"
  182. DataSet:
  183. type: "object"
  184. required:
  185. - "name"
  186. - "photoUrls"
  187. properties:
  188. help:
  189. type: "string"
  190. example: "http://dados.ufrn.br/api/3/action/help_show?name=datastore_search"
  191. sucess:
  192. type: "boolean"
  193. fields:
  194. type: "array"
  195. items:
  196. $ref: "#/definitions/Tag"
  197. name:
  198. type: "string"
  199. example: "DataSet"
  200. photoUrls:
  201. type: "array"
  202. xml:
  203. name: "photoUrl"
  204. wrapped: true
  205. items:
  206. type: "string"
  207. tags:
  208. type: "array"
  209. xml:
  210. name: "tag"
  211. wrapped: true
  212. items:
  213. $ref: "#/definitions/Tag"
  214. status:
  215. type: "string"
  216. description: "pet status in the store"
  217. enum:
  218. - "available"
  219. - "pending"
  220. - "sold"
  221. xml:
  222. name: "Pet"
  223. ApiResponse:
  224. type: "object"
  225. properties:
  226. code:
  227. type: "integer"
  228. format: "int32"
  229. type:
  230. type: "string"
  231. message:
  232. type: "string"
  233. externalDocs:
  234. description: "Find out more about Swagger"
  235. url: "http://swagger.io"
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement