From b0bbb66b240f11b04b46725227f0b5fbaa481af4 Mon Sep 17 00:00:00 2001 From: skalish Date: Wed, 14 Apr 2021 11:12:05 -0400 Subject: [PATCH 1/2] docs(tuc): add detail to passing json body in custom endpoint documentation --- docs/user-guide/advanced-usage.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/user-guide/advanced-usage.md b/docs/user-guide/advanced-usage.md index 3dee4e98..4b7867be 100644 --- a/docs/user-guide/advanced-usage.md +++ b/docs/user-guide/advanced-usage.md @@ -53,6 +53,16 @@ methods: response = tamr.get('relative/path/to/resource') ``` +Request headers and data can be supplied by passing dictionaries or lists with the `headers` and `json` arguments: + +```python +# e.g. `post` with headers and data +headers = {...} +body = {...} + +response = tamr.post('relative/path/to/resource', headers=headers, json=body) +``` + ### Custom Host / Port / Base API path If you need to repeatedly send requests to another port or base API path (i.e. not `/api/versioned/v1/`), you can simply instantiate a different client. From 23a4666ce75033762179879a10b9e777520be894 Mon Sep 17 00:00:00 2001 From: skalish Date: Mon, 19 Apr 2021 16:01:12 -0400 Subject: [PATCH 2/2] build(docs): increase sphinx version to bypass docutils 0.17.1 bug --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 2b0c0ae9..cec1ce77 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -3,6 +3,6 @@ pandas==1.0.5 recommonmark==0.6.0 sphinx_rtd_theme==0.5.0 sphinx-autodoc-typehints==1.11.0 -Sphinx==3.1.1 +Sphinx==3.5.4 toml==0.10.0 .