From 6b74181b45b301a77fee7d177e2c6ad6bfa32226 Mon Sep 17 00:00:00 2001 From: alizas1 <44541615+alizas1@users.noreply.github.com> Date: Thu, 20 Jun 2024 13:55:04 +0300 Subject: [PATCH 1/4] Create DeveloperPreview.md --- guides/DeveloperPreview.md | 40 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 guides/DeveloperPreview.md diff --git a/guides/DeveloperPreview.md b/guides/DeveloperPreview.md new file mode 100644 index 0000000000..a0516c57e6 --- /dev/null +++ b/guides/DeveloperPreview.md @@ -0,0 +1,40 @@ +# Developer Preview + +Wix is always in active development, and we're constantly adding new APIs. We want to make sure that we're on the right track and building the functionality that you need. +For this reason, we release all of our APIs in Developer Preview mode for user testing. This is a way for us to get feedback from you and improve our APIs before full release. + +APIs in Developer Preview mode include the following warning in their introductions: + +
+ Developer Preview +
+ This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period. +
+ + +They also include this tag in the reference for each endpoint: +![developer preview tag](https://user-images.githubusercontent.com/89579857/213133550-2b4fa3e8-e8fc-4513-a733-00abcc70925c.png) +Once these tags are removed, the API is fully released. + +Here is some important information to know about Developer Preview: + +### Breaking changes + +APIs in Developer Preview are still in development. This means that we **may change them at any time**. +Notifications about breaking changes appear in the [release notes](/release-notes) and in the API reference for the affected functions and properties. +We will not contact you directly about breaking changes. + +### Timeframe +APIs are expected to stay in Developer Preview mode for approximately 6 months. After that they are fully released, and any breaking changes require a 6 month deprecation notice. + +### Feedback +We would appreciate your feedback on the APIs in Developer Preview. Let us know about: + +* What you're using the API for. +* Anything blocking you from using the API. +* Additions and features you would find useful. + +Please [contact us](https://www.wix.com/support-chatbot?nodeId=25a57397-ccf7-4376-8b74-48d51edf7159&referral=devRels) with your feedback. + +### Bugs +If you discover a bug in a Developer Preview API, please [contact us](https://www.wix.com/support-chatbot?nodeId=25a57397-ccf7-4376-8b74-48d51edf7159&referral=devRels) and let us know. We'll fix the bug as soon as possible. From 304fd68e880a5e11fa9ea427683f74eebbe4873a Mon Sep 17 00:00:00 2001 From: alizas1 <44541615+alizas1@users.noreply.github.com> Date: Thu, 20 Jun 2024 14:07:45 +0300 Subject: [PATCH 2/4] Create APIVersions.md --- guides/APIVersions.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 guides/APIVersions.md diff --git a/guides/APIVersions.md b/guides/APIVersions.md new file mode 100644 index 0000000000..e518219193 --- /dev/null +++ b/guides/APIVersions.md @@ -0,0 +1,20 @@ +# API Versions + +As we update and expand our APIs, new versions are released. Here's what you need to know about versions: + +## Versioning by API + +New versions are released at the service level. +For example, while the latest version of Wix Bookings' Bookings API might be v2, the latest version of Wix Bookings' Attendance API might be v1. + +## Continuing usability +When a new version of an API is released, the earlier version is deprecated. It will remain available for approximately 6 months to give you time to move to the new version. +Deprecated endpoints will include the following note in the docuementation: + +
+ Deprecation Notice +
+ This endpoint has been replaced with New Endpoint and will be removed on December 31, 2023. If your app uses this endpoint, we recommend updating your code as soon as possible. +
+ +They will also be added to the [End-of-life notices](https://dev.wix.com/docs/rest/articles/what-s-new/end-of-life-notices). From 4c599c5870613e21209281c0cd2e7238f1d307f8 Mon Sep 17 00:00:00 2001 From: alizas1 <44541615+alizas1@users.noreply.github.com> Date: Thu, 20 Jun 2024 14:46:35 +0300 Subject: [PATCH 3/4] Update APIVersions.md --- guides/APIVersions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guides/APIVersions.md b/guides/APIVersions.md index e518219193..60a72c46e5 100644 --- a/guides/APIVersions.md +++ b/guides/APIVersions.md @@ -11,7 +11,7 @@ For example, while the latest version of Wix Bookings' Bookings API might be v2, When a new version of an API is released, the earlier version is deprecated. It will remain available for approximately 6 months to give you time to move to the new version. Deprecated endpoints will include the following note in the docuementation: -
+
Deprecation Notice
This endpoint has been replaced with New Endpoint and will be removed on December 31, 2023. If your app uses this endpoint, we recommend updating your code as soon as possible. From 475e19611b82010298562864c1244ab10a8848ba Mon Sep 17 00:00:00 2001 From: alizas1 <44541615+alizas1@users.noreply.github.com> Date: Mon, 24 Jun 2024 11:17:23 +0300 Subject: [PATCH 4/4] Update DeveloperPreview.md --- guides/DeveloperPreview.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/guides/DeveloperPreview.md b/guides/DeveloperPreview.md index a0516c57e6..4e90ef1ceb 100644 --- a/guides/DeveloperPreview.md +++ b/guides/DeveloperPreview.md @@ -20,9 +20,7 @@ Here is some important information to know about Developer Preview: ### Breaking changes -APIs in Developer Preview are still in development. This means that we **may change them at any time**. -Notifications about breaking changes appear in the [release notes](/release-notes) and in the API reference for the affected functions and properties. -We will not contact you directly about breaking changes. +APIs in Developer Preview are still in development. This means that we may change them at any time, without notice. ### Timeframe APIs are expected to stay in Developer Preview mode for approximately 6 months. After that they are fully released, and any breaking changes require a 6 month deprecation notice.