Skip to content

Commit ac7c450

Browse files
dnorhojdnorhoj
committed
Progresss
1 parent 36454a3 commit ac7c450

File tree

9 files changed

+239
-81
lines changed

9 files changed

+239
-81
lines changed

‎scripts/generate_markdown.py

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,10 @@
1313
## {endpoint}
1414
1515
```shell
16-
curl -X ? https://api.simplyprint.io/{{id}}{full_endpoint} -H "accept: application/json"
16+
curl https://api.simplyprint.io/{{id}}{full_endpoint} \\
17+
-X ? \\
18+
-H 'accept: application/json' \\
19+
-H 'X-API-KEY: {{API_KEY}}'
1720
```
1821
1922
> Success response
@@ -59,8 +62,9 @@
5962
if endpoint_dir != folder:
6063
endpoint = endpoint_dir + "/" + file[:-4]
6164

62-
out += TEMPLATE.format(endpoint=endpoint, full_endpoint=endpoint_path + "/" + file[:-4])
63-
65+
out += TEMPLATE.format(endpoint=endpoint,
66+
full_endpoint=endpoint_path + "/" + file[:-4])
67+
6468
if len(out.splitlines()) == 1:
6569
print("Skipping empty folder: " + folder)
6670
continue

‎source/includes/_account.md

Lines changed: 32 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,12 @@
11
# Account
22

3-
## Test
4-
5-
```shell
6-
curl -X ? https://api.simplyprint.io/{id}/account/Test -H "accept: application/json"
7-
```
8-
9-
> Success response
10-
11-
```json
12-
{
13-
"TODO": "TODO"
14-
}
15-
```
16-
17-
### Request
18-
19-
`? /{id}/account/Test`
20-
21-
TODO
22-
233
## GetGroups
244

255
```shell
26-
curl -X ? https://api.simplyprint.io/{id}/account/GetGroups -H "accept: application/json"
6+
curl https://api.simplyprint.io/{id}/account/GetGroups \
7+
-X GET \
8+
-H 'accept: application/json' \
9+
-H 'X-API-KEY: {API_KEY}'
2710
```
2811

2912
> Success response
@@ -43,7 +26,10 @@ TODO
4326
## SetLocalPCCookie
4427

4528
```shell
46-
curl -X ? https://api.simplyprint.io/{id}/account/SetLocalPCCookie -H "accept: application/json"
29+
curl https://api.simplyprint.io/{id}/account/SetLocalPCCookie \
30+
-X ? \
31+
-H 'accept: application/json' \
32+
-H 'X-API-KEY: {API_KEY}'
4733
```
4834

4935
> Success response
@@ -63,7 +49,10 @@ TODO
6349
## GetStatistics
6450

6551
```shell
66-
curl -X ? https://api.simplyprint.io/{id}/account/GetStatistics -H "accept: application/json"
52+
curl https://api.simplyprint.io/{id}/account/GetStatistics \
53+
-X ? \
54+
-H 'accept: application/json' \
55+
-H 'X-API-KEY: {API_KEY}'
6756
```
6857

6958
> Success response
@@ -83,7 +72,10 @@ TODO
8372
## SaveAutoQueueDefaults
8473

8574
```shell
86-
curl -X ? https://api.simplyprint.io/{id}/account/SaveAutoQueueDefaults -H "accept: application/json"
75+
curl https://api.simplyprint.io/{id}/account/SaveAutoQueueDefaults \
76+
-X ? \
77+
-H 'accept: application/json' \
78+
-H 'X-API-KEY: {API_KEY}'
8779
```
8880

8981
> Success response
@@ -103,7 +95,10 @@ TODO
10395
## rank/Delete
10496

10597
```shell
106-
curl -X ? https://api.simplyprint.io/{id}/account/settings/rank/Delete -H "accept: application/json"
98+
curl https://api.simplyprint.io/{id}/account/settings/rank/Delete \
99+
-X ? \
100+
-H 'accept: application/json' \
101+
-H 'X-API-KEY: {API_KEY}'
107102
```
108103

109104
> Success response
@@ -123,7 +118,10 @@ TODO
123118
## rank/Create
124119

