Merge pull request #5 from DHTMLX/next

[update] Migration doc from v2.3.1 to v3.1.0

.github/workflows/main.yml

@@ -18,13 +18,13 @@ jobs:
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - id: vars
         run: echo ::set-output name=short_ref::${GITHUB_REF#refs/*/}
 
-      - uses: actions/setup-node@v2
+      - uses: actions/setup-node@v4
         with:
-          node-version: '16.15.0'
+          node-version: '18.19.0'
 
       - run: yarn install
       - run: yarn build

docs/api/provider/rest_routes/delete_routes/js_eventcalendar_deletecalendar_route.md

@@ -4,13 +4,13 @@ title: DELETE /calendars
 description: You can learn about the DELETE /calendars route in the documentation of the DHTMLX JavaScript Event Calendar library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Event Calendar.
 ---
 
-# Delete /calendars
+# Delete `/calendars`
 
 ### Description
 
 @short: Deletes data on a calendar (event type)
 
-The route handles the DELETE request made to the **'/calendars/{id}'** path. 
+The route handles the DELETE request made to the `/calendars/{id}` path.
 
 <table style="border: 1px solid white; border-collapse: collapse; width:50%">
 <thead style="border: 1px solid white; border-collapse: collapse;">
@@ -32,8 +32,8 @@ The route handles the DELETE request made to the **'/calendars/{id}'** path.
 The next parameter is sent in the request line:
 
 | Name       | Type        | Description |
-| ----------- | ----------- | ----------- |
-| `id`       |  number   | *Required*. The ID of the calendar to be deleted.|
+| ---------- | ----------- | ----------- |
+| `id`       |  number     | *Required*. The ID of the calendar to be deleted.|
 
 ### Payload
 

docs/api/provider/rest_routes/delete_routes/js_eventcalendar_deleteevent_route.md

@@ -4,14 +4,13 @@ title: DELETE /events
 description: You can learn about the DELETE /events route in the documentation of the DHTMLX JavaScript Event Calendar library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Event Calendar.
 ---
 
-# DELETE /events
+# DELETE `/events`
 
 ### Description
 
 @short: Deletes data on an event
 
-The route handles the DELETE request made to the **'/events/{id}'** path. 
-
+The route handles the DELETE request made to the `/events/{id}` path.
 
 <table style="border: 1px solid white; border-collapse: collapse; width:50%">
 <thead style="border: 1px solid white; border-collapse: collapse;">
@@ -33,18 +32,17 @@ The route handles the DELETE request made to the **'/events/{id}'** path.
 The next parameter is sent in the request line:
 
 | Name       | Type        | Description |
-| ----------- | ----------- | ----------- |
-| `id`       |  number   | *Required*. The ID of the event to be deleted.|
+| ---------- | ----------- | ----------- |
+| `id`       |  number     | *Required*. The ID of the event to be deleted.|
 
 ### Payload
 
-No payload is required. 
+No payload is required.
 
 ### Response
 
 No data is returned back. The HTTP status code shows whether the request succeeds (response.status == 200) or fails (response.status == 500).
 
-
 ---
 
 **Related articles**: [Working with server](guides/working_with_server.md)

docs/api/provider/rest_routes/get_routes/js_eventcalendar_getcalendars_route.md

@@ -4,13 +4,13 @@ title: GET /calendars
 description: You can learn about the GET /calendars route in the documentation of the DHTMLX JavaScript Event Calendar library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Event Calendar.
 ---
 
-# GET /calendars
+# GET `/calendars`
 
 ### Description
 
 @short: Gets data on all calendars and returns a json object with an array of calendars objects
 
-The route handles the GET request made to the **'/calendars'** path.
+The route handles the GET request made to the `/calendars` path.
 
 <table style="border: 1px solid white; border-collapse: collapse; width:50%">
 <thead style="border: 1px solid white; border-collapse: collapse;">
@@ -31,7 +31,7 @@ No payload is required.
 
 ### Response
 
-The route returns a json object with an array of all calendars objects. 
+The route returns a json object with an array of all calendars objects.
 
 Example:
 
@@ -57,7 +57,7 @@ Example:
         },
         "description": ""
     },
- ...
+    // ...
 ]
 ~~~
 
@@ -70,4 +70,4 @@ The HTTP status code shows whether the request succeeds (response.status == 200)
 **Related articles**:
 - [Working with server](guides/working_with_server.md)
 - [getCalendars()](api/provider/rest_methods/js_eventcalendar_getcalendars_method.md)
-- [send()](api/provider/rest_methods/js_eventcalendar_send_method.md)
+- [send()](api/provider/rest_methods/js_eventcalendar_send_method.md)

