Merge remote-tracking branch 'origin/main' into fix/cli-max-records-limit

Author: fopina-ci

.github/change_version.py

@@ -6,6 +6,9 @@
 
 VERSION_PY = Path(__file__).parent.parent / 'defectdojo_api_generated' / '__init__.py'
 VERSION_RE = re.compile(r"__version__ = '(.*?)'")
+CLI_DEPENDENCY_PYPROJECT = Path(__file__).parent.parent / 'packages' / 'cli' / 'pyproject.toml'
+CLI_VERSION_RE = re.compile(r'(^version = ")([^"]+)(")', re.MULTILINE)
+CLI_DEPENDENCY_RE = re.compile(r'("defectdojo-api-generated==)([^"]+)(")')
 
 
 def main():
@@ -22,6 +25,9 @@ def main():
 
     if args.set:
         VERSION_PY.write_text(VERSION_RE.sub(f"__version__ = '{args.set}'", data))
+        cli_pyproject_data = CLI_DEPENDENCY_PYPROJECT.read_text()
+        cli_pyproject_data = CLI_VERSION_RE.sub(rf'\g<1>{args.set}\g<3>', cli_pyproject_data)
+        CLI_DEPENDENCY_PYPROJECT.write_text(CLI_DEPENDENCY_RE.sub(rf'\g<1>{args.set}\g<3>', cli_pyproject_data))
         print(f'New version: {args.set}')
 
 

.github/workflows/publish.yml

@@ -57,21 +57,41 @@ jobs:
         run: |
           .github/change_version.py --set '${{ inputs.version }}'
       - name: Build
-        run: uv run pyproject-build
+        run: |
+          rm -rf dist packages/cli/dist
+          uv run pyproject-build
+          uv run pyproject-build packages/cli
       - name: Publish
         env:
           TWINE_USERNAME: __token__
           TWINE_PASSWORD: ${{ secrets.twine_token }}
