Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing endpoints, edit responses #11

Merged
merged 17 commits into from
Oct 6, 2024
Merged

Add missing endpoints, edit responses #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
aaddd24
add missing endpoints, edit responses
johanohly Sep 11, 2024
db27cf5
Add submit values docs
johanohly Sep 11, 2024
3b4bdef
Manually merge in #10
johanohly Oct 5, 2024
49efcf1
Fix various bugs in check_outdated script
johanohly Oct 5, 2024
cf07071
Update permissions scopes
johanohly Oct 5, 2024
6e513cc
Document printer AutoPrint endpoints
johanohly Oct 5, 2024
d7d4247
Formatting
johanohly Oct 5, 2024
d745c9a
Document get job details
johanohly Oct 5, 2024
8a12c2d
Document printer groups
johanohly Oct 5, 2024
acc4401
Document queue groups
johanohly Oct 5, 2024
3b6e6be
Document gcode macros
johanohly Oct 5, 2024
4ed0ad9
Document plan requirements of autoprint and print queue groups
johanohly Oct 5, 2024
70301dd
Document missing plan requirements
johanohly Oct 5, 2024
726e096
Document missing plan requirements
johanohly Oct 5, 2024
ad10eec
Document endpoint permission requirements
johanohly Oct 6, 2024
1c69316
1-Click
johanohly Oct 6, 2024
3570dbb
Document courses and partner endpoints
johanohly Oct 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions scripts/check_outdated.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
import os
import re

from settings import ENDPOINTS_DIR

ENDPOINTS_DIR = "<SITE-API/API/Endpoints PATH>"
DOCUMENTATION_DIR = os.path.join(os.path.dirname(__file__), "../source/includes")

def get_all_endpoints():
def get_all_endpoints(with_disabled=False):
endpoints = []
for root, dirs, files in os.walk(ENDPOINTS_DIR):
for file in files:
with open(os.path.join(root, file), 'r') as f:
if re.search(r"public bool \$api_disabled = true;", f.read()):
continue
if not with_disabled:
with open(os.path.join(root, file), 'r') as f:
if re.search(r"public *bool *\$api_disabled *= true;", f.read()):
continue

endpoints.append(root.split(ENDPOINTS_DIR)[1] + "/" + file[:-4])

Expand All @@ -25,12 +25,12 @@ def get_all_documented_endpoints():
file_cat = file[1:-3]
with open(os.path.join(DOCUMENTATION_DIR, file), 'r') as f:
for line in f.readlines():
match = re.match(r"curl https:\/\/api\.simplyprint\.io\/\{id\}(.*?)(\?| \\).*$", line)
match = re.match(r"(?:curl)?.*https:\/\/api\.simplyprint\.io\/\{id\}(.*?)(\?| \\).*$", line)

if not match:
continue

endpoints.append(match.group(1))
endpoints.append(match.group(1).replace("\"", ""))

endpoints.sort()
return endpoints
Expand Down
131 changes: 69 additions & 62 deletions source/includes/_account.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ curl https://api.simplyprint.io/{id}/account/settings/groups/Create \
</aside>

| Required permissions |
| --------------------- |
| `ORG_RANK_MANAGEMENT` |
|-----------------------|
| `org_rank_management` |

This endpoint creates a new group in the company.

Expand All @@ -63,7 +63,7 @@ This endpoint creates a new group in the company.
`POST /{id}/account/settings/groups/Create`

| Parameter | Type | Required | Description |
| --------------------- | ------- | -------- | --------------------------------------------------------------------------------------------------- |
|-----------------------|---------|----------|-----------------------------------------------------------------------------------------------------|
| `ranks` | array | yes | Array of groups to create. |
| `ranks[].title` | string | yes | The name of the group. |
| `ranks[].description` | string | no | The description of the group. |
Expand All @@ -73,7 +73,7 @@ This endpoint creates a new group in the company.
### Response

