Skip to content
This repository has been archived by the owner on Nov 13, 2024. It is now read-only.

Commit

Permalink
Update documentation and update links
Browse files Browse the repository at this point in the history
  • Loading branch information
@showierdata9978
showierdata9978 committed Aug 16, 2024
1 parent cb5876d commit bf92ab6
Show file tree
Hide file tree
Showing 7 changed files with 155 additions and 79 deletions.
4 changes: 2 additions & 2 deletions .vitepress/config.mts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export default defineConfig({
themeConfig: {
editLink: {
pattern:
'https://github.com/meower-media-co/api-client/edit/main/docs/:path',
'https://github.com/meower-media/docs/edit/main/docs/:path',
},
nav: [
{ text: 'Home', link: '/' },
Expand All @@ -39,7 +39,7 @@ export default defineConfig({
socialLinks: [
{
icon: 'github',
link: 'https://github.com/meower-media-co',
link: 'https://github.com/meower-media',
},
],
},
Expand Down
30 changes: 30 additions & 0 deletions docs/api/features.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# All Known features

This includes every feature that is explicitly added by the current API.

- Sending, editing, and deleting:
- posts
- chats

- User accounts
- Logging in
- Signing up
- Post/user reporting
- [Chats](./objects/chat.md):
- Chat creation
- Chat member management
- Chat message pinning
- Multifactor Authentication.
- Home page
- Quotes (used a bio typically)
- Post reactions
- Post replies
- Profile pictures
- Searching users
- Searching posts
- Blocking users
- Direct Messaging Users
- Typing indicators
- Inbox messages
- Searching Posts and Users
- Uploading (images, videos, etc)
25 changes: 25 additions & 0 deletions docs/api/objects/emoji.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Emoji

### Structure

<!-- deno-fmt-ignore-start -->

| Field | Type | Description |
| - | - | - |
| _id | string | The emoji's UUID4. |
| animated | boolean | Whether the emoji is animated. |
| chat_id | UUID4 | The chat's UUID4. |
| name | string | The emoji's name. |

<!-- deno-fmt-ignore-end -->

### Examples

```json
{
"_id": "CNqjEMFlMYlS66VjDQ3u8z07",
"animated": false,
"chat_id": "ee754b92-da8a-483a-9601-bf44b9bff531",
"name": "ban"
}
```
44 changes: 0 additions & 44 deletions docs/api/objects/extended-timestamp.md
View file

This file was deleted.

116 changes: 84 additions & 32 deletions docs/api/objects/post.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,25 @@

### Structure

<!-- deno-fmt-ignore-start -->
| Field | Type | Description | Optional |
| - | - | - | - |
| _id | UUID4 | The post's UUID4. | |
| post_id | UUID4 | The post's UUID4. | |
| post_origin | string/UUID4 | Where the post was created. Can be `"home"`, `"inbox"`, `"livechat"`, or a chat's UUID4. | |
| type | integer | The post's type. | |
| t | [Extended Timestamp](./extended-timestamp) object | The post's creation timestamp. | |
| u | string | The username of the post author. | |
| p | string | The content of the post. | |
| unfiltered_p | string | The non-filtered content of the post. | ✓ |
| pinned | boolean | Whether the post is pinned. | |
| isDeleted | boolean | Whether the post is deleted. | |
| mod_deleted | boolean | Whether the post was deleted by a moderator. | ✓ |
| deleted_at | integer | The post's deletion timestamp in Unix seconds. | ✓ |
<!-- deno-fmt-ignore-start --> <!-- Uploads was down -->
| Field | Type | Description | Optional |
| ------------ | ------------------------------------------------- | ---------------------------------------------------------------------------------------- | -------- |
| _id | UUID4 | The post's UUID4. | |
| attachments | Unknown[] | The uploaded attachments attached to the post. | |
| author | [Post Users](./user.md#post-users) | A peek at the authors info. | |
| emojis | [emoji](./emoji.md)[] | The custom emojies used within the post. | |
| isDeleted | boolean | Whether the post is deleted. | |
| p | string | The content of the post. | |
| pinned | boolean | Whether the post is pinned. | |
| post_id | UUID4 | The post's UUID4. | |
| post_origin | string/UUID4 | Where the post was created. Can be `"home"`, `"inbox"`, `"livechat"`, or a chat's UUID4. | |
| reply_to | [post](./post.md)[] | The replied to posts. Sub posts cannot have replies. | |
| stickers | Unknown[] | The custom stickers in the post. | |
| type | integer | The post's type. | |
| t.e | number | The post's creation timestamp. (unix) | |
| u | string | The username of the post author. | |
| mod_deleted | boolean | Whether the post was deleted by a moderator. | ✓ |
| deleted_at | integer | The post's deletion timestamp in Unix seconds. | ✓ |
<!-- deno-fmt-ignore-end -->

### Examples
Expand All @@ -25,26 +29,74 @@

```json
{
"_id": "5c93e560-fddd-4146-98bc-edeb263d648f",
"post_id": "5c93e560-fddd-4146-98bc-edeb263d648f",
"_id": "8cacf340-182c-4cbe-98e4-807781ca5e22",
"attachments": [],
"author": {
"_id": "ShowierData9978",
"avatar": "gl4zm8aGO2U3MOUANDNMpnSA",
"avatar_color": "007ffd",
"flags": 0,
"pfp_data": 21,
"uuid": "4f4d986b-63ef-4f7d-9b8b-87368c6e0280"
},
"emojis": [
{
"_id": "CNqjEMFlMYlS66VjDQ3u8z07",
"animated": false,
"chat_id": "ee754b92-da8a-483a-9601-bf44b9bff531",
"name": "ban"
}
],
"isDeleted": false,
"p": "Documentation Post <:CNqjEMFlMYlS66VjDQ3u8z07>",
"pinned": false,
"post_id": "8cacf340-182c-4cbe-98e4-807781ca5e22",
"post_origin": "home",
"type": 1,
"reactions": [
{
"count": 1,
"emoji": "😃",
"user_reacted": false
}
],
"reply_to": [
{
"_id": "d9c07f76-ca61-424c-ae7a-43f1a5f23ade",
"attachments": [],
"author": {
"_id": "Eris",
"avatar": "Gi1WvwNobL0X6RpZB7pnAMNw",
"avatar_color": "8f75cc",
"flags": 4,
"pfp_data": 23,
"uuid": "d4006f3b-d054-4fd3-a4b1-82b29257cd91"
},
"emojis": [],
"isDeleted": false,
"p": "https://tenor.com/view/boom-roasted-the-office-michael-scott-gif-9210948",
"pinned": false,
"post_id": "d9c07f76-ca61-424c-ae7a-43f1a5f23ade",
"post_origin": "home",
"reactions": [],
"reply_to": [],
"stickers": [],
"t": {
"e": 1723786557
},
"type": 1,
"u": "Eris"
}
],
"stickers": [],
"t": {
"d": "30",
"mo": "01",
"y": "2024",
"h": "06",
"mi": "44",
"s": "53",
"e": 1706597093
"e": 1723786594
},
"u": "eri",
"p": "It’s gonna be great:tm:",
"isDeleted": false
"type": 1,
"u": "ShowierData9978"
}
```

#### Livechat
#### Livechat (outdated)

```json
{
Expand All @@ -67,7 +119,7 @@
}
```

#### DM / Group Chat
#### DM / Group Chat (outdated)

```json
{
Expand All @@ -90,7 +142,7 @@
}
```

#### Inbox (Notification to @zed)
#### Inbox (Notification to @zed) (outdated)

```json
{
Expand All @@ -113,7 +165,7 @@
}
```

#### Inbox (Announcement)
#### Inbox (Announcement) (outdated)

```json
{
Expand Down
13 changes: 13 additions & 0 deletions docs/api/objects/user.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,3 +101,16 @@ this can be consisely written as `(permissions & (1 << permission)) != 0`.
"last_seen": 1706574821
}
```

#### Post Users

```json
{
"_id": "ShowierData9978",
"avatar": "gl4zm8aGO2U3MOUANDNMpnSA",
"avatar_color": "007ffd",
"flags": 0,
"pfp_data": 21,
"uuid": "4f4d986b-63ef-4f7d-9b8b-87368c6e0280"
}
```
2 changes: 1 addition & 1 deletion docs/api/rest-api/rest-api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This section describes the Rest API found at <https://api.meower.org> based on
its behavior and source code found at
<https://github.com/meower-media-co/Meower-Server>.
<https://github.com/meower-media/server>.

The Meower API uses JSON both for recieving and responding to requests.

Expand Down

0 comments on commit bf92ab6

Please sign in to comment.