Skip to content

Commit a20de7b

Browse files
committed
README.md update
1 parent 049cef9 commit a20de7b

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,20 @@ py.test -c config.cfg
3434

3535
The `pytest.ini` file should have next mandatory fields:
3636

37-
- `rp_api_key` - value could be found in the User Profile section
3837
- `rp_project` - name of project in ReportPortal
3938
- `rp_endpoint` - address of ReportPortal Server
4039

40+
And one type of authorization: API Key or OAuth 2.0 Password grant. You can do this by setting:
41+
- `rp_api_key` or `RP_API_KEY` environment variable. You can get it in the User Profile section on the UI.
42+
43+
Or:
44+
- `rp_oauth_uri` - OAuth 2.0 token endpoint URL for password grant authentication. **Required** if API key is not used.
45+
- `rp_oauth_username` - OAuth 2.0 username for password grant authentication. **Required** if OAuth 2.0 is used.
46+
- `rp_oauth_password` - OAuth 2.0 password for password grant authentication. **Required** if OAuth 2.0 is used.
47+
- `rp_oauth_client_id` - OAuth 2.0 client identifier. **Required** if OAuth 2.0 is used.
48+
- `rp_oauth_client_secret` - OAuth 2.0 client secret. **Optional** for OAuth 2.0 authentication.
49+
- `rp_oauth_scope` - OAuth 2.0 access token scope. **Optional** for OAuth 2.0 authentication.
50+
4151
Example of `pytest.ini`:
4252

4353
```text
@@ -51,8 +61,6 @@ rp_launch_description = 'Smoke test'
5161
rp_ignore_attributes = 'xfail' 'usefixture'
5262
```
5363

54-
- The `rp_api_key` can also be set with the environment variable `RP_API_KEY`. This will override the value set for `rp_api_key` in pytest.ini
55-
5664
There are also optional parameters:
5765
https://reportportal.io/docs/log-data-in-reportportal/test-framework-integration/Python/pytest/
5866

0 commit comments

Comments
 (0)