docs/api/provider/rest_routes/get_routes/js_eventcalendar_getevents_route.md

@@ -4,13 +4,13 @@ title: GET /events
 description: You can learn about the GET /events route in the documentation of the DHTMLX JavaScript Event Calendar library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Event Calendar.
 ---
 
-# GET /events
+# GET `/events`
 
 ### Description
 
 @short: Gets data on all events and returns a json object with an array of events objects
 
-The route handles the GET request made to the **'/events'** path.
+The route handles the GET request made to the `/events` path.
 
 <table style="border: 1px solid white; border-collapse: collapse; width:50%">
 <thead style="border: 1px solid white; border-collapse: collapse;">
@@ -31,7 +31,7 @@ No payload is required.
 
 ### Response
 
-The route returns a json object with an array of all events objects. 
+The route returns a json object with an array of all events objects.
 
 Example:
 
@@ -61,7 +61,7 @@ Example:
             "url": "https://server.com/uploads/5/document.html"
         }
     },
-    ...
+    // ...
 ]
 ~~~
 
@@ -78,4 +78,4 @@ The HTTP status code shows whether the request succeeds (response.status == 200)
 **Related articles**:
 - [Working with server](guides/working_with_server.md)
 - [getEvents()](api/provider/rest_methods/js_eventcalendar_getevents_method.md)
-- [send()](api/provider/rest_methods/js_eventcalendar_send_method.md)
+- [send()](api/provider/rest_methods/js_eventcalendar_send_method.md)

docs/api/provider/rest_routes/get_routes/js_eventcalendar_getuploads_route.md

@@ -4,13 +4,13 @@ title: GET /uploads
 description: You can learn about the GET /uploads route in the documentation of the DHTMLX JavaScript Event Calendar library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Event Calendar.
 ---
 
-# GET /uploads
+# GET `/uploads`
 
 ### Description
 
 @short: Gets the requested binary file from the server
 
-The route handles the GET request made to the **'/uploads/{id}/{name}'** path.
+The route handles the GET request made to the `/uploads/{id}/{name}` path.
 
 <table style="border: 1px solid white; border-collapse: collapse; width:50%">
 <thead style="border: 1px solid white; border-collapse: collapse;">
@@ -32,9 +32,9 @@ The route handles the GET request made to the **'/uploads/{id}/{name}'** path.
 The following parameters are sent in the request line:
 
 | Name       | Type        | Description |
-| ----------- | ----------- | ----------- |
-| `id`       |  number   | *Required*. The ID of the required file.|
-| `name`       |  string  | *Required*. The name of the requested file.|
+| ---------- | ----------- | ----------- |
+| `id`       |  number     | *Required*. The ID of the required file.|
+| `name`     |  string     | *Required*. The name of the requested file.|
 
 ### Payload
 

docs/api/provider/rest_routes/post_routes/js_eventcalendar_postcalendar_route.md

@@ -4,13 +4,13 @@ title: POST /calendars
 description: You can learn about the POST /calendars route in the documentation of the DHTMLX JavaScript Event Calendar library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Event Calendar.
 ---
 
-# POST /calendars
+# POST `/calendars`
 
 ### Description
 
 @short: Creates a new calendar (event type) and returns a json object with the calendar ID in it
 
-The route handles the POST request made to the **'/calendars'** path.
+The route handles the POST request made to the `/calendars` path.
 
 <table style="border: 1px solid white; border-collapse: collapse; width:50%">
 <thead style="border: 1px solid white; border-collapse: collapse;">
@@ -29,11 +29,11 @@ The route handles the POST request made to the **'/calendars'** path.
 
 The server needs to receive a json object with the next properties:
 
-| Name       | Type        | Description |
-| ----------- | ----------- | ----------- |
-| `label`       |  string  | *Required*. The name of a new calendar to be added.|
-| `description`       |  string  | *Optional*. Calendar description.|
-| `color`       | object | *Required*. An object with the style parameters applied to the events of the calendar: `background` - (optional) a HEX code of the event background color related to the calendar, `border` - (optional) a HEX code of the event border color related to the calendar, `textColor` - (optional) a HEX code of the event text color related to the calendar.|
+| Name          | Type        | Description |
+| ------------- | ----------- | ----------- |
+| `label`       | string      | *Required*. The name of a new calendar to be added.|
+| `description` | string      | *Optional*. Calendar description.|
+| `color`       | object      | *Required*. An object with the style parameters applied to the events of the calendar: `background` - (optional) a HEX code of the event background color related to the calendar, `border` - (optional) a HEX code of the event border color related to the calendar, `textColor` - (optional) a HEX code of the event text color related to the calendar.|
 
 Example:
 

