[VAN-126440] README added. #87
Conversation
README.md
Outdated
| Note: This SDK supports Python 3.8 and above. | ||
|
|
||
| ## Usage | ||
| To use the API, you need to configure the `ApiClient` with a `Configuration` object. |
There was a problem hiding this comment.
| To use the API, you need to configure the `ApiClient` with a `Configuration` object. | |
| To use the API, you need to provider the `ApiClient` with a `Configuration` object. |
to avoid over-using configure
There was a problem hiding this comment.
changed to to provide
README.md
Outdated
| config = Configuration.from_dict(config_dict) | ||
| ``` | ||
|
|
||
| Also, you can explicitly set the configuration parameters. E.g. for 2-legged OAuth 2.0 authentication: |
There was a problem hiding this comment.
Actually, two-legged/basic is the worst example for this as it requires putting password into code. I think instead we should say that the usage of this option is not recommended for that reason but instead it's provided for callers who want to sub-class it with their own Configuration constructor
There was a problem hiding this comment.
Replaced with 3-legged and added warning not to store sensitive information in envirnoment variables or in secret storage.
README.md
Outdated
| aggr_query_dto = AggregationQueryExecutionDTO.from_json(headcount_json) | ||
|
|
||
| # Passing 'Accept' header to ApiClient | ||
| api_client = ApiClient(header_name='Accept', header_value='text/csv') |
There was a problem hiding this comment.
So ApiClient doesn't support more than one header?
There was a problem hiding this comment.
ApiClient.set_default_header - method added in example.
Using it could be added multiple headers.
README.md
Outdated
| This Python SDK handles exceptions using custom exception classes derived from `OpenApiException`. Below are the main exception classes and their usage: | ||
|
|
||
| - `OpenApiException`: The base exception class for all API exceptions. | ||
| - `ApiTypeError`: Raised for type errors. |
There was a problem hiding this comment.
Consider adding just a bit more detail what type, value, attribute and key errors actually are. Don't need a novel, just a bit more than this
There was a problem hiding this comment.
I found only a raising for ApiValueError and updated its comment.
Other exceptions were removed from README.md.
It's possible these exceptions were obsolete or intended for extended standard templates.
Update wording. Co-authored-by: Henrik Areskoug <[email protected]>
README.md doc suggestions
Incorporated feedback
Update README.md
Added README.md how to use Python-SDK.