Skip to content

Commit

Permalink
[update] Migration doc from v2.3.1 to v3.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
serhiipylypchuk1991 committed Jan 22, 2024
1 parent ca46ede commit 94cb165
Show file tree
Hide file tree
Showing 28 changed files with 4,376 additions and 3,364 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/api/events/selecttask_event.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,6 @@ list.api.on("select-task", ({id, join}) => {

**Change log:** The `join` parameter was added in v1.1

**Related articles:**
- [Operations with tasks](guides/task_operations.md#selectingunselecting-a-task)
- [Multiple select and bulk operations](guides/multiselection.md)
**Related articles:**
- [Operations with tasks](guides/task_operations.md)
- [Multiple select and bulk operations](guides/multiselection.md)
2 changes: 1 addition & 1 deletion docs/api/events/unselecttask_event.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,5 +50,5 @@ list.api.on("unselect-task", ({id}) => {
~~~

**Related articles:**
- [Operations with tasks](guides/task_operations.md#selectingunselecting-a-task)
- [Operations with tasks](guides/task_operations.md)
- [Multiple select and bulk operations](guides/multiselection.md)
2 changes: 1 addition & 1 deletion docs/api/methods/checktask_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,5 +71,5 @@ list.eachSelected(id => {
~~~

**Related articles:**
- [Operations with tasks](guides/task_operations.md#selectingunselecting-a-task)
- [Operations with tasks](guides/task_operations.md)
- [Multiple select and bulk operations](guides/multiselection.md)
2 changes: 1 addition & 1 deletion docs/api/methods/deletetask_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,5 +72,5 @@ list.eachSelected(id => {
~~~

**Related articles:**
- [Operations with tasks](guides/task_operations.md#selectingunselecting-a-task)
- [Operations with tasks](guides/task_operations.md)
- [Multiple select and bulk operations](guides/multiselection.md)
2 changes: 1 addition & 1 deletion docs/api/methods/indenttask_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,5 +70,5 @@ list.eachSelected(id => {
~~~

**Related articles:**
- [Operations with tasks](guides/task_operations.md#selectingunselecting-a-task)
- [Operations with tasks](guides/task_operations.md)
- [Multiple select and bulk operations](guides/multiselection.md)
2 changes: 1 addition & 1 deletion docs/api/methods/movetask_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,5 +131,5 @@ list.eachSelected(id => {
~~~

**Related articles:**
- [Operations with tasks](guides/task_operations.md#selectingunselecting-a-task)
- [Operations with tasks](guides/task_operations.md)
- [Multiple select and bulk operations](guides/multiselection.md)
2 changes: 1 addition & 1 deletion docs/api/methods/unchecktask_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,5 +76,5 @@ list.eachSelected(id => {
~~~

**Related articles:**
- [Operations with tasks](guides/task_operations.md#selectingunselecting-a-task)
- [Operations with tasks](guides/task_operations.md)
- [Multiple select and bulk operations](guides/multiselection.md)
2 changes: 1 addition & 1 deletion docs/api/methods/unindenttask_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,5 +70,5 @@ list.eachSelected(id => {
~~~

**Related articles:**
- [Operations with tasks](guides/task_operations.md#selectingunselecting-a-task)
- [Operations with tasks](guides/task_operations.md)
- [Multiple select and bulk operations](guides/multiselection.md)
10 changes: 5 additions & 5 deletions docs/api/rest_api/routes/delete_routes/delete_projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ title: DELETE /projects
description: You can learn about the DELETE /projects route in the documentation of the DHTMLX JavaScript To Do List library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX To Do List.
---

# DELETE /projects
# DELETE `/projects`

### Description

@short: Deletes data on a project and returns an empty json object

The route handles the DELETE request made to the **'/projects/{id}'** path.
The route handles the DELETE request made to the `/projects/{id}` path.

Only one project can be removed per request. All project tasks, if any, are also removed.

Expand All @@ -34,8 +34,8 @@ Only one project can be removed per request. All project tasks, if any, are also
The ID of a project to be removed is sent in the request line.

| Name | Type | Description |
| ----------- | ----------- | ----------- |
| `id` | number | *Required*. The id of a project to be removed.|
| ---------- | ----------- | ----------- |
| `id` | number | *Required*. The id of a project to be removed.|

### Payload

Expand All @@ -53,4 +53,4 @@ The HTTP status code shows whether the request succeeds (response.status == 200)

- [send()](api/rest_api/methods/send_method.md)
- [deleteProject()](api/methods/deleteproject_method.md)
- [Working with Server](guides/working_with_server.md)
- [Working with Server](guides/working_with_server.md)
10 changes: 5 additions & 5 deletions docs/api/rest_api/routes/delete_routes/delete_tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ title: DELETE /tasks
description: You can learn about the DELETE /tasks route in the documentation of the DHTMLX JavaScript To Do List library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX To Do List.
---

# DELETE /tasks
# DELETE `/tasks`

### Description

@short: Deletes data on a task and returns an empty json object

The route handles the DELETE request made to the **'/tasks/{id}'** path.
The route handles the DELETE request made to the `/tasks/{id}` path.

Only one task can be removed per request. All child tasks, if any, are also removed.

Expand All @@ -34,8 +34,8 @@ Only one task can be removed per request. All child tasks, if any, are also remo
The ID of a task that should be removed is sent in the request line.

| Name | Type | Description |
| ----------- | ----------- | ----------- |
| `id` | number | *Required*. The id of a task to be removed.|
| ---------- | ----------- | ----------- |
| `id` | number | *Required*. The id of a task to be removed.|

### Payload

Expand All @@ -53,4 +53,4 @@ The HTTP status code shows whether the request succeeds (response.status == 200)

- [send()](api/rest_api/methods/send_method.md)
- [deleteTasks()](api/methods/deletetask_method.md)
- [Working with Server](guides/working_with_server.md)
- [Working with Server](guides/working_with_server.md)
6 changes: 3 additions & 3 deletions docs/api/rest_api/routes/get_routes/get_projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ title: GET /projects
description: You can learn about the GET /projects route in the documentation of the DHTMLX JavaScript To Do List library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX To Do List.
---

# GET /projects
# GET `/projects`

### Description

@short: Gets data on all projects and returns a json object with an array of projects objects

The route handles the GET request made to the **'/projects'** path.
The route handles the GET request made to the `/projects` path.

<table style="border: 1px solid white; border-collapse: collapse; width:50%">
<thead style="border: 1px solid white; border-collapse: collapse;">
Expand Down Expand Up @@ -41,4 +41,4 @@ The HTTP status code shows whether the request succeeds (response.status == 200)
**Related articles**:

- [getProjects()](api/rest_api/methods/getprojects_method.md)
- [Working with Server](guides/working_with_server.md)
- [Working with Server](guides/working_with_server.md)
10 changes: 5 additions & 5 deletions docs/api/rest_api/routes/get_routes/get_projecttasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ title: GET /tasks/projects
description: You can learn about the GET /tasks/projects route in the documentation of the DHTMLX JavaScript To Do List library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX To Do List.
---

# GET /tasks/projects
# GET `/tasks/projects`

### Description

@short: Gets data on all tasks of the specified project and returns a json object with an array of all tasks objects for this specified project

The route handles the GET request made to the **'/tasks/projects/{id}'** path.
The route handles the GET request made to the `/tasks/projects/{id}` path.

<table style="border: 1px solid white; border-collapse: collapse; width:50%">
<thead style="border: 1px solid white; border-collapse: collapse;">
Expand All @@ -32,7 +32,7 @@ The route handles the GET request made to the **'/tasks/projects/{id}'** path.
The following parameter is sent in the request line:

| Name | Type | Description |
| ----------- | ----------- | ----------- |
| ---------- | ----------- | ----------- |
| `id` | string | *Required*. The ID of the project for which tasks are requested.|

### Payload
Expand All @@ -41,7 +41,7 @@ No payload is required.

### Response

The route returns a json object with an array that contains data for all tasks of the specified project.
The route returns a json object with an array that contains data for all tasks of the specified project.
You can find an example of the object that is returned here: [**tasks**](api/configs/tasks_config.md).

The HTTP status code shows whether the request succeeds (response.status == 200) or fails (response.status == 500).
Expand All @@ -51,4 +51,4 @@ The HTTP status code shows whether the request succeeds (response.status == 200)
**Related articles**:

- [getProjectTasks()](api/rest_api/methods/getprojecttasks_method.md)
- [Working with Server](guides/working_with_server.md)
- [Working with Server](guides/working_with_server.md)
6 changes: 3 additions & 3 deletions docs/api/rest_api/routes/get_routes/get_tags.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ title: GET /tags
description: You can learn about the GET /tags route in the documentation of the DHTMLX JavaScript To Do List library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX To Do List.
---

# GET /tags
# GET `/tags`

### Description

@short: Gets data on all tags and returns a json object with an array of these tags

The route handles the GET request made to the **'/tags'** path.
The route handles the GET request made to the `/tags` path.

<table style="border: 1px solid white; border-collapse: collapse; width:50%">
<thead style="border: 1px solid white; border-collapse: collapse;">
Expand Down Expand Up @@ -41,4 +41,4 @@ The HTTP status code shows whether the request succeeds (response.status == 200)
**Related articles**:

- [getTags()](api/rest_api/methods/gettags_method.md)
- [Working with Server](guides/working_with_server.md)
- [Working with Server](guides/working_with_server.md)
6 changes: 3 additions & 3 deletions docs/api/rest_api/routes/get_routes/get_tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ title: GET /tasks
description: You can learn about the GET /tasks route in the documentation of the DHTMLX JavaScript To Do List library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX To Do List.
---

# GET /tasks
# GET `/tasks`

### Description

@short: Gets data on all tasks and returns a json object with an array of tasks objects

The route handles the GET request made to the **'/tasks'** path.
The route handles the GET request made to the `/tasks` path.

<table style="border: 1px solid white; border-collapse: collapse; width:50%">
<thead style="border: 1px solid white; border-collapse: collapse;">
Expand Down Expand Up @@ -40,4 +40,4 @@ The HTTP status code shows whether the request succeeds (response.status == 200)
**Related articles**:

- [getTasks()](api/rest_api/methods/gettasks_method.md)
- [Working with Server](guides/working_with_server.md)
- [Working with Server](guides/working_with_server.md)
6 changes: 3 additions & 3 deletions docs/api/rest_api/routes/get_routes/get_users.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ title: GET /users
description: You can learn about the GET /users route in the documentation of the DHTMLX JavaScript To Do List library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX To Do List.
---

# GET /users
# GET `/users`

### Description

@short: Gets data on all users and returns a json object with an array of users objects

The route handles the GET request made to the **'/users'** path.
The route handles the GET request made to the `/users` path.

<table style="border: 1px solid white; border-collapse: collapse; width:50%">
<thead style="border: 1px solid white; border-collapse: collapse;">
Expand Down Expand Up @@ -40,4 +40,4 @@ The HTTP status code shows whether the request succeeds (response.status == 200)
**Related articles**:

- [getUsers()](api/rest_api/methods/getusers_method.md)
- [Working with Server](guides/working_with_server.md)
- [Working with Server](guides/working_with_server.md)
6 changes: 3 additions & 3 deletions docs/api/rest_api/routes/post_routes/post_clone.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ title: POST /clone
description: You can learn about the POST /clone route in the documentation of the DHTMLX JavaScript To Do List library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX To Do List.
---

# POST /clone
# POST `/clone`

### Description

@short: Creates a copy of a task and returns a json object with the client task ID and duplicated task ID of the server

The route handles the POST request made to the **'/clone'** path.
The route handles the POST request made to the `/clone` path.

<table style="border: 1px solid white; border-collapse: collapse; width:50%">
<thead style="border: 1px solid white; border-collapse: collapse;">
Expand Down Expand Up @@ -107,4 +107,4 @@ The HTTP status code shows whether the request succeeds (response.status == 200)
- [copyTask()](api/methods/copytask_method.md)
- [pasteTask()](api/methods/pastetask_method.md)
- [send()](api/rest_api/methods/send_method.md)
- [Working with Server](guides/working_with_server.md)
- [Working with Server](guides/working_with_server.md)
10 changes: 5 additions & 5 deletions docs/api/rest_api/routes/post_routes/post_projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ title: POST /projects
description: You can learn about the POST /projects route in the documentation of the DHTMLX JavaScript To Do List library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX To Do List.
---

# POST /projects
# POST `/projects`

### Description

@short: Creates a new project and returns a project object with the project ID in it

The route handles the POST request made to the **'/projects'** path.
The route handles the POST request made to the `/projects` path.

<table style="border: 1px solid white; border-collapse: collapse; width:50%">
<thead style="border: 1px solid white; border-collapse: collapse;">
Expand All @@ -30,8 +30,8 @@ The route handles the POST request made to the **'/projects'** path.
The server needs to receive a json object with one property:

| Name | Type | Description |
| ----------- | ----------- | ----------- |
| `label` | string | *Required*. The name of a new project to be added.|
| ---------- | ----------- | ----------- |
| `label` | string | *Required*. The name of a new project to be added.|

Example:

Expand Down Expand Up @@ -61,4 +61,4 @@ The HTTP status code shows whether the request succeeds (response.status == 200)

- [send()](api/rest_api/methods/send_method.md)
- [addProject()](api/methods/addproject_method.md)
- [Working with Server](guides/working_with_server.md)
- [Working with Server](guides/working_with_server.md)
6 changes: 3 additions & 3 deletions docs/api/rest_api/routes/post_routes/post_tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ title: POST /tasks
description: You can learn about the POST /tasks route in the documentation of the DHTMLX JavaScript To Do List library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX To Do List.
---

# POST /tasks
# POST `/tasks`

### Description

@short: Creates a new task and returns a task object with the ID of a new task

The route handles the POST request made to the **'/tasks'** path.
The route handles the POST request made to the `/tasks` path.

<table style="border: 1px solid white; border-collapse: collapse; width:50%">
<thead style="border: 1px solid white; border-collapse: collapse;">
Expand Down Expand Up @@ -71,4 +71,4 @@ The HTTP status code shows whether the request succeeds (response.status == 200)
**Related articles**:
- [send()](api/rest_api/methods/send_method.md)
- [addTask()](api/methods/addtask_method.md)
- [Working with Server](guides/working_with_server.md)
- [Working with Server](guides/working_with_server.md)
Loading

0 comments on commit 94cb165

Please sign in to comment.