Merge branch 'main' into tl-add-security-md

Author: ArBridgeman

.github/workflows/check-api-outdated.yml

@@ -10,8 +10,8 @@ on:
     types: [opened, reopened]
   workflow_dispatch:
   schedule:
-    # "At 2 am UTC on every day." (https://crontab.guru)
-    - cron: "0 2 * * *"
+    # "At 2 am UTC on Monday." (https://crontab.guru)
+    - cron: "0 2 * * 1"
 
 jobs:
 
@@ -31,8 +31,8 @@ jobs:
           poetry-version: 2.0.1
           python-version: "3.10"
 
-      - name: Run Nox Task check-api-outdated
-        run: poetry run nox -s check-api-outdated
+      - name: Run Nox Task api:check-outdated
+        run: poetry run nox -s api:check-outdated
 
       - name: Report Failure Status to Slack Channel
         if: ${{ failure() && github.event_name == 'schedule' }}

.github/workflows/run-tests.yml

@@ -38,7 +38,7 @@ jobs:
           PYTEST_ADDOPTS: '-o log_cli=true -o log_cli_level=INFO ${{ steps.pytest-markers.outputs.slow-tests }}'
         run: |
           echo "PYTEST_ADDOPTS = $PYTEST_ADDOPTS"
-          export PROJECT_SHORT_TAG=$(poetry run nox -s get-project-short-tag)
+          export PROJECT_SHORT_TAG=$(poetry run nox -s project:get-short-tag)
           poetry run nox -s test:coverage -- --
 
       - name: Upload Artifacts

.pre-commit-config.yaml

@@ -36,7 +36,7 @@ repos:
         types: [ python ]
         pass_filenames: false
         language: system
-        entry: poetry run nox -s generate-api
+        entry: poetry run nox -s api:generate
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.4.0

doc/changes/changelog.md

@@ -1,6 +1,8 @@
 # Changes
 
 * [unreleased](unreleased.md)
+* [1.1.0](changes_1.1.0.md)
+* [1.0.0](changes_1.0.0.md)
 * [0.10.0](changes_0.10.0.md)
 * [0.9.0](changes_0.9.0.md)
 * [0.8.0](changes_0.8.0.md)
@@ -18,6 +20,8 @@
 hidden:
 ---
 unreleased
+changes_1.1.0
+changes_1.0.0
 changes_0.10.0
 changes_0.9.0
 changes_0.8.0

doc/changes/changes_1.0.0.md

@@ -0,0 +1,46 @@
+# 1.0.0 - 2025-02-27
+
+## Summary
+
+This release contains a potentially breaking change as class `database.Database` has been replaced with `exasol_database.ExasolDatabase`.
+
+This release updates the Python API generated from file `openapi.json` multiple times:
+
+In the scope of ticket #80 the updated API contains 3 additional fields for object `Schedule`:
+* `createdbyID`
+* `createdbyFirstName`
+* `createdbyLastName`
+
+In the scope of ticket #84 the updated API contains multiple additions and one removed field.
+
+A `class_override` has been added to file `openapi_config.yml` to solve a conflict caused by `openapi.json` containing model class `Database` with attribute `settings`, from which Openapi Python Client` generates a module `database_settings` containing class `DatabaseSettings`.
+
+The `class_override` replaces class `database.Database` with `exasol_database.ExasolDatabase` which potentially is a breaking change to the API.
+
+Changes to `openapi.json` in detail:
+
+In `paths` added
+* `/api/v1/accounts/{accountId}/databases/{databaseId}/database_settings`
+* `/api/v1/accounts/{accountId}/databases/{databaseId}/upgrade`
+
+And
+* In `components` / `schemas`: added `SetAutoUpdatesDatabase`
+* In `components` / `schemas` / `Schedule` / `required` removed `payload`
+
+And below `components` / `schemas`
+
+| In | Added |
+|----|-------|
+| `CreateDatabase` / `properties` | `numNodes` |
+| `Database` / `properties` / `settings` | `required`, `properties`, `additionalProperties` |
+| `DatabaseSettings` / `required` | `autoUpdatesEnabled`, `autoUpdatesHardDisabled`, `numNodes` |
+| `DatabaseSettings` / `properties` | `autoUpdatesEnabled`, `autoUpdatesHardDisabled`, `numNodes` |
+| `Schedule` / `properties` / `action` / `oneOf` / `enum` | `ActionDatabaseUpgrade` |
+
+## Refactorings
+
+* #80: Updated `openapi.json`
+* #84: Updated `openapi.json` again
+
+## Security
+ * #82: Dependencies updated, especially vitualenv (20.26.4 -> 20.29.2), jinja2 (3.1.4 -> 3.1.5)

doc/changes/changes_1.1.0.md

@@ -0,0 +1,29 @@
+# 1.1.0 - 2025-04-07
+
+## Summary
+
+This release updates the Python API generated from file `openapi.json`.
+
+Changes to `open-api.json` in detail:
+
+Endpoint was renamed
+* from `/api/v1/accounts/{accountId}/databases/{databaseId}/database_settings`
+* to `/api/v1/accounts/{accountId}/databases/{databaseId}/settings`
+
+Method `GET` was added for endpoint
+* `/api/v1/accounts/{accountId}/databases/{databaseId}/upgrade`
+
+Changes to models below `components` / `schemas`:
+
+Attribute `streamType` was added to
+* `CreateDatabase` / `properties`
+* `Database` / `properties` / `settings` / `required`
+* `Database` / `properties` / `settings` / `properties`
+* `DatabaseSettings` / `required`
+* `DatabaseSettings` / `properties`
+
+Model `DatabaseUpgradeInfo` was added.
+
+* Refactorings
+
+* #88: Updated `openapi.json`

doc/changes/unreleased.md

@@ -4,14 +4,15 @@
 
 This release updates the Python API generated from file `openapi.json`.
 
-The updated API contains 3 additional fields for object `Schedule`:
-* `createdbyID`
-* `createdbyFirstName`
-* `createdbyLastName`
+Changes to `open-api.json` in detail:
 
-## Refactorings
+Added `streamDescription` to the models below `components` / `schemas`:
+
+* `Database` / `properties` / `settings` / `required`
+* `Database` / `properties` / `settings` / `properties`
+* `DatabaseSettings` / `required`
+* `DatabaseSettings` / `properties`
 
-* #80: Updated `openapi.json`
+## Refactorings
 
-## Security
- * #82: Dependencies updated, especially vitualenv (20.26.4 -> 20.29.2), jinja2 (3.1.4 -> 3.1.5)
+* #90: Updated open API client 2025-04-15

doc/developer_guide/developer_guide.md

@@ -22,13 +22,14 @@ See also [API Documentation](https://docs.exasol.com/saas/administration/rest_ap
 In order to regenerate the model layer please use the following command line:
 
 ```shell
