Skip to content

Commit 4ea889a

Browse files
committed
fix(sdk): point documentation links at the published API docs
The interactive /docs and /redoc UIs are disabled in production, so the Documentation URL on the PyPI project page led to a 404. Both the package metadata and the README now use the same GitHub docs URL the API already returns in its own error responses.
1 parent 65f3054 commit 4ea889a

3 files changed

Lines changed: 4 additions & 4 deletions

File tree

sdk/python/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ The transport hard-caps response bodies at 10 MB, sends a `User-Agent: contrasta
155155

156156
## Links
157157

158-
- API docs: https://api.contrastcyber.com/docs
158+
- API docs: https://github.com/UPinar/contrastapi/blob/main/docs/API_Documentation.md
159159
- Pricing & API key: https://api.contrastcyber.com/pricing
160160
- Source: https://github.com/UPinar/contrastapi
161161
- Issues: https://github.com/UPinar/contrastapi/issues

sdk/python/pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ dependencies = [
3434

3535
[project.urls]
3636
Homepage = "https://contrastcyber.com"
37-
Documentation = "https://api.contrastcyber.com/docs"
37+
Documentation = "https://github.com/UPinar/contrastapi/blob/main/docs/API_Documentation.md"
3838
Repository = "https://github.com/UPinar/contrastapi"
3939
Issues = "https://github.com/UPinar/contrastapi/issues"
4040

sdk/python/tests/test_transport.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ def test_400_raises_invalid_argument_error_with_envelope():
9999
"error": {
100100
"code": "invalid_argument",
101101
"message": "Invalid CVE ID format",
102-
"docs_url": "https://api.contrastcyber.com/docs",
102+
"docs_url": "https://github.com/UPinar/contrastapi/blob/main/docs/API_Documentation.md",
103103
},
104104
},
105105
)
@@ -110,7 +110,7 @@ def test_400_raises_invalid_argument_error_with_envelope():
110110
assert err.status_code == 400
111111
assert err.code == "invalid_argument"
112112
assert err.message == "Invalid CVE ID format"
113-
assert err.docs_url == "https://api.contrastcyber.com/docs"
113+
assert err.docs_url == "https://github.com/UPinar/contrastapi/blob/main/docs/API_Documentation.md"
114114

115115

116116
@respx.mock

0 commit comments

Comments
 (0)