Skip to content

Commit bf1aedd

Browse files
ToshYToshY
committed
[docs] prepare 8.x release
1 parent 9a039b5 commit bf1aedd

File tree

4 files changed

+65
-3
lines changed

4 files changed

+65
-3
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ edge storage, video streaming, image optimizers and much more!
2626
## 🧰 Install
2727

2828
```bash
29-
composer require toshy/bunnynet-php:^7.0
29+
composer require toshy/bunnynet-php:^8.0
3030
```
3131

3232
## 📜 Documentation

‎UPGRADE.md‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,65 @@
1+
## 8.x
2+
3+
This release comes with minor breaking changes due to changing namespaces for 5 Shield API models.
4+
5+
### ‼️ Breaking changes
6+
7+
| **7.x** | **8.x** |
8+
|------------------------------------------------------------------|------------------------------------------------------------------------|
9+
| `ToshY\BunnyNet\Model\Api\Shield\Zone\CreateShieldZone` | `ToshY\BunnyNet\Model\Api\Shield\ShieldZone\CreateShieldZone` |
10+
| `ToshY\BunnyNet\Model\Api\Shield\Zone\GetShieldZone` | `ToshY\BunnyNet\Model\Api\Shield\ShieldZone\GetShieldZone` |
11+
| `ToshY\BunnyNet\Model\Api\Shield\Zone\GetShieldZoneByPullZoneId` | `ToshY\BunnyNet\Model\Api\Shield\ShieldZone\GetShieldZoneByPullZoneId` |
12+
| `ToshY\BunnyNet\Model\Api\Shield\Zone\ListShieldZones` | `ToshY\BunnyNet\Model\Api\Shield\ShieldZone\ListShieldZones` |
13+
| `ToshY\BunnyNet\Model\Api\Shield\Zone\UpdateShieldZone` | `ToshY\BunnyNet\Model\Api\Shield\ShieldZone\UpdateShieldZone` |
14+
15+
### 🐛 Bug fixes
16+
17+
#### Generator
18+
19+
- Fixed generated classnames when missing the `operationId` property in the OpenAPI specs.
20+
- Fixed path parameter ordering when the `parameters` property in the OpenAPI specs is unordered.
21+
22+
### 🚀 Enhancements
23+
24+
| **API** | **Action** | **Class** | **Notes** |
25+
|---------------|------------|-------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|
26+
| Origin Errors | ADD | [`GetOriginErrorLogs`](https://toshy.github.io/BunnyNet-PHP/origin-errors-api/#get-origin-errors-for-pullzone-id-and-date) | [OpenAPI] Updated API models |
27+
| Base | UPDATE | [`AddOrUpdateEdgeRule`](https://toshy.github.io/BunnyNet-PHP/base-api/#addupdate-edge-rule) | [OpenAPI] Updated API models |
28+
| Base | UPDATE | [`AddStorageZone`](https://toshy.github.io/BunnyNet-PHP/base-api/#add-storage-zone) | [OpenAPI] Updated API models |
29+
| Base | UPDATE | [`AddVideoLibrary`](https://toshy.github.io/BunnyNet-PHP/base-api/#add-video-library) | [OpenAPI] Updated API models |
30+
| Base | UPDATE | [`UpdateVideoLibrary`](https://toshy.github.io/BunnyNet-PHP/base-api/#update-video-library) | [OpenAPI] Updated API models |
31+
| Base | ADD | [`GetUserAuditLog`](https://toshy.github.io/BunnyNet-PHP/base-api/#get-user-audit-log) | [OpenAPI] Updated API models |
32+
| Shield | ADD | [`ListShieldZoneAccessLists`](https://toshy.github.io/BunnyNet-PHP/shield-api/#list-shield-zone-access-lists) | [OpenAPI] Updated API models |
33+
| Shield | ADD | [`GetShieldZoneAccessList`](https://toshy.github.io/BunnyNet-PHP/shield-api/#get-shield-zone-access-list) | [OpenAPI] Updated API models |
34+
| Shield | ADD | [`GetShieldZoneAccessListEnums`](https://toshy.github.io/BunnyNet-PHP/shield-api/#get-shield-zone-access-list-enums) | [OpenAPI] Updated API models |
35+
| Shield | ADD | [`CreateShieldZoneAccessList`](https://toshy.github.io/BunnyNet-PHP/shield-api/#create-shield-zone-access-list) | [OpenAPI] Updated API models |
36+
| Shield | ADD | [`UpdateShieldZoneAccessList`](https://toshy.github.io/BunnyNet-PHP/shield-api/#update-shield-zone-access-list) | [OpenAPI] Updated API models |
37+
| Shield | ADD | [`UpdateShieldZoneCuratedThreatList`](https://toshy.github.io/BunnyNet-PHP/shield-api/#update-shield-zone-curated-threat-list) | [OpenAPI] Updated API models |
38+
| Shield | ADD | [`DeleteShieldZoneAccessList`](https://toshy.github.io/BunnyNet-PHP/shield-api/#delete-shield-zone-access-list) | [OpenAPI] Updated API models |
39+
| Shield | ADD | [`GetShieldZoneBotDetection`](https://toshy.github.io/BunnyNet-PHP/shield-api/#get-shield-zone-bot-detection) | [OpenAPI] Updated API models |
40+
| Shield | ADD | [`CreateOrUpdateShieldZoneBotDetection`](https://toshy.github.io/BunnyNet-PHP/shield-api/#create-or-update-shield-zone-bot-detection) | [OpenAPI] Updated API models |
41+
| Shield | ADD | [`GetBotDetectionMetrics`](https://toshy.github.io/BunnyNet-PHP/shield-api/#get-bot-detection-metrics) | [OpenAPI] Updated API models |
42+
| Shield | ADD | [`GetUploadScanningMetrics`](https://toshy.github.io/BunnyNet-PHP/shield-api/#get-upload-scanning-metrics) | [OpenAPI] Updated API models |
43+
| Shield | ADD | [`GetCurrentPromotions`](https://toshy.github.io/BunnyNet-PHP/shield-api/#get-shield-zone-current-promotions) | [OpenAPI] Updated API models |
44+
| Shield | UPDATE | [`CreateRateLimit`](https://toshy.github.io/BunnyNet-PHP/shield-api/#create-rate-limit) | [OpenAPI] Updated API models |
45+
| Shield | UPDATE | [`UpdateRateLimit`](https://toshy.github.io/BunnyNet-PHP/shield-api/#update-rate-limit) | [OpenAPI] Updated API models |
46+
| Shield | UPDATE | [`CreateShieldZone`](https://toshy.github.io/BunnyNet-PHP/shield-api/#create-shield-zone) | [OpenAPI] Updated API models |
47+
| Shield | UPDATE | [`GetShieldZone`](https://toshy.github.io/BunnyNet-PHP/shield-api/#get-shield-zone) | [OpenAPI] Updated API models |
48+
| Shield | UPDATE | [`GetShieldZoneByPullZoneId`](https://toshy.github.io/BunnyNet-PHP/shield-api/#get-shield-zone-by-pullzoneid) | [OpenAPI] Updated API models |
49+
| Shield | UPDATE | [`ListShieldZones`](https://toshy.github.io/BunnyNet-PHP/shield-api/#list-shield-zones) | [OpenAPI] Updated API models |
50+
| Shield | ADD | [`ListShieldZonesPullzoneMapping`](https://toshy.github.io/BunnyNet-PHP/shield-api/#list-shield-zones-pull-zone-mapping) | [OpenAPI] Updated API models |
51+
| Shield | UPDATE | [`UpdateShieldZone`](https://toshy.github.io/BunnyNet-PHP/shield-api/#update-shield-zone) | [OpenAPI] Updated API models |
52+
| Shield | ADD | [`GetShieldZoneUploadScanning`](https://toshy.github.io/BunnyNet-PHP/shield-api/#get-shield-zone-upload-scanning) | [OpenAPI] Updated API models |
53+
| Shield | ADD | [`CreateOrUpdateShieldZoneUploadScanning`](https://toshy.github.io/BunnyNet-PHP/shield-api/#create-or-update-shield-zone-upload-scanning) | [OpenAPI] Updated API models |
54+
| Shield | UPDATE | [`CreateCustomWafRule`](https://toshy.github.io/BunnyNet-PHP/shield-api/#create-custom-waf-rule) | [OpenAPI] Updated API models |
55+
| Shield | ADD | [`GetWafRules`](https://toshy.github.io/BunnyNet-PHP/shield-api/#get-waf-rules) | [OpenAPI] Updated API models |
56+
| Shield | ADD | [`GetWafRulesPlanSegmentation`](https://toshy.github.io/BunnyNet-PHP/shield-api/#get-waf-rules-plan-segmentation) | [OpenAPI] Updated API models |
57+
| Shield | UPDATE | [`UpdateCustomWafRule`](https://toshy.github.io/BunnyNet-PHP/shield-api/#update-custom-waf-rule) | [OpenAPI] Updated API models |
58+
| Shield | UPDATE | [`UpdateCustomWafRuleByPatch`](https://toshy.github.io/BunnyNet-PHP/shield-api/#update-custom-waf-rule-patch) | [OpenAPI] Updated API models |
59+
| Stream | UPDATE | [`TranscribeVideo`](https://toshy.github.io/BunnyNet-PHP/stream-api/#transcribe-video) | [OpenAPI] Updated API models |
60+
| Stream | ADD | [`TriggerSmartActions`](https://toshy.github.io/BunnyNet-PHP/stream-api/#trigger-smart-actions) | [OpenAPI] Updated API models |
61+
| Stream | UPDATE | [`UploadVideo`](https://toshy.github.io/BunnyNet-PHP/stream-api/#upload-video) | [OpenAPI] Updated API models |
62+
163
## 7.x
264

365
This release comes with breaking changes for the usability of the library.

‎docs/getting-started.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Using [composer](https://getcomposer.org/doc/00-intro.md), run:
44

55
```shell
6-
composer require toshy/bunnynet-php:^7.0
6+
composer require toshy/bunnynet-php:^8.0
77
```
88

99
### Upgrading

‎docs/shield-api.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1025,7 +1025,7 @@ $bunnyHttpClient->request(
10251025
);
10261026
```
10271027

1028-
#### [Create Or Update Shield Zone Bot Detection](https://docs.bunny.net/reference/patch_shield-shield-zone-shieldzoneid-bot-detection)
1028+
#### [Create Or Update Shield Zone Upload Scanning](https://docs.bunny.net/reference/patch_shield-shield-zone-shieldzoneid-upload-scanning)
10291029

10301030
```php
10311031
$bunnyHttpClient->request(

0 commit comments

Comments
 (0)