-poetry run nox generate-api
+poetry run nox -s api:generate
 ```
 
 ### Check API Outdated
 
-The CI checks include a check "Check API Outdated" (file check-api-outdated.yml, uses nox task check-api-outdated),
+The CI checks include a check "Check API Outdated" (file check-api-outdated.yml, uses nox task `api:check-outdated`),
 which regenerates the api, and checks it against the api version commited to GitHub.
+
 If this check fails, it is likely for one of the following causes:
 
 * SaaS API could have changed in the meantime (should be detected automatically)
@@ -39,11 +40,11 @@ If this check fails, it is likely for one of the following causes:
 In any of those cases, generating the api might give different results than in previous commits. These changes in the
 generated api need to be commited to your GitHub branch for the check to pass in the CI.
 This should be done automatically by the Pre-Commit Hooks (check if they are installed correctly),
-but can also be done manually by calling the generate-api nox task, and commiting the results.
-Before commiting, you might want to run the check-api-outdated nox task locally to see if it passed or if there are further problems:
+but can also be done manually by calling the nox task `api:generate`, and commiting the results.
+Before commiting, you might want to run the nox task `api:check-outdated` locally to see if it passed or if there are further problems:
 
 ```shell
-poetry run nox check-api-outdated
+poetry run nox -s api:check-outdated
 ```
 
 another cause for the check failing might be a python-toolbox update changing the linting/code formating. This can result in formatting tools
@@ -151,7 +152,7 @@ poetry run nox -s release:prepare -- -- <version> --no-pr
 In case you currently are already working on a branch other than `main`, please ensure to have all changes commited and add command line option `--no-branch`:
 
 ```shell
-poetry run nox -s release:preparee -- -- <version> --no-pr --no-branch
+poetry run nox -s release:prepare -- -- <version> --no-pr --no-branch
 ```
 
 ### Finalize and Publish the Release

exasol/saas/client/api_access.py

@@ -185,7 +185,7 @@ def create_database(
             cluster_size: str = "XS",
             region: str = "eu-central-1",
             idle_time: timedelta | None = None
-    ) -> Optional[openapi.models.Database]:
+    ) -> Optional[openapi.models.exasol_database.ExasolDatabase]:
         def minutes(x: timedelta) -> int:
             return x.seconds // 60
 
@@ -273,7 +273,7 @@ def database(
     def get_database(
             self,
             database_id: str,
-    ) -> Optional[openapi.models.database.Database]:
+    ) -> Optional[openapi.models.exasol_database.ExasolDatabase]:
         return get_database.sync(
             self._account_id,
             database_id,