Skip to content

Commit bdbbe19

Browse files
committed
Add account registration API documentation and update login endpoint details
1 parent c1569c5 commit bdbbe19

20 files changed

Lines changed: 189 additions & 11 deletions

File tree

.docusaurus/docusaurus-plugin-content-docs/default/p/docs-175.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

.docusaurus/docusaurus-plugin-content-docs/default/site-docs-api-account-login-md-ee6.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"id": "api/account/login",
33
"title": "/account/login",
4-
"description": "",
4+
"description": "This endpoint authenticates a user and returns an authentication token.",
55
"source": "@site/docs/api/account/login.md",
66
"sourceDirName": "api/account",
77
"slug": "/api/account/login",
@@ -21,5 +21,9 @@
2121
"previous": {
2222
"title": "/account",
2323
"permalink": "/docs/category/account"
24+
},
25+
"next": {
26+
"title": "/account/register",
27+
"permalink": "/docs/api/account/register"
2428
}
2529
}
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"id": "api/account/register",
3+
"title": "/account/register",
4+
"description": "This endpoint registers a new user account in the system.",
5+
"source": "@site/docs/api/account/register.md",
6+
"sourceDirName": "api/account",
7+
"slug": "/api/account/register",
8+
"permalink": "/docs/api/account/register",
9+
"draft": false,
10+
"unlisted": false,
11+
"editUrl": "https://github.com/astrakit/documentation/tree/main/packages/create-docusaurus/templates/shared/docs/api/account/register.md",
12+
"tags": [],
13+
"version": "current",
14+
"lastUpdatedBy": "Author",
15+
"lastUpdatedAt": 1539502055000,
16+
"sidebarPosition": 2,
17+
"frontMatter": {
18+
"sidebar_position": 2
19+
},
20+
"sidebar": "apiDocSidebar",
21+
"previous": {
22+
"title": "/account/login",
23+
"permalink": "/docs/api/account/login"
24+
}
25+
}

.docusaurus/docusaurus-plugin-debug/default/p/docusaurus-debug-content-0d5.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

