Skip to content

Commit

Permalink
Add test plans description in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
zeburek committed May 9, 2020
1 parent 06361ad commit 58e9839
Showing 1 changed file with 72 additions and 1 deletion.
73 changes: 72 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,19 @@ This method allows to retrieve all projects available for your account. You can
projects = qase.projects.get_all()
```

#### Get All Projects ####
#### Get a specific project ####
This method allows to retrieve a specific project.

```python
project = qase.projects.get("PRJCODE")
```

#### Check project exists ####

```python
exists = qase.projects.exists("PRJCODE")
```

#### Create a new project ####
This method is used to create a new project through API.

Expand Down Expand Up @@ -62,12 +68,71 @@ This method allows to retrieve a specific test case.
test_case = qase.test_cases.get("PRJCODE", 4)
```

#### Check test case exists ####

```python
exists = qase.test_cases.exists("PRJCODE", 4)
```

#### Delete test case ####
This method completely deletes a test case from repository.

```python
qase.test_cases.delete("PRJCODE", 4)
```
### Test plans ###

#### Get all test plans ####
This method allows to retrieve all test plans stored in selected project. You can you limit and offset params to paginate.

```python
test_plans = qase.plans.get_all("PRJCODE")
```

#### Get a specific test plan ####
This method allows to retrieve a specific test plan.

```python
test_plan = qase.plans.get("PRJCODE", 123)
```

#### Check test plan exists ####

```python
exists = qase.plans.exists("PRJCODE", 123)
```

#### Create a new test plan ####
This method is used to create a new test plan through API.

```python
from qaseio.models import TestPlanCreate

test_plan = qase.plans.create(
"PRJCODE",
TestPlanCreate("New test run", [1, 2, 3]),
)
```

#### Update test plan ####
This method is used to update existing test plan through API.

```python
from qaseio.models import TestPlanCreate

test_plan = qase.plans.update(
"PRJCODE",
123,
TestPlanCreate("New test run", [1, 2, 3]),
)
```

#### Delete test plan ####
This method completely deletes a test plan from repository.

```python
qase.plans.delete("PRJCODE", 123)
```

### Test runs ###

Expand All @@ -86,6 +151,12 @@ This method allows to retrieve a specific test run.
test_run = qase.runs.get("PRJCODE", 4)
```

#### Check test run exists ####

```python
exists = qase.runs.exists("PRJCODE", 4)
```

#### Create a new test run ####
This method is used to create a new test run through API.

Expand Down

0 comments on commit 58e9839

Please sign in to comment.