CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog 1.0.0 and this project adheres to Semantic Versioning 2.0.0.

The first number is the major version (API changes, breaking changes) The second number is the minor version (new features) The third number is the patch version (bug fixes)

While the project is still on major version 0, breaking changes may be introduced in minor versions. This will be documented in the changelog where relevant.

0.26.1 - 2024-11-26

Fixed

• Incorporate missing SBOM and HarborAsyncClient.get_project_artifacts() changes intended for 0.26.0.

0.26.0 - 2024-11-25

Added

• Project artifacts method: HarborAsyncClient.get_project_artifacts()
• with_sbom_overview parameter for HarborAsyncClient.get_artifact() and HarborAsyncClient.get_artifacts() to include SBOM overview in the response.

Changed

• Models updated to API schema from c97253f
• All root models now share a common harborapi.models.base.RootModel base class.

Fixed

• Root models failing to build on Pydantic 2.10.

Removed

• Generic aliased root models:
  • harborapi.models.base.StrDictRootModel
  • harborapi.models.base.StrRootModel

0.25.3 - 2024-08-26

Added

• Model fields:
  • ProjectMetadata.proxy_speed_kb
  • Configurations.ldap_group_attach_parallel
  • ConfigurationsResponse.ldap_group_attach_parallel
  • Robot.creator
  • Artifact.artifact_type
  • Artifact.repository_name

Fixed

• HarborVulnerabilityReport.severity when report contains no vulnerabilities.

0.25.2 - 2024-06-26

Changed

• All Pydantic models now use default= kwarg for default values. This prevents certain type checking errors when the model is instantiated without specifying the field.

0.25.1 - 2024-06-18

Added

• harborapi.models.mappings.FirstDict which is a subclass of Python's built-in dict that provides a first() method to get the first value in the dict (or None if the dict is empty).

Changed

• HarborAsyncClient.get_artifact_vulnerability_reports() now returns FirstDict to provide easier access to the first (and likely only) report for the artifact.

0.25.0 - 2024-06-17

Added

• Permissions method:
  • HarborAsyncClient.get_permissions()
• Immutable tag rules methods:
  • HarborAsyncClient.get_project_immutable_tag_rules()
  • HarborAsyncClient.create_project_immutable_tag_rule()
  • HarborAsyncClient.update_project_immutable_tag_rule()
  • HarborAsyncClient.enable_project_immutable_tagrule()
  • HarborAsyncClient.delete_project_immutable_tag_rule()
• Artifact vulnerability reports method:
  • HarborAsyncClient.get_artifact_vulnerability_reports()
• Robot V1 methods:
  • HarborAsyncClient.get_robots_v1()
  • HarborAsyncClient.create_robot_v1()
  • HarborAsyncClient.get_robot_v1()
  • HarborAsyncClient.update_robot_v1()
  • HarborAsyncClient.delete_robot_v1()

Removed

• References to Helm charts in HarborAsyncClient.search().

Deprecated

• HarborAsyncClient.get_artifact_vulnerabilities() in favor of HarborAsyncClient.get_artifact_vulnerability_reports().
  • The old method only supported a single MIME type and was not flexible enough to support returning multiple reports given multiple MIME types. The new method supports this use case and is less strict than the old method in terms of MIME type validation.

0.24.2 - 2024-06-15

Changed

• Improved versioning script for maintainers.

0.24.1 - 2024-06-14

Fixed

• Changelog formatting.

0.24.0 - 2024-06-13

Added

• Python 3.12 support.
• harborapi.models.SBOMOverview which represents the SBOM overview for an artifact. Can be accessed via Artifact.sbom_overview.

Changed

• Added compatibility methods for purge endpoint methods that were renamed in HarborAPI v0.11.0.
  • The *audit_log_rotation* methods are now deprecated and will be removed in a future release.
  • It never made sense to create an opinionated naming for these methods.
• Project is now formatted and linted with Ruff instead of with Black and reorder-python-imports.
• Code generation now explicitly imports StrDictRootModel and StrRootModel.
• Updated API spec to ec8d692

0.23.4 - 2024-03-01

Changed

