Skip to content

Commit bfcd545

Browse files
committed
docs: document v6.0.0 release
1 parent 2e20f7c commit bfcd545

7 files changed

Lines changed: 92 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Changelog
2+
3+
## v6.0.0 - 2026-05-21
4+
5+
Release: <https://github.com/subzeroid/aiograpi-rest/releases/tag/v6.0.0>
6+
7+
### Changed
8+
9+
- Upgraded the wrapped client to `aiograpi==1.0.9`.
10+
- Updated the package version to `6.0.0`.
11+
- Reworked account password and email flows for current aiograpi semantics:
12+
`POST /account/password/reset`, `POST /account/email/confirmation`, and
13+
`POST /account/email/confirm`.
14+
- Updated Reel upload with music to use aiograpi's current
15+
`clip_upload_with_music` method and expose the new optional upload fields.
16+
17+
### Added
18+
19+
- Direct routes for request previews, channels, interop upgrade status, GenAI
20+
bot suggestions, and E2EE eligibility.
21+
- Music routes for current catalog search, keyword search, trending music, top
22+
trends, Reels music browsing, audio bookmarking, and original-audio title
23+
availability.
24+
- Media note routes: `POST /media/note` and `DELETE /media/note`.
25+
26+
### Removed
27+
28+
- Removed the public `GET /hashtag/related` route because aiograpi 1.0.x no
29+
longer exposes `hashtag_related_hashtags`.
30+
31+
### Verified
32+
33+
- Offline test gate: `270 passed, 6 deselected`, `100.00%` coverage.
34+
- Live smoke gate: `/user/about`, paginated reads, story upload/read/download
35+
cleanup, and media upload/edit/delete state checks passed on Python 3.13.
36+
- Release workflow verified PyPI, Docker Hub, GHCR, GitHub Release artifacts,
37+
and a smoke test of the published Docker image.

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,10 @@ such as `/media/unlike`, `/user/unfollow`, and `/media/unarchive` were removed
4646
before the public API became widely used; use `DELETE /media/like`,
4747
`DELETE /user/follow`, and `DELETE /media/archive`.
4848

49+
Current stable release: [`v6.0.0`](CHANGELOG.md), wrapping `aiograpi==1.0.9`.
50+
Use `subzeroid/aiograpi-rest:6.0.0` when you want a pinned Docker runtime, or
51+
`subzeroid/aiograpi-rest:latest` when you intentionally want the newest release.
52+
4953
```bash
5054
docker run --rm -p 8000:8000 subzeroid/aiograpi-rest
5155
```
@@ -258,6 +262,7 @@ Docker Hub and GitHub Packages. An `X.Y.Z` tag publishes
258262

259263
PyPI and GitHub Release artifacts are published from the same tag workflow,
260264
including the built wheel, source distribution, and `openapi.json`.
265+
See the [changelog](CHANGELOG.md) for release notes and verification evidence.
261266

262267
GitHub Packages image:
263268

docs/api.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# API Guide
22

3+
This guide is current for `aiograpi-rest v6.0.0`, which wraps
4+
`aiograpi==1.0.9`.
5+
36
## Authentication
47

58
Protected routes accept the saved session ID through the `X-Session-ID` header.

docs/changelog.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Changelog
2+
3+
## v6.0.0 - 2026-05-21
4+
5+
Release: <https://github.com/subzeroid/aiograpi-rest/releases/tag/v6.0.0>
6+
7+
### Changed
8+
9+
- Upgraded the wrapped client to `aiograpi==1.0.9`.
10+
- Updated the package version to `6.0.0`.
11+
- Reworked account password and email flows for current aiograpi semantics:
12+
`POST /account/password/reset`, `POST /account/email/confirmation`, and
13+
`POST /account/email/confirm`.
14+
- Updated Reel upload with music to use aiograpi's current
15+
`clip_upload_with_music` method and expose the new optional upload fields.
16+
17+
### Added
18+
19+
- Direct routes for request previews, channels, interop upgrade status, GenAI
20+
bot suggestions, and E2EE eligibility.
21+
- Music routes for current catalog search, keyword search, trending music, top
22+
trends, Reels music browsing, audio bookmarking, and original-audio title
23+
availability.
24+
- Media note routes: `POST /media/note` and `DELETE /media/note`.
25+
26+
### Removed
27+
28+
- Removed the public `GET /hashtag/related` route because aiograpi 1.0.x no
29+
longer exposes `hashtag_related_hashtags`.
30+
31+
### Verified
32+
33+
- Offline test gate: `270 passed, 6 deselected`, `100.00%` coverage.
34+
- Live smoke gate: `/user/about`, paginated reads, story upload/read/download
35+
cleanup, and media upload/edit/delete state checks passed on Python 3.13.
36+
- Release workflow verified PyPI, Docker Hub, GHCR, GitHub Release artifacts,
37+
and a smoke test of the published Docker image.

docs/getting-started.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@
66
docker run --rm -p 8000:8000 subzeroid/aiograpi-rest
77
```
88

9+
For a pinned runtime, use the current stable tag:
10+
11+
```bash
12+
docker run --rm -p 8000:8000 subzeroid/aiograpi-rest:6.0.0
13+
```
14+
915
Open <http://localhost:8000/docs> for Swagger UI.
1016

1117
For local development from a checkout:

docs/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,3 +42,6 @@ The service intentionally exposes a focused subset of `aiograpi.Client`. The
4242
generated [aiograpi coverage report](aiograpi-coverage.md) lists every public
4343
client method, whether it is reachable through a REST route, and whether an
4444
uncovered method is a duplicate implementation variant or an internal helper.
45+
46+
Current stable release: `v6.0.0`, wrapping `aiograpi==1.0.9`. See the
47+
[changelog](changelog.md) for release notes and verification evidence.

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ nav:
1010
- API Guide: api.md
1111
- Client Generation: client-generation.md
1212
- aiograpi Coverage: aiograpi-coverage.md
13+
- Changelog: changelog.md
1314
theme:
1415
name: material
1516
markdown_extensions:

0 commit comments

Comments
 (0)