| Parameter | Type | Description |
| --------- | ------- | ----------------------------------- |
|-----------|---------|-------------------------------------|
| `status` | boolean | True if the request was successful. |
| `message` | string | Error message if `status` is false. |
| `data` | array | Array of the created groups. |
Expand All @@ -97,7 +97,7 @@ curl https://api.simplyprint.io/{id}/account/settings/groups/Update \
"title": "TITLE",
"description": "DESCRIPTION",
"permissions": "{\"view_news\":true,\"org_admin\":true,\"panel_printing\":true,\"printer_restart\":true,\"printer_edit\":true,\"bed_leveling\":true,\"gcode_profiles\":true,\"printer_settings\":true,\"filament_settings\":true,\"change_filament\":true,\"create_filament\":true,\"see_filament_tab\":true,\"view_users\":true,\"change_user_rank\":true,\"manual_user_email_confirm\":true,\"invite_users\":true,\"delete_user\":true,\"org_user_registration_settings\":true,\"org_hub_settings\":true,\"org_rank_management\":true,\"org_view_statistics\":true,\"refill_quota\":true,\"custom_slicer_profiles\":true,\"org_profiles\":true,\"all_slicer_modes\":true,\"queue_remove_all\":true,\"org_api\":true,\"create_org_folder\":true,\"cancel_others\":true,\"see_who_printed\":true,\"max_print_size\":[],\"default_slicer_mode\":2}",
"sort_order": 3,
"sort_order": 3
}
]
}
Expand Down Expand Up @@ -129,8 +129,8 @@ curl https://api.simplyprint.io/{id}/account/settings/groups/Update \
</aside>

| Required permissions |
| --------------------- |
| `ORG_RANK_MANAGEMENT` |
|-----------------------|
| `org_rank_management` |

This endpoint updates the groups in the company.

Expand All @@ -139,7 +139,7 @@ This endpoint updates the groups in the company.
`POST /{id}/account/settings/groups/Update`

| Parameter | Type | Required | Description |
| --------------------- | ------- | -------- | --------------------------------------------------------------------------------------------------- |
|-----------------------|---------|----------|-----------------------------------------------------------------------------------------------------|
| `ranks` | array | yes | Array of groups to update. |
| `ranks[].id` | integer | yes | The id of the group to update. |
| `ranks[].title` | string | no | The name of the group. |
Expand All @@ -150,7 +150,7 @@ This endpoint updates the groups in the company.
### Response

| Parameter | Type | Description |
| --------------------- | ------- | --------------------------------------------------------------------------------------------------- |
|-----------------------|---------|-----------------------------------------------------------------------------------------------------|
| `status` | boolean | True if the request was successful. |
| `message` | string | Error message if `status` is false. |
| `data` | array | Array of the updated groups. |
Expand All @@ -167,7 +167,6 @@ This endpoint updates the groups in the company.

```shell
curl https://api.simplyprint.io/{id}/account/GetGroups \
-X GET \
-H 'accept: application/json' \
-H 'X-API-KEY: {API_KEY}'
```
Expand Down Expand Up @@ -200,8 +199,8 @@ curl https://api.simplyprint.io/{id}/account/GetGroups \
</aside>

| Required permissions |
| --------------------- |
| `ORG_RANK_MANAGEMENT` |
|-----------------------|
| `org_rank_management` |

This endpoint returns a list of groups that exist in the company.

Expand All @@ -212,7 +211,7 @@ This endpoint returns a list of groups that exist in the company.
### Response

| Parameter | Type | Description |
| --------------- | ------- | ----------------------------------- |
|-----------------|---------|-------------------------------------|
| `status` | boolean | True if the request was successful. |
| `message` | string | Error message if `status` is false. |
| `groups` | array | Array of group objects. |
Expand Down Expand Up @@ -242,7 +241,7 @@ curl https://api.simplyprint.io/{id}/account/settings/groups/Delete \
```json
{
"status": true,
"message": null,
"message": null
}
```

Expand All @@ -251,22 +250,22 @@ curl https://api.simplyprint.io/{id}/account/settings/groups/Delete \
</aside>

| Required permissions |
| --------------------- |
| `ORG_RANK_MANAGEMENT` |
|-----------------------|
| `org_rank_management` |