.docusaurus/globalData.json

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,11 @@
1515
"path": "/docs/api/account/login",
1616
"sidebar": "apiDocSidebar"
1717
},
18+
{
19+
"id": "api/account/register",
20+
"path": "/docs/api/account/register",
21+
"sidebar": "apiDocSidebar"
22+
},
1823
{
1924
"id": "api/introduction",
2025
"path": "/docs/api/introduction",
@@ -190,8 +195,8 @@
190195
"docusaurus-lunr-search": {
191196
"default": {
192197
"fileNames": {
193-
"searchDoc": "search-doc-1742592341486.json",
194-
"lunrIndex": "lunr-index-1742592341486.json"
198+
"searchDoc": "search-doc-1742745571960.json",
199+
"lunrIndex": "lunr-index-1742745571960.json"
195200
}
196201
}
197202
}

.docusaurus/registry.js

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.docusaurus/routes.js

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,22 +54,28 @@ export default [
5454
},
5555
{
5656
path: '/docs',
57-
component: ComponentCreator('/docs', 'a84'),
57+
component: ComponentCreator('/docs', '420'),
5858
routes: [
5959
{
6060
path: '/docs',
61-
component: ComponentCreator('/docs', 'bf3'),
61+
component: ComponentCreator('/docs', '07e'),
6262
routes: [
6363
{
6464
path: '/docs',
65-
component: ComponentCreator('/docs', '903'),
65+
component: ComponentCreator('/docs', '7c2'),
6666
routes: [
6767
{
6868
path: '/docs/api/account/login',
6969
component: ComponentCreator('/docs/api/account/login', 'ba6'),
7070
exact: true,
7171
sidebar: "apiDocSidebar"
7272
},
73+
{
74+
path: '/docs/api/account/register',
75+
component: ComponentCreator('/docs/api/account/register', '03b'),
76+
exact: true,
77+
sidebar: "apiDocSidebar"
78+
},
7379
{
7480
path: '/docs/api/introduction',
7581
component: ComponentCreator('/docs/api/introduction', '6c8'),

.docusaurus/routesChunkNames.json

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,23 +72,27 @@
7272
},
7373
"content": "content---markdown-page-393-028"
7474
},
75-
"/docs-a84": {
75+
"/docs-420": {
7676
"__comp": "__comp---theme-docs-root-5-e-9-0b6",
7777
"__context": {
7878
"plugin": "plugin---docsaba-d7c"
7979
}
8080
},
81-
"/docs-bf3": {
81+
"/docs-07e": {
8282
"__comp": "__comp---theme-doc-version-roota-7-b-5de",
8383
"__props": "__props---docs-005-788"
8484
},
85-
"/docs-903": {
85+
"/docs-7c2": {
8686
"__comp": "__comp---theme-doc-roota-94-67a"
8787
},
8888
"/docs/api/account/login-ba6": {
8989
"__comp": "__comp---theme-doc-item-178-a40",
9090
"content": "content---docs-api-account-loginee-6-513"
9191
},
92+
"/docs/api/account/register-03b": {
93+
"__comp": "__comp---theme-doc-item-178-a40",
94+
"content": "content---docs-api-account-registercdf-ce5"
95+
},
9296
"/docs/api/introduction-6c8": {
9397
"__comp": "__comp---theme-doc-item-178-a40",
9498
"content": "content---docs-api-introductiona-98-3d9"

docs/api/account/login.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,64 @@
11
---
22
sidebar_position: 1
33
---
4+
45
# /account/login
6+
7+
This endpoint authenticates a user and returns an authentication token.
8+
9+
## Request
10+
11+
```
12+
GET https://api.astrakit.cc/api/account/login
13+
```
14+
15+
## Parameters
16+
17+
| Parameter | Type | Required | Description |
18+
|-----------|------|----------|-------------|
19+
| email | string | Yes | User's email address |
20+
| password | string | Yes | User's account password |
21+
22+
## Example Request
23+
24+
```
25+
GET https://api.astrakit.cc/api/account/login?email=user@example.com&password=yourpassword
26+
```
27+
28+
## Example Response
29+
30+
```json
31+
{
32+
"success": true,
33+
"message": "Login successful",
34+
"data": {
35+
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
36+
"user": {
37+
"id": "123456",
38+
"email": "user@example.com"
39+
}
40+
}
41+
}
42+
```
43+
44+
## Error Responses
45+
46+
### Invalid Credentials
47+
48+
```json
49+
{
50+
"success": false,
51+
"message": "Invalid email or password",
52+
"error": "AUTH_FAILED"
53+
}
54+
```
55+
56+
### Missing Parameters
57+
58+
```json
59+
{
60+
"success": false,
61+
"message": "Missing required parameters",
62+
"error": "INVALID_REQUEST"
63+
}
64+
```

docs/api/account/register.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# /account/register
6+
7+
This endpoint registers a new user account in the system.
8+
9+
## Request
10+
11+
```
12+
GET https://api.astrakit.cc/api/account/register
13+
```
14+
15+
## Parameters
16+
17+
| Parameter | Type | Required | Description |
18+
|-----------|------|----------|-------------|
19+
| email | string | Yes | User's email address |
20+
| password | string | Yes | Desired account password |
21+
| code | string | Yes | Registration invitation code |
22+
23+
## Example Request
24+
25+
```
26+
GET https://api.astrakit.cc/api/account/register?email=user@example.com&password=yourpassword&code=invitationcode
27+
```
28+
29+
## Example Response
30+
31+
```json
32+
{
33+
"success": true,
34+
"message": "Account created successfully",
35+
"data": {
36+
"userId": "123456",
37+
"email": "user@example.com"
38+
}
39+
}
40+
```
41+
42+
## Error Responses
43+
44+
### Invalid Registration Code
45+
46+
```json
47+
{
48+
"success": false,
49+
"message": "Invalid registration code",
50+
"error": "INVALID_CODE"
51+
}
52+
```
53+
54+
### Email Already Registered
55+
56+
```json
57+
{
58+
"success": false,
59+
"message": "Email already registered",
60+
"error": "EMAIL_EXISTS"
61+
}
62+
```
63+
64+
### Missing Parameters
65+
66+
```json
67+
{
68+
"success": false,
69+
"message": "Missing required parameters",
70+
"error": "INVALID_REQUEST"
71+
}
72+
```

0 commit comments

Comments
 (0)