feat(doc): add docs documentation🤫😂

docs/openvk_engine/api/methods/docs/add.md

@@ -0,0 +1,22 @@
+### `docs.add` 🔰
+
+Adds document to user collection
+
+**Params**:
+
+|Name|Value|Description|
+|--|--|--|
+|`owner_id`|unsigned int|ID of owner|
+|`doc_id`|unsigned int|ID of document|
+|`access_key`|string|Access key|
+
+**Result**
+
+Returns id of new document
+
+**Possible errors**:
+
+|Code|Description|
+|--|--|
+|1150|Invalid document id|
+|100|One of the parameters specified was missing or invalid: this document already added|

docs/openvk_engine/api/methods/docs/delete.md

@@ -0,0 +1,21 @@
+### `docs.delete` 🔰
+
+Deletes document from user collection.
+
+**Params**:
+
+|Name|Value|Description|
+|--|--|--|
+|`owner_id`|unsigned int|ID of owner|
+|`doc_id`|unsigned int|ID of document|
+
+**Result**
+
+Returns 1 on success.
+
+**Possible errors**:
+
+|Code|Description|
+|--|--|
+|1150|Invalid document id|
+|1153|Access to document is denied|

docs/openvk_engine/api/methods/docs/edit.md

@@ -0,0 +1,18 @@
+### `docs.edit` 🔰
+
+Edits document
+
+**Params**:
+
+|Name|Value|Description|
+|--|--|--|
+|`owner_id`|unsigned int|ID of owner|
+|`doc_id`|unsigned int|ID of document|
+|`title`|string|New title|
+|`tags`|csv|New tags|
+|`folder_id`|int|New folder id (0, 3)|
+|`owner_hidden`|bool (0,1)|Is owner hidden|
+
+**Result**
+
+Returns 1 on success.

docs/openvk_engine/api/methods/docs/get.md

@@ -0,0 +1,18 @@
+### `docs.get` 🔰
+
+Edits document
+
+**Params**:
+
+|Name|Value|Description|
+|--|--|--|
+|`count`|unsigned int|Count|
+|`offset`|unsigned int|Offset|
+|`type`|int|VK API type of document|
+|`owner_id`|int|Owner ID|
+|`return_tags`|bool (0, 1)|Return "tags" field|
+|`order`|int (0,1,2)| |
+
+**Result**
+
+Returns `count` and `items` fields.

docs/openvk_engine/api/methods/docs/getById.md

@@ -0,0 +1,14 @@
+### `docs.getById` 🔰
+
+Gets docs by ids
+
+**Params**:
+
+|Name|Value|Description|
+|--|--|--|
+|`docs`|csv array|Ids of documents|
+|`return_tags`|bool (0, 1)|Return "tags" fields|
+
+**Result**
+
+Returns documents objects array.

docs/openvk_engine/api/methods/docs/getTags.md

@@ -0,0 +1,12 @@
+### `docs.getTags` 🔰
+
+**Non-standart method**
+
+Returns tags array from user/club documents.
+
+**Params**:
+
+|Name|Value|Description|
+|--|--|--|
+|`owner_id`|unsigned int|Owner id|
+|`type`|unsigned int|type (0—8)|

docs/openvk_engine/api/methods/docs/getTypes.md

@@ -0,0 +1,13 @@
+### `docs.getTypes` 🔰
+
+Returns types of uploaded documents
+
+**Params**:
+
+|Name|Value|Description|
+|--|--|--|
+|`owner_id`|unsigned int|Owner id|
+
+**Result**
+
+Returns `count` and `items` fields.

docs/openvk_engine/api/methods/docs/search.md

@@ -0,0 +1,16 @@
+### `docs.search` 🔰
+
+Searches public documents
+
+**Params**:
+
+|Name|Value|Description|
+|--|--|--|
+|`q`|string|Query|
+|`search_own`|bool|Search by own documents|
+|`order`|unsigned int|Order (0, 1, 2)|
+|`count`|unsigned int|Count|
+|`offset`|unsigned int|Offset|
+|`return_tags`|bool|Return "tags" fields|
+|`type`|unsigned int|VK API type of document|
+|`tags`|string|Include "tags" to the search|

docs/openvk_engine/api/objects/doc.md

@@ -0,0 +1,18 @@
+# Document object
+
+| Property | Value | Description |
+|---|---|---|
+|`id`|int|Document id|
+|`owner_id`|int|Document owner id|
+|`title`|string|Document title|
+|`size`|int|Document size|
+|`ext`|string|Document extension|
+|`url`|string|Document URL|
+|`date`|timestamp|Document upload time|
+|`type`|range(1-8)|Document VK API type|
+|`is_hidden`|bool|Is owner hidden|
+|`folder_id`|int|0 — private, 3 — public|
+|`access_key`|string|Access key|
+|`can_manage`|bool|Can current user modify this document|
+|`preview`|array|Contains photo object with preview (on images)|
+|`tags`|array|Tags array|

mkdocs.yml

@@ -38,6 +38,7 @@ nav:
       - 'Objects':
         - 'Audio Genres': 'openvk_engine/api/objects/audio_genres.md'
         - 'Audio': 'openvk_engine/api/objects/audio.md'
+        - 'Document': 'openvk_engine/api/objects/doc.md'
         - 'Playlist': 'openvk_engine/api/objects/playlist.md'
         - 'User': 'openvk_engine/api/objects/user.md'
         - 'Group': 'openvk_engine/api/objects/group.md'
@@ -88,6 +89,15 @@ nav:
           - 'board.getTopics': 'openvk_engine/api/methods/board/getTopics.md'
           - 'board.openTopic': 'openvk_engine/api/methods/board/openTopic.md'
           - 'board.unfixTopic': 'openvk_engine/api/methods/board/unfixTopic.md'
+        - 'Docs':
+          - 'docs.add': 'openvk_engine/api/methods/docs/add.md'
+          - 'docs.delete': 'openvk_engine/api/methods/docs/delete.md'
+          - 'docs.edit': 'openvk_engine/api/methods/docs/edit.md'
+          - 'docs.get': 'openvk_engine/api/methods/docs/get.md'
+          - 'docs.getById': 'openvk_engine/api/methods/docs/getById.md'
+          - 'docs.getTypes': 'openvk_engine/api/methods/docs/getTypes.md'
+          - 'docs.getTags': 'openvk_engine/api/methods/docs/getTags.md'
+          - 'docs.search': 'openvk_engine/api/methods/docs/search.md'
         - 'Friends':
           - 'friends.add': 'openvk_engine/api/methods/friends/add.md'
           - 'friends.areFriends': 'openvk_engine/api/methods/friends/areFriends.md'