Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
20 changes: 20 additions & 0 deletions guides/APIVersions.md
Original file line number Diff line number Diff line change
@@ -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:

<div style="background-color: #DDEAFF; padding: 18px 24px; border-radius: 6px; border: 1px solid #ABCAFE; box-sizing: border-box; display: inline-block">
<b>Deprecation Notice</b>
<br/>
<span>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.</span>
</div>

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).
38 changes: 38 additions & 0 deletions guides/DeveloperPreview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# 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:

<div style="background-color: #FEF1D1; padding: 18px 24px; border-radius: 6px; border: 1px solid #FDB10C; box-sizing: border-box; display: inline-block">
<b>Developer Preview</b>
<br/>
<span> This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.</span>
</div>


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, 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.

### 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.