125120
```shell
126-
curl -X ? https://api.simplyprint.io/{id}/account/settings/rank/Create -H "accept: application/json"
121+
curl https://api.simplyprint.io/{id}/account/settings/rank/Create \
122+
-X ? \
123+
-H 'accept: application/json' \
124+
-H 'X-API-KEY: {API_KEY}'
127125
```
128126

129127
> Success response
@@ -143,7 +141,10 @@ TODO
143141
## rank/Update
144142

145143
```shell
146-
curl -X ? https://api.simplyprint.io/{id}/account/settings/rank/Update -H "accept: application/json"
144+
curl https://api.simplyprint.io/{id}/account/settings/rank/Update \
145+
-X ? \
146+
-H 'accept: application/json' \
147+
-H 'X-API-KEY: {API_KEY}'
147148
```
148149

149150
> Success response
@@ -163,7 +164,10 @@ TODO
163164
## billing/Test
164165

165166
```shell
166-
curl -X ? https://api.simplyprint.io/{id}/account/billing/Test -H "accept: application/json"
167+
curl https://api.simplyprint.io/{id}/account/billing/Test \
168+
-X ? \
169+
-H 'accept: application/json' \
170+
-H 'X-API-KEY: {API_KEY}'
167171
```
168172

169173
> Success response

‎source/includes/_filament.md

Lines changed: 32 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@
33
## Delete
44

55
```shell
6-
curl -X ? https://api.simplyprint.io/{id}/filament/Delete -H "accept: application/json"
6+
curl https://api.simplyprint.io/{id}/filament/Delete \
7+
-X ? \
8+
-H 'accept: application/json' \
9+
-H 'X-API-KEY: {API_KEY}'
710
```
811

912
> Success response
@@ -23,7 +26,10 @@ TODO
2326
## Create
2427

2528
```shell
26-
curl -X ? https://api.simplyprint.io/{id}/filament/Create -H "accept: application/json"
29+
curl https://api.simplyprint.io/{id}/filament/Create \
30+
-X ? \
31+
-H 'accept: application/json' \
32+
-H 'X-API-KEY: {API_KEY}'
2733
```
2834

2935
> Success response
@@ -43,7 +49,10 @@ TODO
4349
## Unassign
4450

4551
```shell
46-
curl -X ? https://api.simplyprint.io/{id}/filament/Unassign -H "accept: application/json"
52+
curl https://api.simplyprint.io/{id}/filament/Unassign \
53+
-X ? \
54+
-H 'accept: application/json' \
55+
-H 'X-API-KEY: {API_KEY}'
4756
```
4857

4958
> Success response
@@ -63,7 +72,10 @@ TODO
6372
## Assign
6473

6574
```shell
66-
curl -X ? https://api.simplyprint.io/{id}/filament/Assign -H "accept: application/json"
75+
curl https://api.simplyprint.io/{id}/filament/Assign \
76+
-X ? \
77+
-H 'accept: application/json' \
78+
-H 'X-API-KEY: {API_KEY}'
6779
```
6880

6981
> Success response
@@ -83,7 +95,10 @@ TODO
8395
## GetFilament
8496

8597
```shell
86-
curl -X ? https://api.simplyprint.io/{id}/filament/GetFilament -H "accept: application/json"
98+
curl https://api.simplyprint.io/{id}/filament/GetFilament \
99+
-X ? \
100+
-H 'accept: application/json' \
101+
-H 'X-API-KEY: {API_KEY}'
87102
```
88103

89104
> Success response
@@ -103,7 +118,10 @@ TODO
103118
## type/Delete
104119

105120
```shell
106-
curl -X ? https://api.simplyprint.io/{id}/filament/type/Delete -H "accept: application/json"
121+
curl https://api.simplyprint.io/{id}/filament/type/Delete \
122+
-X ? \
123+
-H 'accept: application/json' \
124+
-H 'X-API-KEY: {API_KEY}'
107125
```
108126

109127
> Success response
@@ -123,7 +141,10 @@ TODO
123141
## type/Create
124142

125143
```shell
126-
curl -X ? https://api.simplyprint.io/{id}/filament/type/Create -H "accept: application/json"
144+
curl https://api.simplyprint.io/{id}/filament/type/Create \
145+
-X ? \
146+
-H 'accept: application/json' \
147+
-H 'X-API-KEY: {API_KEY}'
127148
```
128149

