feat: add swagger for REST API#2
Conversation
VladimirBalun
added
documentation
| type : string | ||
| requestBody: | ||
| required: true | ||
| content: |
There was a problem hiding this comment.
PUT method.
Missing the fields available to update.
There was a problem hiding this comment.
we intend to allow updating only status, no?
|
|
||
| info: | ||
| title: Crasher REST API | ||
| description: Current API describes UI interaction with Crasher |
There was a problem hiding this comment.
Do we consider "Crasher" as the whole system that consists of UI, language libraries and server? If so let's say with Crasher Server.
| description: url path for next pagination page | ||
| required: | ||
| - totalSize | ||
| - self |
There was a problem hiding this comment.
how does server tells a client that it was the last page? By totalSize = 0?
| - 0 | ||
| - 1 | ||
| - 2 | ||
| - 3 |
There was a problem hiding this comment.
it seems to me that it can be bad approach to make enums in rest api, i think it's better to use string representations of status.
| 500: | ||
| description: Server error | ||
| delete: | ||
| summary: Delete all core dumps |
There was a problem hiding this comment.
maybe add some optional parameters, by application, by status and etc.?
| type : string | ||
| requestBody: | ||
| required: true | ||
| content: |
There was a problem hiding this comment.
we intend to allow updating only status, no?
3 participants
No description provided.