https://github.com/codex-team/codex.notes.server
Cloud for the CodeX Notes
https://github.com/codex-team/codex.notes.server
Last synced: 4 months ago
JSON representation
Cloud for the CodeX Notes
- Host: GitHub
- URL: https://github.com/codex-team/codex.notes.server
- Owner: codex-team
- Created: 2017-10-12T16:35:32.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-23T20:58:59.000Z (almost 3 years ago)
- Last Synced: 2025-08-22T07:49:06.045Z (4 months ago)
- Language: PHP
- Homepage:
- Size: 945 KB
- Stars: 5
- Watchers: 19
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# API
## Create new user
```graphql
mutation CreateUser {
user(
id:"5a70ac62e1d8ff5cda8322a0",
name:"Svyatoslav Fedorovich",
email:"slavakpss@yandex.ru"
){
name,
folders {
title
}
}
}
```
### Parameters description
| Parameter | Type | Description |
| -- | -- | -- |
| ID | String | User's unique identifier. 24-character hexadecimal string |
| name | String | User's nickname |
| email | String | User's email address |
## Create new folder
```graphql
mutation CreateFolder{
folder(
id: "5a70ac62e1d8ff5cda8322a8",
title: "Noo",
ownerId: "5a70ac62e1d8ff5cda8322a0",
){
title,
id,
owner{
id,
name
}
}
}
```
### Parameters description
| Parameter | Type | Description |
| -- | -- | -- |
| ID | String | Folder's unique identifier. 24-character hexadecimal string |
| title | String | Folder's name |
| ownerId | String | User's id |
## Create new note
```graphql
mutation CreateNote {
note(
id: "5a70ac62e1d8ff5cda8322a2",
authorId: "5a70ac62e1d8ff5cda8322a0",
folderId: "5a70ac62e1d8ff5cda8322a4", //Folder must exist in the DB
title: "How to work with API",
content: "{}"
) {
id,
title,
content,
dtCreate,
dtModify,
author {
id,
name,
email,
dtReg
}
}
}
```
### Parameters description
| Parameter | Type | Description |
| -- | -- | -- |
| ID | String | Note's unique identifier |
| authorId | String | Note's author |
| folderId | String | Note's folder |
| title | String | Note's public title |
| content | String | Note's content in the JSON-format |
## Get user info
```graphql
query Sync {
user(
id: "5a70ac62e1d8ff5cda8322a0"
){
name,
folders {
id,
title,
owner {
name,
id
},
notes {
id,
title,
content,
dtCreate,
dtModify,
author {
id,
name,
email
},
isRemoved
}
}
}
}
```
### Parameters description
| Parameter | Type | Description |
| -- | -- | -- |
| ID | String | Users's unique identifier |
| foldersLimit | Int | Folder limit in response (optional) |
| foldersSkip | Int | Count of folders to skip(optional) |