Add swagger api file #2
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,303 @@ | ||
| swagger: "2.0" | ||
| info: | ||
| version: "1.0.1" | ||
| title: "Closecom" | ||
| tags: | ||
| - name: "account" | ||
| - name: "bluetooth" | ||
| - name: "messenger" | ||
| paths: | ||
| /account/create: | ||
| post: | ||
| tags: | ||
| - "account" | ||
| parameters: | ||
| - in: "body" | ||
| name: "body" | ||
| required: true | ||
| schema: | ||
| $ref: "#/definitions/Account" | ||
| responses: | ||
| "200": | ||
| description: "OK" | ||
| schema: | ||
| $ref: "#/definitions/Token" | ||
| "400": | ||
| description: "Invalid email or password" | ||
| "405": | ||
| description: "Email already registered" | ||
| /account/auth: | ||
| post: | ||
| tags: | ||
| - "account" | ||
| parameters: | ||
| - in: "body" | ||
| name: "body" | ||
| required: true | ||
| schema: | ||
| $ref: "#/definitions/Account" | ||
| responses: | ||
| "200": | ||
| description: "OK" | ||
| schema: | ||
| $ref: "#/definitions/Token" | ||
| "400": | ||
| description: "Invalid email or password" | ||
| "405": | ||
| description: "Email already registered" | ||
| /account/delete: | ||
| post: | ||
| tags: | ||
| - "account" | ||
| parameters: | ||
| - in: "query" | ||
| name: "token" | ||
| required: true | ||
| type: "string" | ||
| responses: | ||
| "200": | ||
| description: "OK" | ||
| "401": | ||
| description: "Invalid token" | ||
| /account/recovery: | ||
| post: | ||
| description: "Restore password for account by user email" | ||
| tags: | ||
| - "account" | ||
| parameters: | ||
| - in: "query" | ||
| name: "email" | ||
| required: true | ||
| type: "string" | ||
| responses: | ||
| "200": | ||
| description: "OK" | ||
| "401": | ||
| description: "Invalid token" | ||
| /bluetooth/user_info: | ||
| get: | ||
| tags: | ||
| - "bluetooth" | ||
| parameters: | ||
| - in: "query" | ||
| name: "bid" | ||
| required: true | ||
| type: "string" | ||
| responses: | ||
| "200": | ||
| description: "OK" | ||
| schema: | ||
| $ref: "#/definitions/User" | ||
| "400": | ||
| description: "Invalid BID" | ||
| "401": | ||
| description: "Invalid token" | ||
| /bluetooth/set_bid: | ||
| post: | ||
| tags: | ||
| - "bluetooth" | ||
| parameters: | ||
| - in: "query" | ||
| name: "token" | ||
| required: true | ||
| type: "string" | ||
| - in: "query" | ||
| name: "bid" | ||
| required: true | ||
| type: "string" | ||
| responses: | ||
| "200": | ||
| description: "OK" | ||
| "400": | ||
| description: "Invalid BID" | ||
| "401": | ||
| description: "Invalid token" | ||
| /messenger/dialogs: | ||
| get: | ||
| tags: | ||
| - "messenger" | ||
| parameters: | ||
| - in: "query" | ||
| name: "token" | ||
| required: true | ||
| type: "string" | ||
| responses: | ||
| "200": | ||
| description: "OK" | ||
| schema: | ||
| $ref: "#/definitions/Dialogs" | ||
| "400": | ||
| description: "Invalid email" | ||
| "401": | ||
| description: "Invalid token" | ||
| /messenger/dialog_history: | ||
| get: | ||
| tags: | ||
| - "messenger" | ||
| parameters: | ||
| - in: "query" | ||
| name: "token" | ||
| required: true | ||
| type: "string" | ||
| - in: "query" | ||
| name: "dialog_id" | ||
| required: true | ||
| type: "integer" | ||
| responses: | ||
| "200": | ||
| description: "OK" | ||
| schema: | ||
| $ref: "#/definitions/Dialog" | ||
| "400": | ||
| description: "Invalid dialog id" | ||
| "401": | ||
| description: "Invalid token" | ||
| /messenger/send_message: | ||
| post: | ||
| tags: | ||
| - "messenger" | ||
| parameters: | ||
| - in: "query" | ||
| name: "token" | ||
| required: true | ||
| type: "string" | ||
| - in: "query" | ||
| name: "dialog_id" | ||
|
Collaborator
Author
There was a problem hiding this comment. Тут аналогично, сообщения должны посылаться в dialog |
||
| required: true | ||
| type: "integer" | ||
| - in: "body" | ||
| name: "body" | ||
| required: true | ||
| schema: | ||
| $ref: "#/definitions/Message" | ||
| responses: | ||
| "200": | ||
| description: "OK" | ||
| schema: | ||
| $ref: "#/definitions/Dialog" | ||
| "400": | ||
| description: "Invalid email" | ||
| "401": | ||
| description: "Invalid token" | ||
| "405": | ||
| description: "Invalid message" | ||
| /messenger/delete_message: | ||
| post: | ||
| tags: | ||
| - "messenger" | ||
| parameters: | ||
| - in: "query" | ||
| name: "token" | ||
| required: true | ||
| type: "string" | ||
| - in: "query" | ||
| name: "message_id" | ||
| required: true | ||
| type: "integer" | ||
| responses: | ||
| "200": | ||
| description: "OK" | ||
| "400": | ||
| description: "Invalid message id" | ||
| "401": | ||
| description: "Invalid token" | ||
| /messenger/delete_dialog: | ||
| post: | ||
| tags: | ||
| - "messenger" | ||
| parameters: | ||
| - in: "query" | ||
| name: "token" | ||
| required: true | ||
| type: "string" | ||
| - in: "query" | ||
| name: "dialog_id" | ||
| required: true | ||
| type: "integer" | ||
| responses: | ||
| "200": | ||
| description: "OK" | ||
| "400": | ||
| description: "Invalid message id" | ||
| "401": | ||
| description: "Invalid token" | ||
| definitions: | ||
| Id: | ||
| type: "integer" | ||
| example: 21796 | ||
| Email: | ||
| type: "string" | ||
| example: "user@mail.ru" | ||
| Account: | ||
| type: "object" | ||
| properties: | ||
| email: | ||
| $ref: "#/definitions/Email" | ||
| password: | ||
| type: "string" | ||
| description: "SHA-256 hash of user original password" | ||
| example: "f33ae3bc9a22cd7564990a794" | ||
| User: | ||
| type: "object" | ||
| properties: | ||
| email: | ||
| $ref: "#/definitions/Email" | ||
| name: | ||
| type: "string" | ||
| description: "User name" | ||
| example: "John" | ||
| Token: | ||
| type: "object" | ||
| properties: | ||
| token: | ||
| type: "string" | ||
| example: "e150a1ec81e8e93e1eae2c3a7" | ||
| Message: | ||
| type: "object" | ||
| properties: | ||
| sender: | ||
| $ref: "#/definitions/Email" | ||
| text: | ||
| type: "string" | ||
| example: "Hello, John!" | ||
| timestamp: | ||
| type: "integer" | ||
| example: 1616853526 | ||
|
Collaborator
Author
There was a problem hiding this comment. Хотим иметь поле с временем отправки сообщения - добавил
Collaborator
Author
There was a problem hiding this comment. Кажется в dialogs_info у нас дежит Message, а по логике должен лежать StorageMessage |
||
| StoredMessage: | ||
| type: "object" | ||
| properties: | ||
| message_id: | ||
| $ref: "#/definitions/Id" | ||
| sender: | ||
| $ref: "#/definitions/Email" | ||
| text: | ||
| type: "string" | ||
| example: "Hello, John!" | ||
| timestamp: | ||
| type: "integer" | ||
| example: 1616853526 | ||
|
Collaborator
Author
There was a problem hiding this comment. StoredMessage - возвращаются в dialogs_history, для них тоже хотим знать время |
||
| Dialog: | ||
| type: "object" | ||
| properties: | ||
| user: | ||
| $ref: "#/definitions/User" | ||
| messages: | ||
| type: "array" | ||
| items: | ||
| $ref: "#/definitions/StoredMessage" | ||
| DialogInfo: | ||
| type: "object" | ||
| properties: | ||
| dialog_id: | ||
| $ref: "#/definitions/Id" | ||
| user: | ||
| $ref: "#/definitions/User" | ||
| last_message: | ||
| $ref: "#/definitions/Message" | ||
| Dialogs: | ||
| type: "object" | ||
| properties: | ||
| dialogs: | ||
| type: "array" | ||
| items: | ||
| $ref: "#/definitions/DialogInfo" | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Думаю, в dialog_history должен передаваться dialog_id, а не email конкретного пользователя. Тогда будет легче групповой чат сделать