Merge pull request #434 from carbonblack/CBAPI-4818-release-1.5.0-upd…

…ates CBAPI-4818: Version number updates for Release 1.5.0
carbonblack · Oct 24, 2023 · 427f71f · 427f71f
2 parents 2915360 + 690bf69
commit 427f71f
Show file tree

Hide file tree

Showing 7 changed files with 73 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
 # VMware Carbon Black Cloud Python SDK
 
-**Latest Version:** 1.4.3
+**Latest Version:** 1.5.0
 <br>
-**Release Date:** June 26, 2023
+**Release Date:** TBD
 
 [![Coverage Status](https://coveralls.io/repos/github/carbonblack/carbon-black-cloud-sdk-python/badge.svg?t=Id6Baf)](https://coveralls.io/github/carbonblack/carbon-black-cloud-sdk-python)
 [![Codeship Status for carbonblack/carbon-black-cloud-sdk-python](https://app.codeship.com/projects/9e55a370-a772-0138-aae4-129773225755/status?branch=develop)](https://app.codeship.com/projects/402767)

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-1.4.3
+1.5.0
diff --git a/docs/alerts-migration.rst b/docs/alerts-migration.rst
@@ -1,3 +1,5 @@
+.. _alert-migration-guide:
+
 Alert Migration
 ===============
 

diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -1,5 +1,69 @@
 Changelog
 ================================
+CBC SDK 1.5.0 - Released (TBD)
+--------------------------------------
+
+**Alerts Update to use V7 API**
+
+The new Alerts V7 API will improve alert management and allow for easier management, consumption, and triage of alerts
+in the Carbon Black Cloud. Alerts v7 API extends the capabilities with improved methods of retrieving alerts and added
+functionality to manage alert workflow.
+
+**N.B.:** This change involves breaking changes to the SDK involving the core Alerts workflow. Please check your
+existing code carefully before deploying this SDK upgrade.
+
+**Breaking Changes:**
+
+* Alerts V7: Certain changes are not compatible with code written to the old V6 API. For details, please see the
+  :ref:`Alert Migration Guide <alert-migration-guide>`.  Breaking changes include:
+
+  * Default Search Time Period is reduced to two weeks.
+  * For fields that do not exist in the Alerts V7 API, a ``FunctionalityDecommissioned`` exception is raised.
+  * ``get_events()`` method has been removed.
+  * All facet terms match the field names.
+  * Workflow has been rebuilt.
+  * Create Note returns a single ``Note`` instance instead of a list.
+
+* Official support for Python 3.7 has been dropped, since that version is now end-of-life.  Added explicit testing
+  support for Python version 3.12.  **N.B.:** End users should update their Python version to 3.8.x or greater.
+
+New Features:
+
+* Alerts V7:
+
+  * Extended alert schema with additional metadata such as process command line and username, parent and child process
+    information, netconn data, additional device fields, MITRE categorization when available, and more
+  * Ability to mark alerts as “In Progress”
+  * Ability to mark alerts as True Positive or False Positive
+  * Additional fields available for both searching and faceting
+  * Enhanced note management with the ability to add notes to both individual alerts and threats (alerts grouped
+    by threat)
+  * Observed Alerts have been removed from the Alerts API as these events are not considered actionable threats. They
+    can now be retrieved via the Observations API.
+
+* External Devices: Added External Device Export and External Device Approvals Export.
+
+Updates:
+
+* Audit log requests have moved from ``CBCloudAPI`` into their own function entry point in the ``platform`` package.
+  The old function has been deprecated.
+* Process search validation has been changed to use the V2 ``POST`` API rather than the old V1 ``GET`` API.
+* ``CBCloudAPI.get_notifications()`` and ``CBCloudAPI.notification_listener()`` have been marked as deprecated.
+
+Documentation:
+
+* Added example script to poll for audit logs.
+* ``CBCloudAPI`` documentation has been pulled out into its own page.
+* Authentication, Getting Started, and Guides pages have been updated.
+* Concepts page has been removed, and the information it contained has moved to other pages.
+* New :ref:`Searching guide <searching-guide>` added.
+* Update to left-hand sidebar to allow the Guides sub-listing to be collapsed.
+* Porting guide has been updated to reflect the latest APIs.
+* Live Response migration guide has been updated with links.
+* ``README.md`` has been updated with better instructions for generating docs locally.
+* ``CBCloudAPI`` and Devices documentation have been updated to better conform to new style guide for docstrings.
+
+
 CBC SDK 1.4.3 - Released June 26, 2023
 --------------------------------------
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -23,7 +23,7 @@
 author = 'Developer Relations'
 
 # The full version, including alpha/beta/rc tags
-release = '1.4.3'
+release = '1.5.0'
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/searching.rst b/docs/searching.rst
@@ -1,3 +1,5 @@
+.. _searching-guide:
+
 Searching
 =========
 

diff --git a/src/cbc_sdk/__init__.py b/src/cbc_sdk/__init__.py
@@ -4,7 +4,7 @@
 __author__ = 'Carbon Black Developer Network'
 __license__ = 'MIT'
 __copyright__ = 'Copyright 2020-2023 VMware Carbon Black'
-__version__ = '1.4.3'
+__version__ = '1.5.0'
 
 from .rest_api import CBCloudAPI
 from .cache import lru