Skip to content

Commit 2bab739

Browse files
kastovkastov
committed
docs: update TypeScript SDK documentation
1 parent 0d8edf6 commit 2bab739

2 files changed

Lines changed: 48 additions & 50 deletions

File tree

‎docs/sdk/python-sdk.md‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,21 @@
11
---
2-
sidebar_position: 2
2+
sidebar_position: 99
33
title: Python SDK [community]
44
---
55

66
import Admonition from '@theme/Admonition';
77
import { FaPeopleGroup } from "react-icons/fa6";
8+
import { MdArchive } from "react-icons/md";
89

910
<Admonition type="note" icon={<FaPeopleGroup />} title="Community SDK">
1011
This SDK is fully community-maintained.
1112
</Admonition>
1213

14+
<Admonition type="warning" icon={<MdArchive style={{ color: '#b87a00' }}/>} title="Archived">
15+
<b>This SDK is no longer maintained.</b>
16+
If you need stable and up-to-date functionality, please consider using alternative community SDKs or refer directly to the <a href="https://docs.rw/api" target="_blank" rel="noopener noreferrer">Remnawave API documentation</a>.
17+
</Admonition>
18+
1319
Remnawave Python SDK is a library for convenient interaction with the RestAPI types.
1420

1521
✨ Key Features
@@ -38,7 +44,7 @@ import asyncio
3844