docs/api/provider/rest_routes/post_routes/js_eventcalendar_postevent_route.md

@@ -4,13 +4,13 @@ title: POST /events
 description: You can learn about the POST /events route in the documentation of the DHTMLX JavaScript Event Calendar library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Event Calendar.
 ---
 
-# POST /events
+# POST `/events`
 
 ### Description
 
 @short: Creates a new event and returns a json object with the event ID in it
 
-The route handles the POST request made to the **'/events'** path. 
+The route handles the POST request made to the `/events` path.
 
 <table style="border: 1px solid white; border-collapse: collapse; width:50%">
 <thead style="border: 1px solid white; border-collapse: collapse;">
@@ -29,15 +29,15 @@ The route handles the POST request made to the **'/events'** path.
 
 The server needs to receive a json object with the next properties:
 
-| Name       | Type        | Description |
-| ----------- | ----------- | ----------- |
-| `text`       |  string  | *Required*. The name of a new event to be added.|
-| `start_date`       |  string  | *Required*. The event start date in the ISO format yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
-| `end_date`       |  string  | *Required*. The event end date in the ISO format yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
-| `allDay`       |  boolean  | *Optional*. Enables/disables the event duration throughout the day.|
-| `type`       |  number  | *Required*. The calendar ID which is the event type.|
-| `details`       |  string  | *Optional*. Details about a new event.|
-| `files`       |  object | *Optional*. An array of the files to be attached to a new event. You can attach files that are already [uploaded](api/provider/rest_routes/post_routes/js_eventcalendar_postupload_route.md) to the server. The file object should contain the file id, name, and url.|
+| Name         | Type        | Description |
+| ------------ | ----------- | ----------- |
+| `text`       |  string     | *Required*. The name of a new event to be added.|
+| `start_date` |  string     | *Required*. The event start date in the ISO format yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
+| `end_date`   |  string     | *Required*. The event end date in the ISO format yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
+| `allDay`     |  boolean    | *Optional*. Enables/disables the event duration throughout the day.|
+| `type`       |  number     | *Required*. The calendar ID which is the event type.|
+| `details`    |  string     | *Optional*. Details about a new event.|
+| `files`      |  object     | *Optional*. An array of the files to be attached to a new event. You can attach files that are already [uploaded](api/provider/rest_routes/post_routes/js_eventcalendar_postupload_route.md) to the server. The file object should contain the file id, name, and url.|
 
 Example:
 
@@ -61,7 +61,7 @@ Example:
 
 ### Response
 
-The route returns a json object with the ID of a new event. 
+The route returns a json object with the ID of a new event.
 
 Example:
 
@@ -71,7 +71,6 @@ Example:
 
  The HTTP status code shows whether the request succeeds (response.status == 200) or fails (response.status == 500).
 
-
 ---
 
 **Related articles**: [Working with server](guides/working_with_server.md)

docs/api/provider/rest_routes/post_routes/js_eventcalendar_postupload_route.md

@@ -4,13 +4,13 @@ title: POST /uploads
 description: You can learn about the POST /uploads route in the documentation of the DHTMLX JavaScript Event Calendar library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Event Calendar.
 ---
 
-# POST /uploads
+# POST `/uploads`
 
 ### Description
 
 @short: Uploads a binary file to the server and returns a json object with the file id, name, and url
 
-The route handles the POST multipart request made to the **'/uploads'** path.
+The route handles the POST multipart request made to the `/uploads` path.
 
 <table style="border: 1px solid white; border-collapse: collapse; width:50%">
 <thead style="border: 1px solid white; border-collapse: collapse;">

docs/api/provider/rest_routes/put_routes/js_eventcalendar_putcalendar_route.md

@@ -4,13 +4,13 @@ title: PUT /calendars
 description: You can learn about the PUT /calendars route in the documentation of the DHTMLX JavaScript Event Calendar library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Event Calendar.
 ---
 
-# PUT /calendars
+# PUT `/calendars`
 
 ### Description
 
 @short: Updates data on a calendar (event type)
 
-The route handles the PUT request made to the **'/calendars/{id}'** path.
+The route handles the PUT request made to the `/calendars/{id}` path.
 
 <table style="border: 1px solid white; border-collapse: collapse; width:50%">
 <thead style="border: 1px solid white; border-collapse: collapse;">
@@ -32,18 +32,18 @@ The route handles the PUT request made to the **'/calendars/{id}'** path.
 The next parameter is sent in the request line:
 
 | Name       | Type        | Description |
