Skip to content

Commit fc064e3

Browse files
docs(py): update Python docs (v0.9.3) (#44)
docs(py): automated update of leadr-oss docs bundle (v0.9.3)
1 parent 04389d8 commit fc064e3

4 files changed

Lines changed: 38 additions & 4 deletions

File tree

docs/api/.api-version

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
v0.9.2
1+
v0.9.3

docs/api/http-api/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: LEADR Open-Source Edition - Admin & Client API v0.9.1
2+
title: LEADR Open-Source Edition - Admin & Client API v0.9.2
33
---
44

5-
# LEADR Open-Source Edition - Admin & Client API v0.9.1
5+
# LEADR Open-Source Edition - Admin & Client API v0.9.2
66

77
> Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
88

docs/api/openapi.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"info": {
44
"title": "LEADR Open-Source Edition - Admin & Client API",
55
"description": "LEADR Open-Source Edition is the free cross-platform leaderboard backend for game devs",
6-
"version": "0.9.1"
6+
"version": "0.9.2"
77
},
88
"paths": {
99
"/v1/accounts": {

docs/api/reference/boards.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4145,8 +4145,42 @@ Utilities for parsing PostgreSQL interval syntax.
41454145

41464146
**Functions:**
41474147

4148+
- [**normalize_interval**](#leadr.boards.domain.interval_parser.normalize_interval) – Normalize an interval string, expanding shorthand aliases.
41484149
- [**parse_interval**](#leadr.boards.domain.interval_parser.parse_interval) – Parse PostgreSQL interval syntax to Python relativedelta.
41494150

4151+
**Attributes:**
4152+
4153+
- [**SHORTHAND_INTERVALS**](#leadr.boards.domain.interval_parser.SHORTHAND_INTERVALS) (<code>[dict](#dict)\[[str](#str), [str](#str)\]</code>) –
4154+
4155+
###### `leadr.boards.domain.interval_parser.SHORTHAND_INTERVALS`
4156+
4157+
```python
4158+
SHORTHAND_INTERVALS: dict[str, str] = {'hourly': '1 hour', 'daily': '1 day', 'weekly': '7 days', 'monthly': '1 month'}
4159+
```
4160+
4161+
###### `leadr.boards.domain.interval_parser.normalize_interval`
4162+
4163+
```python
4164+
normalize_interval(interval_string)
4165+
```
4166+
4167+
Normalize an interval string, expanding shorthand aliases.
4168+
4169+
Converts shorthand aliases like "daily" to their PostgreSQL interval
4170+
equivalents like "1 day". Standard interval syntax passes through unchanged.
4171+
4172+
**Parameters:**
4173+
4174+
- **interval_string** (<code>[str](#str)</code>) – Interval string, either shorthand or PostgreSQL syntax.
4175+
4176+
**Returns:**
4177+
4178+
- <code>[str](#str)</code> – Normalized PostgreSQL interval string.
4179+
4180+
**Raises:**
4181+
4182+
- <code>[ValueError](#ValueError)</code> – If interval format is invalid.
4183+
41504184
###### `leadr.boards.domain.interval_parser.parse_interval`
41514185

41524186
```python

0 commit comments

Comments
 (0)