• HarborAsyncClient.authenticate(verify=...) will no longer instantiate a new client object if the verify value is identical to current one.

Removed

• Model field example keyword arguments.

0.23.3 - 2024-03-01

Fixed

• HarborAsyncClient.authenticate(verify=...) causing the client to fail to discard Harbor CSRF cookies.

0.23.2 - 2024-03-01

Added

• verify parameter for HarborAsyncClient.authenticate().
• New model field: ProjectMetadata.auto_sbom_generation

Fixed

• ReplicationFilter.value validation failing due to receiving non-dict value. Now accepts str, dict[str, Any] and None.

0.23.1 - 2024-01-22

Changed

• All URLs now point to new repo owner.

0.23.0 - 2023-12-19

The big Pydantic V2 update. This is a major update in terms of both scope and API compatibility.

Changed

• Model validation has become more strict.
  • Most importantly, str fields will no longer coerce int values to strings.
  • See Pydantic docs for more information.
• Models without fields now inherit from pydantic.RootModel and have a single field called root. These models have a special __getitem__ method, so they can be accessed like a dict. Currently, these are:
  • harborapi.models.ExtraAttrs
  • harborapi.models.Annotations
  • harborapi.models.ResourceList
  • harborapi.models.QuotaRefObject
  • harborapi.models.EventType
  • harborapi.models.NotifyType
  • harborapi.models.PayloadFormatType
  • harborapi.models.AdditionLinks
  • harborapi.models.InternalConfigurationsResponse
  • harborapi.models.ScanOverview
  • harborapi.models.AdditionLinks
• harborapi.models.ProjectMetadata:
  • retention_id now accepts both string and integer arguments. Band-aid fix until Harbor fixes their API spec and specifies that all retention IDs should be ints, not strings.
• harborapi.models.Artifact:
  • scan_overview is now a mapping of MIME types and their associated scan overview. Previously, we used some dirty metaprogramming to populate this field with the first scan overview found in the mapping. A new scan attribute has been added to access the first scan overview in the mapping, which is the same as the old behavior. This ensures serializing the model matches the original JSON from the API.
• harborapi.ext.report.ArtifactReport:
  • No longer supports iteration directly on the object itself. Use the artifacts attribute instead.
• Bool to string converter now limited to harborapi.models.ProjectMetadata model. This aberrant behavior is limited to ProjectMetadata, so the converter has been moved to the model itself. This band-aid fix will remain until Harbor changes their API spec and make these fields bools.

Removed

• missing_ok parameter for all relevant client methods.

Deprecated

• harborapi.models._models module. All main API spec models are now defined harborapi.models.models.
• harborapi.models._scanner module. All scanner models are now defined in harborapi.models.scanner.

0.22.3 - 2023-09-13

Changed

• Lower bounds of dependencies loosened to allow for certain older versions:
  • httpx >= 0.22.0
  • typing_extensions >= 4.4

0.22.2 - 2023-09-13

Changed

• License changed from GPLv3 to MIT.

0.22.1 - 2023-09-05

Changed

• Reduced sdist size significantly by removing unnecessary files (docs, tests, etc.).

0.22.0 - 2023-08-01

Changed

• Pydantic version capped at <2.0.0.
  • Migration to Pydantic V2 will begin soon.

0.21.0 - 2023-06-08

Added

• Missing optional limit argument for methods that fetch multiple resources:
  • HarborAsyncClient.get_replication_tasks
  • HarborAsyncClient.search_usergroups
  • HarborAsyncClient.get_webhook_policy_last_trigger
  • HarborAsyncClient.search_ldap_groups
  • HarborAsyncClient.search_ldap_users
  • HarborAsyncClient.get_registry_adapters
  • HarborAsyncClient.get_artifact_build_history

Changed

• HarborAsyncClient.get_replication_tasks argument order changed. Now status and resource_type follow the required argument project_id instead of after the optional query, sort, page, page_size and limit arguments.
• harborapi.models.ScannerProperties now takes an arbitrary number of extra fields instead of using a __root__ field.

Removed

• Deprecated fields removed in API spec(bf7c82b):
  • harborapi.models.Tag.signed
  • harborapi.models.GeneralInfo.with_notary

