chore: sync from pve-openapi@f0a6069

feat(sdk-sync): reserve user-test directory + preserve non-managed workflows

Author: bencurio

clientapi_pve/__init__.py

@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "2026.5.23"
+__version__ = "2026.5.24"
 
 # Define package exports
 __all__ = [

clientapi_pve/api_client.py

@@ -91,7 +91,7 @@ def __init__(
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/2026.5.23/python'
+        self.user_agent = 'OpenAPI-Generator/2026.5.24/python'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

clientapi_pve/configuration.py

@@ -574,7 +574,7 @@ def to_debug_report(self) -> str:
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 9.x\n"\
-               "SDK Package Version: 2026.5.23".\
+               "SDK Package Version: 2026.5.24".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self) -> List[HostSetting]:

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "clientapi_pve"
-version = "2026.5.23"
+version = "2026.5.24"
 description = "Proxmox Virtual Environment API"
 authors = [
   {name = "OpenAPI Generator Community",email = "team@openapitools.org"},

setup.py

@@ -19,7 +19,7 @@
 # prerequisite: setuptools
 # http://pypi.python.org/pypi/setuptools
 NAME = "clientapi-pve"
-VERSION = "2026.5.23"
+VERSION = "2026.5.24"
 PYTHON_REQUIRES = ">= 3.10"
 REQUIRES = [
     "urllib3 >= 2.1.0, < 3.0.0",

tests/e2e/README.md

@@ -0,0 +1,56 @@
+# User-written E2E tests
+
+This directory is reserved for **your** E2E tests against a live
+Proxmox VE server. Anything you put here:
+
+* **Survives regeneration.** The generator's orphan-removal step is
+  driven by `.openapi-generator/FILES` — files outside that manifest
+  (including this whole directory) are never touched by `sdk-sync`.
+* **Survives the workflow wipe.** `sdk-bootstrap` only touches the
+  workflow files it manages (`ci.yml`, `publish.yml`). User-added
+  workflows like `.github/workflows/e2e.yml` are preserved verbatim.
+
+The auto-generated SDK code lives outside this directory; treat
+everything under `tests/e2e` as your own.
+
+## Quickstart
+
+1. Add fixtures, helpers, and tests under `tests/e2e/`.
+2. (Optional) Add `.github/workflows/e2e.yml` to run them in CI against
+   a Proxmox VE test instance — the sync pipeline preserves
+   any workflow file whose name isn't in the managed allowlist.
+3. The generated `ci.yml` runs the SDK's own build + unit tests; wire
+   your E2E suite into a separate workflow so it can use its own
+   secrets / runners / schedule.
+
+## Conventions per language
+
+| Language | User-test path | Runner |
+|---|---|---|
+| TypeScript | `tests/e2e/*.test.ts` | `vitest run tests/e2e` |
+| Python | `tests/e2e/test_*.py` | `pytest tests/e2e` |
+| Go | `tests/e2e/*_test.go` (package `e2e_test`) | `go test ./tests/e2e/...` |
+| Rust | `tests/e2e/*.rs` | `cargo test --test '*'` |
+| PHP | `tests/E2E/*Test.php` | `vendor/bin/phpunit tests/E2E` |
+| Kotlin | `src/test/kotlin/e2e/*Test.kt` | `./gradlew test --tests 'e2e.*'` |
+
+> The Kotlin generator's post-process step deletes
+> `src/test/kotlin/**/apis/*.kt` and `src/test/kotlin/**/models/*.kt`
+> (openapi-generator's stub tests). Keep your tests **outside** those
+> two subpaths — the `e2e/` directory recommended above is the
+> intended location and is never touched by the pipeline.
+
+## Authenticating against a real server
+
+Use the API-token format documented in the SDK's main README:
+
+* Perl family (PVE, PMG): `<PREFIX>APIToken=USER@REALM!TOKENID=UUID`
+* Rust family (PBS, PDM): `<PREFIX>APIToken=USER@REALM!TOKENID:UUID`
+
+Set the secret via env var so tests stay portable:
+
+```sh
+PVE_HOST=https://pve.example.com:8006
+PVE_TOKEN='PVEAPIToken=root@pam!auto=<your-uuid>'
+PVE_INSECURE_TLS=1   # only when targeting a self-signed dev server
+```