Skip to content

Commit

Permalink
Merge branch 'master' into develop
Browse files Browse the repository at this point in the history
  • Loading branch information
rjrudin committed Oct 31, 2024
2 parents cd0ee78 + f6abdc9 commit 14b740f
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 8 deletions.
4 changes: 1 addition & 3 deletions docs/Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -224,8 +224,7 @@ GEM
rb-fsevent (0.11.2)
rb-inotify (0.10.1)
ffi (~> 1.0)
rexml (3.3.6)
strscan
rexml (3.3.9)
rouge (3.26.0)
ruby2_keywords (0.0.5)
rubyzip (2.3.2)
Expand All @@ -240,7 +239,6 @@ GEM
faraday (>= 0.17.3, < 3)
simpleidn (0.2.1)
unf (~> 0.1.4)
strscan (3.1.0)
terminal-table (1.8.0)
unicode-display_width (~> 1.1, >= 1.1.1)
typhoeus (1.4.0)
Expand Down
8 changes: 4 additions & 4 deletions docs/creating-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,9 @@ from marklogic import Client
client = Client('http://localhost:8000', auth=('python-user', 'pyth0n'))
```

### MarkLogic Cloud Authentication
### Progress Data Cloud Authentication

When connecting to a [MarkLogic Cloud instance](https://developer.marklogic.com/products/cloud/), you will need to set
When connecting to a Progress Data Cloud instance, you will need to set
the `cloud_api_key` and `base_path` arguments. You only need to specify a `host` as well, as port 443 and HTTPS will be
used by default. For example:

Expand All @@ -85,8 +85,8 @@ from marklogic import Client
client = Client('https://example.marklogic.cloud', cloud_api_key='some-key-value', base_path='/ml/example/manage')
```

MarkLogic Cloud uses an access token for authentication; the access token is generated using the API key value. In some
scenarios, you may wish to set the token expiration time to a value other than the default used by MarkLogic Cloud. To
Progress Data Cloud uses an access token for authentication; the access token is generated using the API key value. In some
scenarios, you may wish to set the token expiration time to a value other than the default used by Progress Data Cloud. To
do so, set the `cloud_token_duration` argument to a number greater than zero that defines the token duration in
minutes:

Expand Down
2 changes: 1 addition & 1 deletion marklogic/cloud_auth.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

class MarkLogicCloudAuth(AuthBase):
"""
Handles authenticating with MarkLogic Cloud.
Handles authenticating with Progress Data Cloud.
See https://requests.readthedocs.io/en/latest/user/advanced/#custom-authentication
for more information on custom authentication classes in requests.
Expand Down

0 comments on commit 14b740f

Please sign in to comment.