0.20.0 - 2023-05-30

Changed

• HarborAsyncClient.delete_scanner now raises HarborAPIException if no scanner response is returned from the API (was UnprocessableEntity before).

Removed

• Loguru dependency. The library now uses the standard Python logging library for logging purposes. See Logging in the docs for more information.

0.19.0 - 2023-05-15

Added

• BaseModel.get_model_fields, a class method which returns a list of names of all fields defined in the model's schema.

Changed

• BREAKING: Updated model schemas (`10c54c0..b232c90). Changes listed below:
  • Add model: PayloadFormatType
  • Add model: PayloadFormat
  • Add field: SupportedWebhookEventTypes.payload_formats
  • Add field: Accessory.subject_artifact_digest
  • Add field: Accessory.subject_artifact_repo
  • Update field: Access.resource description
  • Update field: Access.action description
  • Update field: ComponentHealthStatus.status description
  • Update field: Robot.name description
  • Update field: Robot.expires_at description
  • Update field: RobotCreate.name description
  • Deprecate field: Accessory.subject_artifact_id
  • Remove model:ChartMetadata (deprecated)
  • Remove model:ChartVersion (deprecated)
  • Remove model:SearchResult (deprecated)
  • Remove field Project.chart_count(deprecated)

0.18.1 - 2023-05-12

Added

• BaseModel.convert_to, which allows converting a model to another model type that has a similar schema, such as Project to ProjectReq.

Fixed

• Bool to string converter on BaseModel now correctly handles assignments.

0.18.0 - 2023-05-05

Added

• New context manager for temporarily disabling retrying: HarborAsyncClient.no_retry
• New context manager for temporarily disabling validation: HarborAsyncClient.no_validation
• New context manager for temporarily enabling raw mode: HarborAsyncClient.raw_mode
• Accept password kwarg for HarborAsyncClient constructor, while emitting warning for it. It isn't encouraged (or documented) to use password, but it might be more natural for many users than secret, so we allow it, since we already accept arbitrary kwargs.

Changed

• RetrySettings.max_tries now only accepts values greater than 0.
• RetrySettings.max_time now only accepts values greater or equal to 0.
• Models fields assignments are now validated by default.
• models.base.BaseModel.bool_converter renamed to models.base.BaseModel._bool_converter to hide it in IDE autocompletion. This shouldn't be a breaking change for anyone, since it was never documented or intended to be used by anyone outside of the library.

0.17.0 - 2023-05-03

Added

• Configurable retrying of failed requests using the new RetrySettings class, which can be passed to the HarborAsyncClient constructor with the retry keyword argument. See the retry docs for more information.

Fixed

• Methods that fetched files using the wrong Accept header have been fixed. This includes:
  • HarborAsyncClient.download_scan_export
  • HarborAsyncClient.get_system_certificate

Changed

harborapi.errors.StatusError.status_code is now always an integer. Returns 0 if no request is associated with the error.

0.16.2 - 2023-04-26

Added

• Disclaimer for harborapi.HarborAsyncClient.delete_retention_policy, warning that it can break a project due to a bug in Harbor.

Changed

• Move harborapi.client.ResponseLog and harborapi.client.ResponseLogEntry to harborapi.responselog module.

Fixed

• harborapi.models.VulnerabilityItem.severity field has had its type reverted to Severity from Optional[Severity], which was a regression introduced in v0.16.0.
• harborapi.ext.regex.match return type annotation is now correctly marked as Optional[Match[str]] instead of Match[str].
• harborapi.HarborAsyncClient.get_retention_tasks missing limit parameter in docstring.

0.16.1 - 2023-04-24

Fixed

• Passing a NativeReportSummary to Artifact.scan_overview no longer raises a ValidationError exception.

0.16.0 - 2023-04-24

Changed

• Broken or incomplete models are now completely redefined in harborapi.models.models to provide better documentation both in the code and in the generated documentation. This change should be backwards-compatible.
• harborapi.HarborAsyncClient.add_group_member now has a clearner warning describing its purpose and the alternative methods to use instead.

0.15.3 - 2023-04-20

Fixed

• Models with fields that wrongly required dicts of dicts now accept dicts of any for the affected fields:
  • harborapi.models.RetentionRule.params
  • harborapi.models.ImutableRule.params Until the official API spec is fixed, this is the best we can do.

0.15.2 - 2023-04-18

Removed

• harbor being added as an executable script installed by the project. This was a mistake, as the harbor executable script is intended to be exposed by harbor-cli.

0.15.1 - 2023-04-17

Added

• HarborAsyncClient.authenticate(). This method can be used to re-authenticate the client with new credentials without having to create a new client instance.

Changed

• HarborAsyncClient.get_artifact_vulnerabilities() now always returns a harborapi.models.HarborVulnerabilityReport object. If the artifact has no vulnerabilities or the report cannot be processed, an exception is raised.

Removed

• config argument from HarborAsyncClient.__init__(). The config argument was never implemented.

0.15.0 - 2023-04-13

Added

• Retention methods:
  • HarborAsyncClient.get_project_retention_id()
  • HarborAsyncClient.get_retention_policy()
  • HarborAsyncClient.create_retention_policy()
  • HarborAsyncClient.update_retention_policy()
  • HarborAsyncClient.delete_retention_policy()
  • HarborAsyncClient.get_retention_tasks()
  • HarborAsyncClient.get_retention_metadata()
  • HarborAsyncClient.get_retention_execution_task_log()
  • HarborAsyncClient.get_retention_executions()
  • HarborAsyncClient.start_retention_execution()
  • HarborAsyncClient.stop_retention_execution()

0.14.1 - 2023-04-11

Added

• verify kwarg for HarborAsyncClient and HarborClient which is passed to the underlying httpx.AsyncClient. This is useful for self-signed certificates, or if you want to control the SSL verification yourself. See httpx documentation for more information.
• harborapi.exceptions.StatusError.response which holds the HTTPX response object that caused the exception.

Fixed

• Potential circular import error in harborapi.ext, where HarborAsyncClient is imported as a type annotation.

0.14.0 - 2023-04-05

Changed

• limit kwarg now treats 0 as no limit. Previously, 0 meant no results would be returned.
• BREAKING: harborapi.ext.artifact.ArtifactInfo.tags now returns a list of tags instead of a comma-separated string of tags. This gives more flexibility to work with the various tags, and is more consistent with the rest of the library. If you need the comma-separated string, you can use ", ".join(artifact_info.tags).

0.13.1 - 2023-04-03

Fixed

• Pagination URLs containing spaces are now properly handled. This could occur if passing a a query parameter with a list of items, such as ?q=operation={push pull} or ?q=operation=(push pull).

0.13.0 - 2023-03-31

Changed

• HarborAsyncClient.update_project_member_role() now accepts integer arguments for its role_id parameter, since RoleRequest only has a single field (role_id).

Fixed

• Potential bug with models.VulnerabilitySummary if summary is None.
• JSON parsing exception in HarborAsyncClient.get_audit_log_rotation_schedule() that could occur if no schedule exists. The API returns an emtpy 200 OK response, which is now handled correctly (empty ExecHistory object).
• Missing docstring for HarborAsycClient.get_project_members.

0.12.0 - 2023-03-14

Changed

• BREAKING: HarborAsyncClient.export_scan_data() now takes the arguments in the order (criteria, scan_type). Furthermore, scan_type now has a default argument of "application/vnd.security.vulnerability.report; version=1.1", per the blog post describing this new feature. It should not be necessary specify this argument, but it is still possible to do so if you need to.

0.11.2 - 2023-03-14

Fixed

• Actually adds group_name parameter for HarborAsyncClient.get_usergroups() this time.

Added

• Missing group_name and limit parameters for HarborAsyncClient.get_usergroups().

0.11.1 - 2023-03-14

Added

• Missing group_name and limit parameters for HarborAsyncClient.get_usergroups().

0.11.0 - 2023-03-10

Added

• HarborAsyncClient.get_system_certificate()
  • Returns the system certificate. (GET /api/v2.0/systeminfo/getcert)

Changed

• BREAKING: Methods that download files, now return FileResponse instead of a bytes object. FileResponse contains the file contents along with its metadata. The object can be passed to bytes() to get the response contents, otherwise it can be accessed via the FileResponse.content attribute.
• BREAKING: Renamed "purge" methods to better reflect their purpose of audit log rotation:
  • HarborAsyncClient.get_purge_audit_log_status() -> HarborAsyncClient.get_audit_log_rotation()
  • HarborAsyncClient.get_purge_audit_log() -> HarborAsyncClient.get_audit_log_rotation_log()
  • HarborAsyncClient.stop_purge_audit_log() -> HarborAsyncClient.stop_audit_log_rotation()
  • HarborAsyncClient.get_purge_audit_log_schedule() -> HarborAsyncClient.get_audit_log_rotation_schedule()
  • HarborAsyncClient.create_purge_audit_log_schedule() -> HarborAsyncClient.create_audit_log_rotation_schedule()
  • HarborAsyncClient.update_purge_audit_log_schedule() -> HarborAsyncClient.update_audit_log_rotation_schedule()
  • HarborAsyncClient.get_purge_audit_logs() -> HarborAsyncClient.get_audit_log_rotation_history()

0.10.0 - 2023-02-28

Added

• harborapi.ext.artifact.ArtifactInfo.name_with_digest_full which returns the artifact name with the full SHA256 digest, not just the first 15 characters like name_with_digest.
• Audit log purging methods.
  • HarborAsyncClient.get_purge_audit_log_status()
  • HarborAsyncClient.get_purge_audit_log()
  • HarborAsyncClient.stop_purge_audit_log()
  • HarborAsyncClient.get_purge_audit_log_schedule()
  • HarborAsyncClient.create_purge_audit_log_schedule()
  • HarborAsyncClient.update_purge_audit_log_schedule()
  • HarborAsyncClient.get_purge_audit_logs()
• Documentation for HarborAsyncClient.get_project_deletable().
• Webhook methods.
  • HarborAsyncClient.get_webhook_jobs()
  • HarborAsyncClient.get_webhook_policies()
  • HarborAsyncClient.get_webhook_policy()
  • HarborAsyncClient.create_webhook_policy()
  • HarborAsyncClient.update_webhook_policy()
  • HarborAsyncClient.delete_webhook_policy()
  • HarborAsyncClient.get_webhook_policy_last_trigger()
  • HarborAsyncClient.get_webhook_supported_events()
• Scan Data Export Methods
  • HarborAsyncClient.get_scan_export()
  • HarborAsyncClient.get_scan_exports()
  • HarborAsyncClient.export_scan_data()
  • HarborAsyncClient.download_scan_export()
• Icon methods
  • HarborAsyncClient.get_icon()
• Label methods
  • HarborAsyncClient.get_label()
  • HarborAsyncClient.create_label()
  • HarborAsyncClient.delete_label()
  • HarborAsyncClient.get_labels()
• Project member methods
  • HarborAsyncClient.get_project_member()
  • HarborAsyncClient.add_project_member()
  • HarborAsyncClient.add_project_member_user()
  • HarborAsyncClient.add_project_member_group()
  • HarborAsyncClient.update_project_member_role()
  • HarborAsyncClient.remove_project_member()
  • HarborAsyncClient.get_project_members()
• New methods for controlling the size of the response log.
  • harborapi.client.ResponseLog.resize()
  • harborapi.client.ResponseLog.clear()
  • Documented here
• basicauth as a parameter for HarborAsyncClient.__init__() to pass in base64 basic auth credentials.

Changed

• missing_ok parameter for DELETE methods has been deprecated. Manually handle harborapi.exceptions.NotFound instead. This parameter will stop working in version 1.0.0, and be removed altogether in a later release.
• harborapi.models.Repository.split_name() now returns a tuple instead of a list, as its docstring states it should.
• DEPRECATED: Using credentials as a parameter for HarborAsyncClient.__init__ is deprecated. Use basicauth instead.
• HarborAsyncClient.credentials is now a Pydantic SecretStr, which prevents it from being printed in clear text when locals are dumped, such as when printing the client object. To access the value, use HarborAsyncClient.credentials.get_secret_value().

Removed

• Explicit logging calls from HarborAsyncClient.set_user_cli_secret() and HarborAsyncClient.set_user_password(). The exception handler handles logging if configured.

0.9.0 - 2023-02-21

Changed

• Updated harborapi.models to match the latest version of the Harbor API spec goharbor/harbor@d03f0dc.

• harborapi.models.GeneralInfo.with_chartmuseum has been removed from the API spec, but remains on the model for backwards compatibility. In the future, this field will be removed, as the API will never return this it in sufficiently new versions of Harbor.

0.8.6 - 2023-02-20

Fixed

• Models with harborapi.models.ScheduleObj fields are now correctly validated when the Harbor API responds with a value of "Schedule" for the field ScheduleObj.type, which is not a valid value for the enum according to their own spec.

0.8.5 - 2023-02-20

Added

NativeReportSummary.severity_enum which returns the severity of the report as a harborarpi.scanner.Severity enum, which can be used for comparisons between reports.

Fixed

harborarpi.scanner.Severity enum not having a None value, which is observed when a report has no vulnerabilities.

0.8.4 - 2023-02-14

Fixed

• Certain resource enumeration methods missing the limit parameter.
• HarborAsyncClient.get_gc_jobs() ignoring user parameters.

0.8.3 - 2023-02-14

Changed

• BREAKING: HarborAsyncClient.update_robot_token renamed to HarborAsyncClient.refresh_robot_token to better reflect the API endpoint name and purpose.

Fixed

• Pagination failing when one or more query parameter values included a comma.
• Certain HarborAsyncClient methods having missing or incomplete docstrings.

0.8.2 - 2023-02-09

Fixed

• HarborAsyncClient.get_registry_providers now returns a RegistryProviders object, which is a model whose only attribute providers is a dict of RegistryProviderInfo objects. Previously this method attempted to return a list of RegistryProviderInfo objects, but this was incorrect.

0.8.1 - 2023-02-09

Changed

• Backoff handlers for HTTP methods now handle a more strict subset of httpx.RequestError exceptions. This is to avoid retrying on exceptions that will never succeed such as httpx.UnsupportedProtocol.

0.8.0 - 2023-02-08

Added

• limit parameter for all methods that return a list of items. This parameter is used to limit the number of items returned by the API. See the docs for more details.

Removed

• retrieve_all parameter for all methods that return a list of items. Use the new limit parameter to control the number of results to retrieve. Passing retrieve_all to these methods will be silently ignored. In the future this will raise a DeprecationWarning.

0.7.1 - 2023-02-07

Added

• New parameters raw and validate to HarborAsyncClient and HarborClient to control whether the client returns the raw data from the API, and whether the client validates the data from the API, respectively. See the docs for more details.

0.7.0 - 2023-02-06

Added

• New models from 2022-11-28 spec update.

Changed

• Updated models from 2022-11-28 spec update.
• Generated models are now defined in models._models and models._scanner, and the overrides for these models are defined in models.models and models.scanner respectively. This is to make it easier to regenerate the models in the future while keeping the extended functionality (such as Repository.project_name, ScanOverview.__new__, etc.) for these classes intact, since that is now declared separately from the generated models. Furthermore, models.models and models.scanner both re-export all the generated models so that the API remains unchanged. See the Justfile for more details on how the models are generated.

Fixed

• HarborAsyncClient.search() raising an error when finding Helm Charts with an empty engine field.

Removed

• BREAKING: HarborAsyncClient.get_internal_config(). This endpoint is meant for internal usage only, and the new model definitions don't seem to play well with it. If you need this endpoint, please open an issue.

0.6.0 - 2023-01-30

Changed

• BREAKING: The max_depth parameter of the as_table() and as_panel() methods on all models now starts counting from 1 instead of 0.
  • max_depth=0 now means "no limit", and max_depth=1 means "only show the top level" (previously max_depth=0 meant "only show the top level" and max_depth=1 meant "show the top level and one level below")

0.5.0 - 2023-01-17

Added

• Changelog
• Rich as optional dependency: pip install harborapi[rich]

Changed

• Use Hatch as build system.