custom.0.yaml 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  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
  39. - httpMethods:
  40. - GET
  41. uri: withBeforeGroup
  42. metadata:
  43. groupName: '5. Group 5'
  44. beforeGroup: '2. Group 2'
  45. title:
  46. description:
  47. authenticated: false
  48. headers: {}
  49. urlParameters: {}
  50. queryParameters: {}
  51. bodyParameters: {}
  52. responses: {}
  53. responseFields: {}
  54. - httpMethods:
  55. - GET
  56. uri: withAfterGroup
  57. metadata:
  58. groupName: '4. Group 4'
  59. afterGroup: '5. Group 5'
  60. title:
  61. description:
  62. authenticated: false
  63. headers: {}
  64. urlParameters: {}
  65. queryParameters: {}
  66. bodyParameters: {}
  67. responses: {}
  68. responseFields: {}
  69. - httpMethods:
  70. - GET
  71. uri: belongingToAnEarlierBeforeGroup
  72. metadata:
  73. groupName: '5. Group 5'
  74. title:
  75. description:
  76. authenticated: false
  77. headers: {}
  78. urlParameters: {}
  79. queryParameters: {}
  80. bodyParameters: {}
  81. responses: {}
  82. responseFields: {}