-        run: uv run twine upload --verbose --repository ${{ inputs.repository }} dist/*
+        run: uv run twine upload --verbose --repository ${{ inputs.repository }} dist/* packages/cli/dist/*
       - name: highlight
         run: |
           INDEX=""
           if [ "${{ inputs.repository }}" != "pypi" ]; then
             INDEX=" -i ${{ inputs.repository }}"
           fi
           cat <<EOF >> ${GITHUB_STEP_SUMMARY}
-          \`example\` uploaded to ${{ inputs.repository }}
+          Packages uploaded to ${{ inputs.repository }}
           \`\`\`
           pip install${INDEX} defectdojo-api-generated==${{ inputs.version }}
+          pip install${INDEX} defectdojo-cli==${{ inputs.version }}
+          \`\`\`
+          EOF
+          if [ "${{ inputs.repository }}" != "pypi" ]; then
+            cat <<EOF >> ${GITHUB_STEP_SUMMARY}
+          Run with \`uvx\`
+          \`\`\`
+          uvx --with 'defectdojo-api-generated @ https://test-files.pythonhosted.org/packages/source/d/defectdojo-api-generated/defectdojo_api_generated-${{ inputs.version }}.tar.gz' \\
+              'defectdojo-cli @ https://test-files.pythonhosted.org/packages/source/d/defectdojo-cli/defectdojo_cli-${{ inputs.version }}.tar.gz'
           \`\`\`
           EOF
+          else
+            cat <<EOF >> ${GITHUB_STEP_SUMMARY}
+          Run with \`uvx\`
+          \`\`\`
+          uvx defectdojo-cli==${{ inputs.version }}
+          \`\`\`
+          EOF
+          fi

.github/workflows/test.yml

@@ -33,6 +33,10 @@ jobs:
         run: |
           make lint-check
 
+      - name: Build CLI package
+        run: |
+          uv run pyproject-build packages/cli
+
   unit-tests:
     runs-on: ubuntu-latest
     strategy:
@@ -50,7 +54,7 @@ jobs:
       - name: Install dependencies
         run: |
           pip install uv
-          uv sync --dev --extra cli
+          uv sync --dev
 
       - name: Run unit tests
         run: |
@@ -76,7 +80,7 @@ jobs:
       - name: Install dependencies
         run: |
           pip install uv
-          uv sync --dev --extra cli
+          uv sync --dev
 
       - name: Run e2e tests
         run: |
@@ -96,7 +100,7 @@ jobs:
       - name: Install dependencies
         run: |
           pip install uv
-          uv sync --dev --extra cli
+          uv sync --dev
 
       - name: build docs
         run: |

.openapi-generator/FILES

@@ -6,6 +6,7 @@ defectdojo_api_generated/api/asset_api_scan_configurations_api.py
 defectdojo_api_generated/api/asset_groups_api.py
 defectdojo_api_generated/api/asset_members_api.py
 defectdojo_api_generated/api/assets_api.py
+defectdojo_api_generated/api/celery_api.py
 defectdojo_api_generated/api/configuration_permissions_api.py
 defectdojo_api_generated/api/credential_mappings_api.py
 defectdojo_api_generated/api/credentials_api.py
@@ -106,6 +107,11 @@ defectdojo_api_generated/docs/BurpRawRequestResponse.md
 defectdojo_api_generated/docs/BurpRawRequestResponseMulti.md
 defectdojo_api_generated/docs/BurpRawRequestResponseMultiRequest.md
 defectdojo_api_generated/docs/BurpRawRequestResponseRequest.md
+defectdojo_api_generated/docs/CeleryApi.md
+defectdojo_api_generated/docs/CeleryQueuePurgeCreate200Response.md
+defectdojo_api_generated/docs/CeleryQueueTaskDetail.md
+defectdojo_api_generated/docs/CeleryQueueTaskPurgeCreateRequest.md
+defectdojo_api_generated/docs/CeleryStatus.md
 defectdojo_api_generated/docs/ConfigurationPermission.md
 defectdojo_api_generated/docs/ConfigurationPermissionsApi.md
 defectdojo_api_generated/docs/Credential.md
@@ -176,6 +182,7 @@ defectdojo_api_generated/docs/FindingTest.md
 defectdojo_api_generated/docs/FindingTestType.md
 defectdojo_api_generated/docs/FindingToFiles.md
 defectdojo_api_generated/docs/FindingToNotes.md
+defectdojo_api_generated/docs/FindingVerifyRequest.md
 defectdojo_api_generated/docs/FindingsApi.md
 defectdojo_api_generated/docs/GlobalRole.md
 defectdojo_api_generated/docs/GlobalRoleRequest.md
@@ -496,6 +503,10 @@ defectdojo_api_generated/models/burp_raw_request_response.py
 defectdojo_api_generated/models/burp_raw_request_response_multi.py
 defectdojo_api_generated/models/burp_raw_request_response_multi_request.py
 defectdojo_api_generated/models/burp_raw_request_response_request.py
+defectdojo_api_generated/models/celery_queue_purge_create200_response.py
+defectdojo_api_generated/models/celery_queue_task_detail.py
+defectdojo_api_generated/models/celery_queue_task_purge_create_request.py
+defectdojo_api_generated/models/celery_status.py
 defectdojo_api_generated/models/configuration_permission.py
 defectdojo_api_generated/models/credential.py
 defectdojo_api_generated/models/credential_mapping.py
@@ -554,6 +565,7 @@ defectdojo_api_generated/models/finding_test.py
 defectdojo_api_generated/models/finding_test_type.py
 defectdojo_api_generated/models/finding_to_files.py
 defectdojo_api_generated/models/finding_to_notes.py
+defectdojo_api_generated/models/finding_verify_request.py
 defectdojo_api_generated/models/global_role.py
 defectdojo_api_generated/models/global_role_request.py
 defectdojo_api_generated/models/import_languages.py
@@ -827,6 +839,11 @@ defectdojo_api_generated/test/test_burp_raw_request_response.py
 defectdojo_api_generated/test/test_burp_raw_request_response_multi.py
 defectdojo_api_generated/test/test_burp_raw_request_response_multi_request.py
 defectdojo_api_generated/test/test_burp_raw_request_response_request.py
+defectdojo_api_generated/test/test_celery_api.py
+defectdojo_api_generated/test/test_celery_queue_purge_create200_response.py
+defectdojo_api_generated/test/test_celery_queue_task_detail.py
+defectdojo_api_generated/test/test_celery_queue_task_purge_create_request.py
+defectdojo_api_generated/test/test_celery_status.py
 defectdojo_api_generated/test/test_configuration_permission.py
 defectdojo_api_generated/test/test_configuration_permissions_api.py
 defectdojo_api_generated/test/test_credential.py
@@ -897,6 +914,7 @@ defectdojo_api_generated/test/test_finding_test.py
 defectdojo_api_generated/test/test_finding_test_type.py
 defectdojo_api_generated/test/test_finding_to_files.py
 defectdojo_api_generated/test/test_finding_to_notes.py
+defectdojo_api_generated/test/test_finding_verify_request.py
 defectdojo_api_generated/test/test_findings_api.py
 defectdojo_api_generated/test/test_global_role.py
 defectdojo_api_generated/test/test_global_role_request.py

.readthedocs.yaml

@@ -9,6 +9,10 @@ build:
   os: ubuntu-24.04
   tools:
     python: "3.13"
+  jobs:
+    post_install:
+      - pip install uv
+      - UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH uv sync --dev --all-extras
 
 # Build documentation with Mkdocs
 mkdocs:

AGENTS.md

@@ -121,6 +121,11 @@ Formatting and lint:
 - `make lint`
 - `make lint-check`
 
+Repo-specific expectation:
+
+- After any code, template, packaging, or GitHub Actions change, run `make lint`.
+- Do not treat `make lint` as optional or defer it unless the user explicitly asks not to run it or you are blocked.
+
 Tests:
 
 - `make test`

CONTRIBUTING.md

@@ -3,13 +3,22 @@
 This project uses `uv`, so set up the virtualenv by running
 
 ```
-uv sync --dev --extra cli
+uv sync --dev
 ```
 
 Use `make test` to make sure all tests pass before pushing.
 
 Use `make lint` to make sure lint check passes before pushing.
 
+## Packaging layout
+
+The main package, `defectdojo-api-generated`, is intentionally library-only.
+It does not publish console scripts and should remain installable without CLI-only dependencies.
+
+The `dojo` entrypoint lives in the thin wrapper package under `packages/cli/`.
+That package depends on the main library plus the CLI stack and should stay small:
+keep CLI packaging, entrypoints, and CLI-only dependency wiring there, while the actual CLI implementation can continue to live under `defectdojo_api_generated/cli/`.
+
 ## Guidelines
 
 ### Update openapi-generator version
@@ -28,5 +37,5 @@ Use `make lint` to make sure lint check passes before pushing.
 
 ### Update Dojo OpenAPI schema
 
-* Run `support/openapi/fetch_openapi.py` to refresh local copy
-* `make generate`
+* `make schema` to refresh local copy and update API changelog
+* `make generate` to generate classes

Makefile

@@ -6,9 +6,12 @@ lint-check:
 	uv run ruff format --diff
 	uv run ruff check
 
+sync:
+	uv sync --dev --all-extras
+
 .venv39: export VIRTUAL_ENV=.venv39
 .venv39:
-	uv sync --dev --extra cli --python 3.9 --active
+	uv sync --dev --all-extras --python 3.9 --active
 
 test39: .venv39
 test39: export VIRTUAL_ENV=.venv39
@@ -33,9 +36,10 @@ test-e2e:
 	uv run pytest tests/integration
 
 testpub:
-	rm -fr dist
+	rm -rf dist packages/cli/dist
 	uv run pyproject-build
-	uv run twine upload --repository testpypi dist/*
+	uv run pyproject-build packages/cli
+	uv run twine upload --repository testpypi dist/* packages/cli/dist/*
 
 schema:
 	uv run ./support/openapi/fetch_openapi.py --output ./support/openapi/openapi-new.json
@@ -46,11 +50,15 @@ templates:
 	./support/api_generation/dump_templates.sh
 
 # random generated file as target, just for timestamp
-defectdojo_api_generated/configuration.py: support/api_generation/custom_templates/*
+defectdojo_api_generated/configuration.py: support/api_generation/custom_templates/* support/openapi/openapi.json
 	./support/api_generation/generate.sh
 	$(MAKE) lint
 
 generate: defectdojo_api_generated/configuration.py
 
+schema-mr: schema generate
+schema-mr:
+	echo "Updated, now create and push branch update/schema-$(shell cat ./support/openapi/openapi.json | jq -r .info.version)"
+
 test-docs: generate
 	uv run mkdocs serve

README.md

@@ -16,14 +16,14 @@ Multiple changes done on top of default openapi-generator:
 * Remove most of pydantic/schema validations due to inconsistencies with actual database schema/requirements (tracked in https://github.com/fopina/defectdojo-api-generated/issues/39)
 * *Iterator* methods for every *list* API method to handle pagination automatically
 * A nice CLI exposing all the API methods <3
-  * installed only as an extra, to keep everything clean when package is used as library only
+  * published as `defectdojo-cli`, a separate package to keep library-only installs free of console-script conflicts
 
 ## Example
 
 ### Library
 
 ```
-pip install defectojo-api-generated
+pip install defectdojo-api-generated
 ```
 
 <!-- example-id: example.py -->
@@ -49,7 +49,7 @@ pip install defectojo-api-generated
 > [uv](https://docs.astral.sh/uv/) recommended or [pipx](https://github.com/pypa/pipx)
 
 ```
-uv tool install 'defectojo-api-generated[cli]'
+uv tool install defectdojo-cli
 ```
 
 ```
@@ -69,7 +69,7 @@ Commands:
 You can also skip tool install and just run it with:
 
 ```
-$ uvx 'defectojo-api-generated[cli]'
+$ uvx defectdojo-cli
 Usage: dojo [OPTIONS] COMMAND [ARGS]...
 ...
 ```

defectdojo_api_generated/__init__.py

@@ -22,6 +22,7 @@
     'AssetGroupsApi',
     'AssetMembersApi',
     'AssetsApi',
+    'CeleryApi',
     'ConfigurationPermissionsApi',
     'CredentialMappingsApi',
     'CredentialsApi',
@@ -122,6 +123,10 @@
     'BurpRawRequestResponseMulti',
     'BurpRawRequestResponseMultiRequest',
     'BurpRawRequestResponseRequest',
+    'CeleryQueuePurgeCreate200Response',
+    'CeleryQueueTaskDetail',
+    'CeleryQueueTaskPurgeCreateRequest',
+    'CeleryStatus',
     'ConfigurationPermission',
     'Credential',
     'CredentialMapping',
@@ -180,6 +185,7 @@
     'FindingTestType',
     'FindingToFiles',
     'FindingToNotes',
+    'FindingVerifyRequest',
     'GlobalRole',
     'GlobalRoleRequest',
     'ImportLanguages',
@@ -433,6 +439,7 @@
 from defectdojo_api_generated.api.asset_groups_api import AssetGroupsApi as AssetGroupsApi
 from defectdojo_api_generated.api.asset_members_api import AssetMembersApi as AssetMembersApi
 from defectdojo_api_generated.api.assets_api import AssetsApi as AssetsApi
+from defectdojo_api_generated.api.celery_api import CeleryApi as CeleryApi
 from defectdojo_api_generated.api.configuration_permissions_api import (
     ConfigurationPermissionsApi as ConfigurationPermissionsApi,
 )
@@ -566,6 +573,14 @@
 from defectdojo_api_generated.models.burp_raw_request_response_request import (
     BurpRawRequestResponseRequest as BurpRawRequestResponseRequest,
 )
+from defectdojo_api_generated.models.celery_queue_purge_create200_response import (
+    CeleryQueuePurgeCreate200Response as CeleryQueuePurgeCreate200Response,
+)
+from defectdojo_api_generated.models.celery_queue_task_detail import CeleryQueueTaskDetail as CeleryQueueTaskDetail
+from defectdojo_api_generated.models.celery_queue_task_purge_create_request import (
+    CeleryQueueTaskPurgeCreateRequest as CeleryQueueTaskPurgeCreateRequest,
+)
+from defectdojo_api_generated.models.celery_status import CeleryStatus as CeleryStatus
 from defectdojo_api_generated.models.configuration_permission import ConfigurationPermission as ConfigurationPermission
 from defectdojo_api_generated.models.credential import Credential as Credential
 from defectdojo_api_generated.models.credential_mapping import CredentialMapping as CredentialMapping
@@ -640,6 +655,7 @@
 from defectdojo_api_generated.models.finding_test_type import FindingTestType as FindingTestType
 from defectdojo_api_generated.models.finding_to_files import FindingToFiles as FindingToFiles
 from defectdojo_api_generated.models.finding_to_notes import FindingToNotes as FindingToNotes
+from defectdojo_api_generated.models.finding_verify_request import FindingVerifyRequest as FindingVerifyRequest
 from defectdojo_api_generated.models.global_role import GlobalRole as GlobalRole
 from defectdojo_api_generated.models.global_role_request import GlobalRoleRequest as GlobalRoleRequest
 from defectdojo_api_generated.models.import_languages import ImportLanguages as ImportLanguages