Skip to content

Commit 82622d1

Browse files
authored
fix: close claim spelling variants (#85)
1 parent 4e7e8ec commit 82622d1

16 files changed

Lines changed: 53 additions & 28 deletions

‎CHANGELOG.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
## [1.12.3] - 2026-08-11
11+
12+
### Fixed
13+
14+
- Match hyphenated free-tier wording and universal catalog claims in every
15+
readable wheel surface, and replace the remaining packaged docstrings with
16+
current-account and runtime-response terminology.
17+
1018
## [1.12.2] - 2026-08-11
1119

1220
### Fixed

‎EXAMPLES.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -629,7 +629,7 @@ Ready to build with these examples?
629629
## 📖 More Resources
630630

631631
- **[Complete API Documentation](https://docs.oilpriceapi.com)** - Full REST API reference
632-
- **[Available Commodities](https://docs.oilpriceapi.com/commodities)** - List of all supported commodities
632+
- **[Available Commodities](https://docs.oilpriceapi.com/commodities)** - Query the current commodity catalog
633633
- **[GitHub Repository](https://github.com/oilpriceapi/python-sdk)** - Source code and issues
634634
- **[Support](mailto:support@oilpriceapi.com)** - Get help from our team
635635

‎docs/DATAFRAMES.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ It accepts the same `per_page` range and automatically fetches every page.
5454

5555
## Current prices
5656

57-
Calling `client.prices.to_dataframe()` with no commodity returns all current
58-
prices and automatically follows the API's pagination headers:
57+
Calling `client.prices.to_dataframe()` with no commodity returns the current
58+
price records available to the account and follows the API's pagination headers:
5959

6060
```python
6161
df = client.prices.to_dataframe(per_page=250)

‎docs/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ prices = client.prices.get_multiple([
4949
])
5050
```
5151

52-
**[View all available commodities →](https://docs.oilpriceapi.com/commodities)**
52+
**[View the current commodity catalog →](https://docs.oilpriceapi.com/commodities)**
5353

5454
### Historical Data
5555

‎oilpriceapi/async_client.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -429,7 +429,7 @@ async def get_multiple(
429429
return prices
430430

431431
async def get_all(self) -> List[Price]:
432-
"""Get all available prices."""
432+
"""Get price records available to the current account."""
433433
response = await self.client.request(method="GET", path="/v1/prices/all")
434434

435435
if isinstance(response, dict) and "data" in response:

‎oilpriceapi/resources/bunker_fuels.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ def __init__(self, client):
2222
self.client = client
2323

2424
def all(self) -> List[Dict[str, Any]]:
25-
"""Get all bunker fuel prices.
25+
"""Get the available bunker fuel price records.
2626
2727
Returns:
28-
List of bunker fuel prices across all ports
28+
List of bunker fuel price records returned by the API
2929
3030
Example:
3131
>>> bunker_prices = client.bunker_fuels.all()

‎oilpriceapi/resources/commodities.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ def __init__(self, client):
2121
self.client = client
2222

2323
def list(self) -> List[Dict[str, Any]]:
24-
"""Get list of all available commodities.
24+
"""Get commodities available to the current account.
2525
2626
Returns:
2727
List of commodity objects with code, name, and metadata

‎oilpriceapi/resources/data_quality.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ def summary(self) -> Dict[str, Any]:
2222
"""Get data quality summary.
2323
2424
Returns:
25-
Summary of data quality metrics across all commodities
25+
Summary of data quality metrics returned by the API
2626
2727
Example:
2828
>>> summary = client.data_quality.summary()
@@ -41,10 +41,10 @@ def summary(self) -> Dict[str, Any]:
4141
return response
4242

4343
def reports(self) -> List[Dict[str, Any]]:
44-
"""Get all data quality reports.
44+
"""Get the available data quality reports.
4545
4646
Returns:
47-
List of data quality reports for all commodities
47+
List of data quality reports returned by the API
4848
4949
Example:
5050
>>> reports = client.data_quality.reports()

‎oilpriceapi/resources/demo.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
Demo Resource
33
44
Public, no-authentication demo endpoints (``/v1/demo/*``). These power the
5-
"time to first call" experience: a developer can fetch real free-tier prices
6-
and the full commodity catalog without an API key.
5+
"time to first call" experience: a developer can fetch the current demo price
6+
set and catalog metadata without an API key.
77
88
The demo endpoints ignore authentication entirely, so :class:`DemoResource`
99
works both as an attribute of an authenticated client (``client.demo``) and
@@ -68,11 +68,11 @@ def _get(self, path: str) -> Dict[str, Any]:
6868
return data
6969

7070
def prices(self, codes: Optional[List[str]] = None) -> Dict[str, Any]:
71-
"""Get latest demo prices for free-tier commodities.
71+
"""Get the latest price records currently exposed by the demo endpoint.
7272
7373
Args:
7474
codes: Optional list of commodity codes to request. When omitted,
75-
the API returns all free-tier commodities.
75+
the API returns its current demo set.
7676
7777
Returns:
7878
The ``data`` payload: ``{"prices": [...], "meta": {...}, "examples": {...}}``.
@@ -85,7 +85,7 @@ def prices(self, codes: Optional[List[str]] = None) -> Dict[str, Any]:
8585
return data
8686

8787
def commodities(self) -> Dict[str, Any]:
88-
"""Get the full demo commodity catalog grouped by category.
88+
"""Get current demo commodity metadata grouped by category.
8989
9090
Returns:
9191
The ``data`` payload: ``{"commodities": {category: [...]}, "meta": {...}}``.

‎oilpriceapi/resources/prices.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -108,16 +108,16 @@ def get_multiple(
108108
return prices
109109

110110
def get_all(self, per_page: int = 100) -> List[Price]:
111-
"""Get current prices for all available commodities.
111+
"""Get current price records available to the account.
112112
113-
Auto-paginates using X-Has-Next response headers until all records
114-
are retrieved.
113+
Auto-paginates using X-Has-Next response headers until the API reports
114+
no additional records.
115115
116116
Args:
117117
per_page: Number of records per page (default 100, matches API default)
118118
119119
Returns:
120-
List of Price objects for all commodities
120+
List of Price objects returned for the current account
121121
122122
Example:
123123
>>> all_prices = client.prices.get_all()

0 commit comments

Comments
 (0)