### Request

`POST /{id}/account/settings/groups/Delete`

| Parameter | Type | Required | Description |
| ------------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------- |
|---------------------|---------|----------|---------------------------------------------------------------------------------------------------------|
| `id` | integer | yes | The id of the group to delete. |
| `replacementRankId` | integer | maybe | The id of the group to replace the deleted group with.<br>This is only required if the group has users. |

### Response

| Parameter | Type | Description |
| --------- | ------- | ----------------------------------- |
|-----------|---------|-------------------------------------|
| `status` | boolean | True if the request was successful. |
| `message` | string | Error message if `status` is false. |

Expand All @@ -283,8 +282,16 @@ curl https://api.simplyprint.io/{id}/account/GetStatistics \

```json
{
"users": [1234, 1235, 1945],
"printers": [1234, 1235, 1945],
"users": [
1234,
1235,
1945
],
"printers": [
1234,
1235,
1945
],
"start_date": "1677629786",
"end_date": "1677629786"
}
Expand All @@ -294,46 +301,46 @@ curl https://api.simplyprint.io/{id}/account/GetStatistics \

```json
{
"status": true,
"message": null,
"data": {
"total_print_seconds": 1234,
"total_filament_usage_gram": 1241.1231231,
"print_job_count": 123,
"regretted_print_jobs": 123,
"failed_print_jobs": 123,
"printer_error_print_jobs": 123,
"done_print_jobs": 123,
"date_range": {
"from": "2023-02-22",
"to": "2023-03-02",
"general": false
},
"printers": {
"3104": {
"name": "Printer 1",
"done": 0,
"failed": 0,
"printer_error": 0,
"regretted": 0,
"filament_usage_gram": 0
},
...
},
"print_jobs": [
{
"date": "2023-02-27",
"started": "2023-02-27 11:39:34",
"ended": "2023-02-27 11:56:18",
"cancelled": 1,
"failed": 0,
"cancel_reason_type": 5,
"print_seconds": 1004,
"filament_usage_gram": 0.03758012402132279
},
...
]
}
"status": true,
"message": null,
"data": {
"total_print_seconds": 1234,
"total_filament_usage_gram": 1241.1231231,
"print_job_count": 123,
"regretted_print_jobs": 123,
"failed_print_jobs": 123,
"printer_error_print_jobs": 123,
"done_print_jobs": 123,
"date_range": {
"from": "2023-02-22",
"to": "2023-03-02",
"general": false
},
"printers": {
"3104": {
"name": "Printer 1",
"done": 0,
"failed": 0,
"printer_error": 0,
"regretted": 0,
"filament_usage_gram": 0
},
...
},
"print_jobs": [
{
"date": "2023-02-27",
"started": "2023-02-27 11:39:34",
"ended": "2023-02-27 11:56:18",
"cancelled": 1,
"failed": 0,
"cancel_reason_type": 5,
"print_seconds": 1004,
"filament_usage_gram": 0.03758012402132279
},
...
]
}
}
```

Expand All @@ -348,7 +355,7 @@ This endpoint returns statistics for the user / company.
`POST /{id}/account/GetStatistics`

| Parameter | Type | Required | Description |
| ------------ | ------ | -------- | ------------------------------------------------------------------------------------------------------------ |
|--------------|--------|----------|--------------------------------------------------------------------------------------------------------------|
| `users` | array | no | Array of user ids to get statistics for. Don't include this parameter to get statistics for all users. |
| `printers` | array | no | Array of printer ids to get statistics for. Don't include this parameter to get statistics for all printers. |
| `start_date` | string | no | The start date of the statistics. Provide a unix timestamp in seconds. |
Expand All @@ -357,7 +364,7 @@ This endpoint returns statistics for the user / company.
### Response

| Parameter | Type | Description |
| ---------------------------------------- | ------- | ---------------------------------------- |
|------------------------------------------|---------|------------------------------------------|
| `status` | boolean | True if the request was successful. |
| `message` | string | Error message if `status` is false. |
| `data` | object | Statistics object. |
Expand Down
Loading
Loading