custom.0.yaml 898 B

1234567891011121314151617181920212223242526272829303132333435363738
  1. - httpMethods:
  2. - POST
  3. uri: userDefined/yeah
  4. metadata:
  5. groupName: '1. Group 1'
  6. title: 'User defined'
  7. description: 'This endpoint allows you to do something.'
  8. authenticated: false
  9. headers:
  10. Content-Type: application/json
  11. Accept: application/json
  12. urlParameters: {}
  13. queryParameters:
  14. speed:
  15. name: speed
  16. description: How fast the thing should be done. Can be `slow` or `fast`.
  17. required: false
  18. example: fast
  19. type: string
  20. bodyParameters:
  21. something:
  22. name: something
  23. description: The things we should do.
  24. required: true
  25. example:
  26. - string 1
  27. - string 2
  28. type: 'string[]'
  29. responses:
  30. - status: 200
  31. description: 'When the thing was done smoothly.'
  32. content:
  33. hey: "ho ho ho"
  34. responseFields:
  35. hey:
  36. name: hey
  37. description: Who knows?
  38. type: string