-| ----------- | ----------- | ----------- |
-| `id`       |  number   | *Required*. The ID of the calendar to be updated.|
+| ---------- | ----------- | ----------- |
+| `id`       |  number     | *Required*. The ID of the calendar to be updated.|
 
 ### Payload
 
 The server needs to receive a json object with the next properties (both unchanged and modified properties are expected):
 
-| Name       | Type        | Description |
-| ----------- | ----------- | ----------- |
-| `label`       |  string  | *Required*. The name of the calendar to be updated.|
-| `description` |  string  | *Optional*. Calendar description.|
-| `color`       | object | *Required*. An object with the style parameters applied to the events of the calendar: `background` - (optional) a HEX code of the event background color related to the current calendar, `border` - (optional) a HEX code of the event border color related to the current calendar, `textColor` - (optional) a HEX code of the event text color related to the current calendar.|
+| Name          | Type        | Description |
+| ------------- | ----------- | ----------- |
+| `label`       |  string     | *Required*. The name of the calendar to be updated.|
+| `description` |  string     | *Optional*. Calendar description.|
+| `color`       |  object     | *Required*. An object with the style parameters applied to the events of the calendar: `background` - (optional) a HEX code of the event background color related to the current calendar, `border` - (optional) a HEX code of the event border color related to the current calendar, `textColor` - (optional) a HEX code of the event text color related to the current calendar.|
 
 Example:
 

docs/api/provider/rest_routes/put_routes/js_eventcalendar_putevent_route.md

@@ -4,13 +4,13 @@ title: PUT /events
 description: You can learn about the PUT /events route in the documentation of the DHTMLX JavaScript Event Calendar library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Event Calendar.
 ---
 
-# PUT /events
+# PUT `/events`
 
 ### Description
 
 @short: Updates data on an event
 
-The route handles the PUT request made to the **'/events/{id}'** path.
+The route handles the PUT request made to the `/events/{id}` path.
 
 <table style="border: 1px solid white; border-collapse: collapse; width:50%">
 <thead style="border: 1px solid white; border-collapse: collapse;">
@@ -32,22 +32,22 @@ The route handles the PUT request made to the **'/events/{id}'** path.
 The next parameter is sent in the request line:
 
 | Name       | Type        | Description |
-| ----------- | ----------- | ----------- |
-| `id`       |  number   | *Required*. The ID of the event to be updated.|
+| ---------- | ----------- | ----------- |
+| `id`       |  number     | *Required*. The ID of the event to be updated.|
 
 ### Payload
 
 The server expects to receive a json object with the next properties (both unchanged and modified properties are needed):
 
-| Name       | Type        | Description |
-| ----------- | ----------- | ----------- |
-| `text`       |  string  | *Required*. The name of the event to be updated.|
-| `start_date` |  string  | *Required*. The event start date in the ISO format yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
-| `end_date`   |  string  | *Required*. The event end date in the ISO format yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
-| `allDay`       |  boolean  | *Optional*. Enables/disables the event duration throughout the day.|
-| `type`       |  number  | *Required*. The calendar ID which is the event type.|
-| `details`       |  string  | *Optional*. Details about the event.|
-| `files`       |  object | *Optional*. An array of the files to be attached to the event. You can attach files that are already [uploaded](api/provider/rest_routes/post_routes/js_eventcalendar_postupload_route.md) to the server. The file object should contain the file id, name, and url.|
+| Name         | Type        | Description |
+| ------------ | ----------- | ----------- |
+| `text`       |  string     | *Required*. The name of the event to be updated.|
+| `start_date` |  string     | *Required*. The event start date in the ISO format yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
+| `end_date`   |  string     | *Required*. The event end date in the ISO format yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
+| `allDay`     |  boolean    | *Optional*. Enables/disables the event duration throughout the day.|
+| `type`       |  number     | *Required*. The calendar ID which is the event type.|
+| `details`    |  string     | *Optional*. Details about the event.|
+| `files`      |  object     | *Optional*. An array of the files to be attached to the event. You can attach files that are already [uploaded](api/provider/rest_routes/post_routes/js_eventcalendar_postupload_route.md) to the server. The file object should contain the file id, name, and url.|
 
 Example:
 
@@ -77,4 +77,4 @@ No data is returned back. The HTTP status code shows whether the request succeed
 
 **Related articles**:
 - [Working with server](guides/working_with_server.md)
-- [Post /uploads](api/provider/rest_routes/post_routes/js_eventcalendar_postupload_route.md)
+- [Post /uploads](api/provider/rest_routes/post_routes/js_eventcalendar_postupload_route.md)