129150
> Success response
@@ -143,7 +164,10 @@ TODO
143164
## type/Update
144165

145166
```shell
146-
curl -X ? https://api.simplyprint.io/{id}/filament/type/Update -H "accept: application/json"
167+
curl https://api.simplyprint.io/{id}/filament/type/Update \
168+
-X ? \
169+
-H 'accept: application/json' \
170+
-H 'X-API-KEY: {API_KEY}'
147171
```
148172

149173
> Success response

‎source/includes/_files.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@
33
## GetFiles
44

55
```shell
6-
curl -X ? https://api.simplyprint.io/{id}/files/GetFiles -H "accept: application/json"
6+
curl https://api.simplyprint.io/{id}/files/GetFiles \
7+
-X ? \
8+
-H 'accept: application/json' \
9+
-H 'X-API-KEY: {API_KEY}'
710
```
811

912
> Success response
@@ -23,7 +26,10 @@ TODO
2326
## SavePrefs
2427

2528
```shell
26-
curl -X ? https://api.simplyprint.io/{id}/files/SavePrefs -H "accept: application/json"
29+
curl https://api.simplyprint.io/{id}/files/SavePrefs \
30+
-X ? \
31+
-H 'accept: application/json' \
32+
-H 'X-API-KEY: {API_KEY}'
2733
```
2834

2935
> Success response
@@ -43,7 +49,10 @@ TODO
4349
## MoveFiles
4450

4551
```shell
46-
curl -X ? https://api.simplyprint.io/{id}/files/MoveFiles -H "accept: application/json"
52+
curl https://api.simplyprint.io/{id}/files/MoveFiles \
53+
-X ? \
54+
-H 'accept: application/json' \
55+
-H 'X-API-KEY: {API_KEY}'
4756
```
4857

4958
> Success response
@@ -63,7 +72,10 @@ TODO
6372
## GetFolder
6473

6574
```shell
66-
curl -X ? https://api.simplyprint.io/{id}/files/GetFolder -H "accept: application/json"
75+
curl https://api.simplyprint.io/{id}/files/GetFolder \
76+
-X ? \
77+
-H 'accept: application/json' \
78+
-H 'X-API-KEY: {API_KEY}'
6779
```
6880

6981
> Success response
@@ -83,7 +95,10 @@ TODO
8395
## UpdateFile
8496

8597
```shell
86-
curl -X ? https://api.simplyprint.io/{id}/files/UpdateFile -H "accept: application/json"
98+
curl https://api.simplyprint.io/{id}/files/UpdateFile \
99+
-X ? \
100+
-H 'accept: application/json' \
101+
-H 'X-API-KEY: {API_KEY}'
87102
```
88103

89104
> Success response
@@ -103,7 +118,10 @@ TODO
103118
## MoveFolder
104119

105120
```shell
106-
curl -X ? https://api.simplyprint.io/{id}/files/MoveFolder -H "accept: application/json"
121+
curl https://api.simplyprint.io/{id}/files/MoveFolder \
122+
-X ? \
123+
-H 'accept: application/json' \
124+
-H 'X-API-KEY: {API_KEY}'
107125
```
108126

109127
> Success response

‎source/includes/_oauth.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@
33
## Token
44

55
```shell
6-
curl -X ? https://api.simplyprint.io/{id}/oauth/Token -H "accept: application/json"
6+
curl https://api.simplyprint.io/{id}/oauth/Token \
7+
-X ? \
8+
-H 'accept: application/json' \
9+
-H 'X-API-KEY: {API_KEY}'
710
```
811

912
> Success response
@@ -23,7 +26,10 @@ TODO
2326
## Authorize
2427

2528
```shell
26-
curl -X ? https://api.simplyprint.io/{id}/oauth/Authorize -H "accept: application/json"
29+
curl https://api.simplyprint.io/{id}/oauth/Authorize \
30+
-X ? \
31+
-H 'accept: application/json' \
32+
-H 'X-API-KEY: {API_KEY}'
2733
```
2834

2935
> Success response

0 commit comments

Comments
 (0)