Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
a467cce
chore(api): regenerate SDK
scalarbot Aug 14, 2026
20491c3
Merge scalar-generated into scalar-next (build iDlbFoTWAqW0wjmWsFSDX)
scalarbot Aug 14, 2026
bfc6022
chore(api): update generated SDK content
scalarbot Aug 14, 2026
42f62f9
Merge scalar-generated into scalar-next (build tnVEu8dsXNWKH6IBljKUi)
scalarbot Aug 14, 2026
6d8385a
chore(api): regenerate SDK
scalarbot Aug 17, 2026
f23cc4b
Merge scalar-generated into scalar-next (build NSi7RKfq8QnBk9czwOV3Y)
scalarbot Aug 17, 2026
6d667ae
chore(api): regenerate SDK
scalarbot Aug 20, 2026
439fd2a
Merge scalar-generated into scalar-next (build YAfZI5mpcDvcDPz1O2WYF)
scalarbot Aug 20, 2026
988f4f1
feat(api)!: remove operation planets.uploadImage (+6 more changes)
scalarbot Aug 28, 2026
f3b14da
Merge main into scalar-next
scalarbot Aug 28, 2026
1e263de
Merge scalar-generated into scalar-next (build kCCEoZ6AaOmrdYOWVhq7l)
scalarbot Aug 28, 2026
82b71a4
chore(api): update generated SDK content
scalarbot Aug 28, 2026
c835d3a
Merge scalar-generated into scalar-next (build m9TTq4lm0y4ma5jsjbhpp)
scalarbot Aug 28, 2026
dac4b89
Merge main into scalar-next
scalarbot Aug 28, 2026
ea460eb
feat(api)!: update SDK surface (2 changes)
scalarbot Aug 28, 2026
698e0d6
Merge scalar-generated into scalar-next (build mcpGSRzEJ7YsqyKHHqTdb)
scalarbot Aug 28, 2026
56b51d2
Merge main into scalar-next
scalarbot Aug 28, 2026
39f800d
chore(api): update generated SDK content
scalarbot Aug 28, 2026
8f483b9
Merge scalar-generated into scalar-next (build Lfhf8SyffSnC9rNUrM1Fr)
scalarbot Aug 28, 2026
c9ecb15
chore(api): regenerate SDK
scalarbot Aug 28, 2026
a1fc4e4
Merge scalar-generated into scalar-next (build bpLGhSyRAVMHm0HIVD40M)
scalarbot Aug 28, 2026
c83f53e
chore(api): regenerate SDK
scalarbot Sep 1, 2026
6232ea1
Merge scalar-generated into scalar-next (build 91iFVED2NgCyYZ7u68nAC)
scalarbot Sep 1, 2026
d13d692
feat(api)!: update property planet.habitabilityIndex (+3 more changes)
scalarbot Sep 15, 2026
fdbc978
Merge scalar-generated into scalar-next (build H7opIhT0HkROL0XMVtjGh)
scalarbot Sep 15, 2026
d724190
Merge main into scalar-next
scalarbot Sep 15, 2026
ecd956e
chore: release 0.3.1
scalarbot Sep 15, 2026
dc89444
chore: release 0.3.1
github-actions[bot] Sep 15, 2026
63546cf
Merge main into scalar-next
scalarbot Sep 15, 2026
1c1009d
chore(api): update generated SDK content
scalarbot Sep 15, 2026
a440cba
Merge scalar-generated into scalar-next (build PwNBPL4blvZGNqFBIOXMi)
scalarbot Sep 15, 2026
cf25ce3
chore(api): regenerate SDK
scalarbot Oct 2, 2026
e4dfc80
Merge scalar-generated into scalar-next (build FO7E0MLMNoHxHNoIv4hbz)
scalarbot Oct 2, 2026
d7834d5
Merge main into scalar-next
scalarbot Oct 2, 2026
8302c02
chore(api): regenerate SDK
scalarbot Oct 7, 2026
cbcc710
Merge scalar-generated into scalar-next (build L3eXfIcZ2mzv65UXGO6cG)
scalarbot Oct 7, 2026
af896a5
Merge main into scalar-next
scalarbot Oct 7, 2026
89ae96d
chore(api): regenerate SDK
scalarbot Oct 23, 2026
31e95e6
Merge scalar-generated into scalar-next (build ev8gYkMJQeDf30RrsjG7Y)
scalarbot Oct 23, 2026
7798c3e
Merge main into scalar-next
scalarbot Oct 23, 2026
90d5509
feat(api)!: remove operation planets.listAllData (+9 more changes)
scalarbot Oct 23, 2026
29d1775
Merge scalar-generated into scalar-next (build x4CqIWZpYJWQT1rdkzwdS)
scalarbot Oct 23, 2026
b1f6475
feat(api)!: update response of planets.list (+2 more changes)
scalarbot Nov 5, 2026
8207564
Merge scalar-generated into scalar-next (build 09tijcgFsXQEm5jbHkyqu)
scalarbot Nov 5, 2026
26e65b9
chore(api): regenerate SDK
scalarbot Nov 17, 2026
c19cb45
Merge scalar-generated into scalar-next (build LQcUlWMMjzlQOU46zQw29)
scalarbot Nov 17, 2026
e3b6a25
Merge main into scalar-next
scalarbot Nov 17, 2026
121863f
release: 0.4.0
scalar-docs[bot] Nov 17, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .claude/skills/scalar-galaxy-python-sdk/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ client = Galaxy(
bearer_auth=os.environ.get("BEARER_AUTH"),
)