3945
from remnawave import RemnawaveSDK # Updated import for new package
4046
from remnawave.models import ( # Updated import path
41-
UsersResponseDto,
47+
UsersResponseDto,
4248
UserResponseDto,
4349
GetAllConfigProfilesResponseDto,
4450
CreateInternalSquadRequestDto
@@ -47,7 +53,7 @@ from remnawave.models import ( # Updated import path
4753
async def main():
4854
# URL to your panel (ex. https://vpn.com or http://127.0.0.1:3000)
4955
base_url: str = os.getenv("REMNAWAVE_BASE_URL")
50-
# Bearer Token from panel (section: API Tokens)
56+
# Bearer Token from panel (section: API Tokens)
5157
token: str = os.getenv("REMNAWAVE_TOKEN")
5258

5359
# Initialize the SDK
@@ -75,7 +81,7 @@ import asyncio
7581

7682
from remnawave import RemnawaveSDK # Updated import for new package
7783
from remnawave.models import ( # Updated import path
78-
UsersResponseDto,
84+
UsersResponseDto,
7985
UserResponseDto,
8086
GetAllConfigProfilesResponseDto,
8187
CreateInternalSquadRequestDto
@@ -84,7 +90,7 @@ from remnawave.models import ( # Updated import path
8490
async def main():
8591
# URL to your panel (ex. https://vpn.com or http://127.0.0.1:3000)
8692
base_url: str = os.getenv("REMNAWAVE_BASE_URL")
87-
# Bearer Token from panel (section: API Tokens)
93+
# Bearer Token from panel (section: API Tokens)
8894
token: str = os.getenv("REMNAWAVE_TOKEN")
8995
# Bearer Token for Caddy Auth
9096
caddy_token = os.getenv("CADDY_TOKEN_AUTH")

‎docs/sdk/typescript-sdk.md‎

Lines changed: 37 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -26,51 +26,43 @@ npm install @remnawave/backend-contract
2626
Always pick and pin the correct version of the SDK to match the version of the Remnawave backend.
2727
:::
2828

29-
| Contract Version | Remnawave Panel Version |
30-
| ---------------- | ------------------------------------------ |
31-
| 3.0.0 | 3.0.0 |
32-
| 2.8.35 | 2.8.0 – 2.8.1 |
33-
| 2.7.2 | 2.7.3 – 2.7.4 |
34-
| 2.7.0 | 2.7.0 – 2.7.2 |
35-
| 2.6.20 | 2.6.4 |
36-
| 2.6.19 | 2.6.3 |
37-
| 2.6.16 | 2.6.2 |
38-
| 2.6.1 | 2.6.1 |
39-
| 2.6.0 | 2.6.0 |
40-
| 2.5.20 | 2.5.7 |
41-
| 2.5.13 | 2.5.4 - 2.5.6 |
42-
| 2.5.9 | 2.5.0 - 2.5.3 |
43-
| 2.4.1 | 2.4.3 - 2.4.4 |
44-
| 2.4.0 | 2.4.0 - 2.4.2 |
45-
| 2.3.38 | 2.3.2 |
46-
| 2.3.35 | 2.3.0,2.3.1 |
47-
| 2.2.34 | 2.2.6 |
48-
| 2.2.32 | 2.2.4,2.2.5 |
49-
| 2.2.26 | 2.2.1,2.2.2,2.2.3 |
50-
| 2.2.24 | 2.2.0 |
51-
| 2.1.70 | 2.1.19 |
52-
| 2.1.68 | 2.1.18 |
53-
| 2.1.64 | 2.1.16 |
54-
| 2.1.62 | 2.1.15 |
55-
| 2.1.57 | 2.1.14 |
56-
| 2.1.41 | 2.1.13 |
57-
| 2.1.39 | 2.1.12 |
58-
| 2.1.33 | 2.1.8, 2.1.9, 2.1.10, 2.1.11 |
59-
| 2.1.26 | 2.1.7 |
60-
| 2.1.25 | 2.1.4, 2.1.5, 2.1.6 |
61-
| 2.1.14 | 2.1.1, 2.1.2, 2.1.3 |
62-
| 2.1.12 | 2.1.0 |
63-
| 2.0.2 | 2.0.6, 2.0.7, 2.0.8 |
64-
| 2.0.0 | 2.0.0, 2.0.1, 2.0.2, 2.0.3, 2.0.4, 2.0.5 |
65-
| 0.7.26 | 1.6.14, 1.6.15, 1.6.16 |
66-
| 0.7.21 | 1.6.13 |
67-
| 0.7.19 | 1.6.12 |
68-
| 0.7.16 | 1.6.6, 1.6.7, 1.6.8, 1.6.9, 1.6.10, 1.6.11 |
69-
| 0.7.13 | 1.6.3, 1.6.4, 1.6.5 |
70-
| 0.7.1 | 1.6.1, 1.6.2 |
71-
| 0.7.0 | 1.6.0 |
72-
| 0.4.5 | 1.5.7 |
73-
| 0.3.71 | 1.5.0 |
29+
| Contract Version | Remnawave Panel Version |
30+
| ---------------- | ----------------------- |
31+
| 3.1.1 | 3.1.0 |
32+
| 3.0.0 | 3.0.0 |
33+
| 2.8.35 | 2.8.0 – 2.8.1 |
34+
| 2.7.2 | 2.7.3 – 2.7.4 |
35+
| 2.7.0 | 2.7.0 – 2.7.2 |
36+
| 2.6.20 | 2.6.4 |
37+
| 2.6.19 | 2.6.3 |
38+
| 2.6.16 | 2.6.2 |
39+
| 2.6.1 | 2.6.1 |
40+
| 2.6.0 | 2.6.0 |
41+
| 2.5.20 | 2.5.7 |
42+
| 2.5.13 | 2.5.4 - 2.5.6 |
43+
| 2.5.9 | 2.5.0 - 2.5.3 |
44+
| 2.4.1 | 2.4.3 - 2.4.4 |
45+
| 2.4.0 | 2.4.0 - 2.4.2 |
46+
| 2.3.38 | 2.3.2 |
47+
| 2.3.35 | 2.3.0 – 2.3.1 |
48+
| 2.2.34 | 2.2.6 |
49+
| 2.2.32 | 2.2.4 – 2.2.5 |
50+
| 2.2.26 | 2.2.1 – 2.2.3 |
51+
| 2.2.24 | 2.2.0 |
52+
| 2.1.70 | 2.1.19 |
53+
| 2.1.68 | 2.1.18 |
54+
| 2.1.64 | 2.1.16 |
55+
| 2.1.62 | 2.1.15 |
56+
| 2.1.57 | 2.1.14 |
57+
| 2.1.41 | 2.1.13 |
58+
| 2.1.39 | 2.1.12 |
59+
| 2.1.33 | 2.1.8 – 2.1.11 |
60+
| 2.1.26 | 2.1.7 |
61+
| 2.1.25 | 2.1.4 – 2.1.6 |
62+
| 2.1.14 | 2.1.1 – 2.1.3 |
63+
| 2.1.12 | 2.1.0 |
64+
| 2.0.2 | 2.0.6 – 2.0.8 |
65+
| 2.0.0 | 2.0.0 – 2.0.5 |
7466

7567
## Usage
7668

0 commit comments

Comments
 (0)