planet = client.planets.list_all_data(
planet = client.planets.list(
limit=10,
offset=0,
)
Expand All @@ -64,7 +64,7 @@ Non-success responses throw generated API errors. Error objects expose status, h
from scalar_galaxy import APIStatusError

try:
planet = client.planets.list_all_data(
planet = client.planets.list(
limit=10,
offset=0,
)
Expand All @@ -79,5 +79,5 @@ except APIStatusError as err:

## Reference files

- [README.md](../../../README.md) — full feature tour: client options, retries and timeouts, logging.
- [README.md](../../../README.md) — full feature tour: client options, retries and timeouts, webhooks, logging.
- [api.md](../../../api.md) — complete catalogue of every operation with request and response types.
2 changes: 1 addition & 1 deletion .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
".": "0.3.2"
".": "0.4.0"
}
26 changes: 26 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,31 @@
# Changelog

## [0.4.0](https://github.com/scalar/galaxy-python/compare/v0.3.2...v0.4.0) (2026-11-17)


### ⚠ BREAKING CHANGES

* **api:** 2 breaking changes to the SDK surface.
- Response of `planets.list` changed from `paginated_resource` to an unnamed `application/json` body.
- Removed schema `paginated_resource`.
* **api:** 5 breaking changes to the SDK surface.
- Removed operation `planets.listAllData` (`GET /planets`).
- Removed operation `planets.delteImage` (`POST /planets/{planetId}/image`).
- Removed schema `ListAllDataResponseHeaders`.
- Removed schema `DelteImageResponseHeaders`.
- Removed schema `DelteImageStatus400ResponseHeaders`.

### Features

* **api:** remove operation planets.listAllData (+9 more changes) ([90d5509](https://github.com/scalar/galaxy-python/commit/90d550954fcc7440ca6d29f4de733844a887d052))
* **api:** update response of planets.list (+2 more changes) ([b1f6475](https://github.com/scalar/galaxy-python/commit/b1f647588fd6c7684a911894a8f83db8e216e8be))


### Chores

* **api:** regenerate SDK ([26e65b9](https://github.com/scalar/galaxy-python/commit/26e65b92db265dbf89e30830f46166b7db09efa8))
* **api:** regenerate SDK ([89ae96d](https://github.com/scalar/galaxy-python/commit/89ae96d3d7ed32cbe33a16ea551ebe771d4acf64))

## [0.3.2](https://github.com/scalar/galaxy-python/compare/v0.3.1...v0.3.2) (2026-10-07)


Expand Down
26 changes: 23 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ The full API of this library can be found in [api.md](./api.md).
- [Errors](#errors)
- [Client Options](#client-options)
- [Retries and Timeouts](#retries-and-timeouts)
- [Webhooks](#webhooks)
- [Helpers](#helpers)
- [Logging](#logging)
- [Requirements](#requirements)
Expand All @@ -41,7 +42,7 @@ client = Galaxy(
bearer_auth=os.environ.get("BEARER_AUTH"),
)

planet = client.planets.list_all_data(
planet = client.planets.list(
limit=10,
offset=0,
)
Expand All @@ -67,7 +68,7 @@ from scalar_galaxy import AsyncGalaxy

async def main() -> None:
client = AsyncGalaxy()
planet = await client.planets.list_all_data(
planet = await client.planets.list(
limit=10,
offset=0,
)
Expand Down Expand Up @@ -112,7 +113,7 @@ Non-success responses throw generated API errors. Error objects expose status, h
from scalar_galaxy import APIStatusError

try:
planet = client.planets.list_all_data(
planet = client.planets.list(
limit=10,
offset=0,
)
Expand Down Expand Up @@ -161,6 +162,24 @@ Generated clients support request timeouts and retry temporary failures such as

<br />

## Webhooks

The webhook helper verifies the signature of each delivery your server receives, then decodes its body into a typed event. Pass it the request body exactly as it arrived, before any JSON parsing, together with the request headers: the signature covers the raw body, so one that was parsed and re-serialized fails verification. A delivery whose signature does not verify is rejected before it is decoded.

```python
# `payload` is the raw request body; `headers` holds the request headers.
event = client.webhooks.unwrap(payload, headers=headers)
```

The signing secret comes from the client's `webhook_secret` option, which defaults to the `SCALAR_WEBHOOK_SECRET` environment variable. Pass `key` to use a different secret for one call.

The same resource also has:

- `client.webhooks.verify_signature(payload, headers)` checks a delivery's signature, and fails when it does not verify.
- `client.webhooks.parse_unsafe(payload)` decodes a body into a typed event without checking its signature. Use it only for a body verified elsewhere, or in tests.

<br />

## Helpers

- Use `client.with_raw_response.<resource>.<method>(...)` to access the raw `httpx.Response` and parse it yourself.
Expand All @@ -172,6 +191,7 @@ Generated clients support request timeouts and retry temporary failures such as

- Set the `SCALAR_LOG` environment variable to `info` or `debug` to enable HTTP logging.
- Logs are emitted through the standard `logging` module under the `scalar_galaxy` logger.
- Importing the SDK wraps the process's log record factory: records from the SDK, `httpx`, `httpcore`, `hpack` and `websockets` loggers have credential headers, credential query parameters and URL userinfo logged as `***`. A record factory installed later that does not chain to the previous one turns this off.

<br />

Expand Down
6 changes: 3 additions & 3 deletions SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ client = Galaxy(
bearer_auth=os.environ.get("BEARER_AUTH"),
)

planet = client.planets.list_all_data(
planet = client.planets.list(
limit=10,
offset=0,
)
Expand All @@ -64,7 +64,7 @@ Non-success responses throw generated API errors. Error objects expose status, h
from scalar_galaxy import APIStatusError

try:
planet = client.planets.list_all_data(
planet = client.planets.list(
limit=10,
offset=0,
)
Expand All @@ -79,5 +79,5 @@ except APIStatusError as err:

## Reference files

- [README.md](./README.md) — full feature tour: client options, retries and timeouts, logging.
- [README.md](./README.md) — full feature tour: client options, retries and timeouts, webhooks, logging.
- [api.md](./api.md) — complete catalogue of every operation with request and response types.
7 changes: 4 additions & 3 deletions VERSIONING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,13 @@ not have picked — **edit the release PR title** to the version you want:
release: 1.0.0
```

The `Release PR version` check turns red as soon as you save, because the version in the
The `Release PR version` check goes pending as soon as you save, because the version in the
title no longer matches the version committed in the PR. The Scalar platform then re-renders
the release PR at your version (changelog, manifest, and every version-bearing file), the
title comes back as `release: 1.0.0`, and the check turns green. **Wait for it to be green
before merging** — merging in between would tag a release whose own files still carry the
old version.
old version. The check only turns red if the title is not a full semver version, or if the
re-render has not arrived within 10 minutes.

The git-native equivalent, if you would rather not touch the PR: push an empty commit with a
`Release-As` footer to `scalar-next`. This is exactly what the title edit does for you.
Expand Down Expand Up @@ -95,6 +96,6 @@ Releases work without this; it closes a window where one can go out at the wrong

- **If this repository uses auto-merge, make the `Release PR version` check a required status
check.** Auto-merge merges as soon as the checks that are *required* go green, with no
human present — so a check that is not required but still red at that moment stops
human present — so a check that is not required but still pending at that moment stops
nothing, which is exactly the window between retitling a release PR and the platform
re-rendering it.
12 changes: 6 additions & 6 deletions api.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,11 @@ It's easy to say you know them all, but do you really? Retrieve all the planets

| Direction | Type |
| --- | --- |
| Request | [`PlanetListAllDataParams`](./src/scalar_galaxy/types/planet_list_all_data_params.py) |
| Response | [`PlanetListAllDataResponse`](./src/scalar_galaxy/types/planet_list_all_data_response.py) |
| Request | [`PlanetListParams`](./src/scalar_galaxy/types/planet_list_params.py) |
| Response | [`PlanetListResponse`](./src/scalar_galaxy/types/planet_list_response.py) |

```python
planet = client.planets.list_all_data(
planet = client.planets.list(
limit=10,
offset=0,
)
Expand Down Expand Up @@ -111,11 +111,11 @@ Got a crazy good photo of a planet? Share it with the world!

| Direction | Type |
| --- | --- |
| Request | [`PlanetDelteImageParams`](./src/scalar_galaxy/types/planet_delte_image_params.py) |
| Response | [`PlanetDelteImageResponse`](./src/scalar_galaxy/types/planet_delte_image_response.py) |
| Request | [`PlanetUploadImageParams`](./src/scalar_galaxy/types/planet_upload_image_params.py) |
| Response | [`PlanetUploadImageResponse`](./src/scalar_galaxy/types/planet_upload_image_response.py) |

```python
planet = client.planets.delte_image(
planet = client.planets.upload_image(
planet_id=1,
)
```
Expand Down
16 changes: 13 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "scalar-galaxy"
version = "0.3.2" # x-release-please-version
version = "0.4.0" # x-release-please-version
description = "The Scalar Galaxy is an example OpenAPI document to test OpenAPI tools and libraries. It's a fictional universe with fictional planets and fictional data."
readme = "README.md"
license = "Apache-2.0"
Expand All @@ -13,13 +13,20 @@ dependencies = [
"pydantic>=1.9.0, <3",
"typing-extensions>=4.14, <5",
"anyio>=3.5.0, <5",
"distro>=1.7.0, <2",
"sniffio",
]

[project.urls]
Source = "https://github.com/scalar/galaxy-python"
Issues = "https://github.com/scalar/galaxy-python/issues"
Changelog = "https://github.com/scalar/galaxy-python/blob/main/CHANGELOG.md"

[project.optional-dependencies]
aiohttp = ["aiohttp", "httpx_aiohttp>=0.1.9"]
webhooks = ["standardwebhooks >= 1.0.1, < 2"]
webhooks = []

[dependency-groups]
dev = ["pytest>=8.3.4"]

[build-system]
requires = ["hatchling>=1.18.0"]
Expand All @@ -30,3 +37,6 @@ packages = ["src/scalar_galaxy"]

[tool.ruff]
line-length = 120

[tool.pytest.ini_options]
testpaths = ["tests"]
Loading
Loading