Version 42:

Incompatible with clients using versions 0-41.

    pkg.client.api_errors has changed as follows:

        * The MainDictParsingException class was removed

        * The BadPublisherAlias and IndexLockedException

          exceptions were added.

    pkg.client.publisher has changed as follows:

        * The inter_certs property was renamed to intermediate_certs.

Version 41:

Compatible with clients using versions 40-41.

    Allows the client to handle signed packages.  This includes the

    addition of a large number of optional parameters to the

    client/publisher class.  It also makes changes to image creation to

    allow image properties to be set during the process.  New subclasses

    of ApiException were created to indicate different error conditions

    associated with signing failures.

Version 40:

Incompatible with clients using versions 0-39.

    The pkg.client.api ImageInterface has changed as follows:

        * The info() method no longer detects and returns multiple

          matches for patterns and instead will return all matches

          for a given pattern.

        * The ImageInterface.INFO_MULTI_MATCH property has been

          removed.

        * The PackageInfo.PREF_PUBLISHER attribute and data has been

          removed.

        * Illegal patterns will cause info() to raise an exception

          immediately.

Version 39:

Compatible with clients using versions 36-38.

    Introduces the notion of a system repository to the publisher

    heirarchy.  This specific type of repository is a subclass of

    RepositoryURI.  A few new api exceptions are added, too.

Version 38:

Compatible with clients using versions 36-37.

    The pkg.client.api now supports file-based repository access for all

    operations.  All related classes have been updated to support URIs

    that use the 'file' scheme.

Version 37:

Compatible with clients using version 36.

    The pkg.client.api ImageInterface has changed as follows:

        * Whenever an unexpected change in the state or structure

          of the image is encountered during install, remove, or

          update operations (such as a missing file, directory,

          or inability to remove an item) and it cannot be

          recovered from without user intervention, an

          ActionExecutionError exception is raised.

Version 36:

Incompatible with clients using versions 0-35.

    The interface for pkg.client.api.remote_search has changed as follows:

        * A new parameter, prune_versions, has been added which, when true,

          causes remote search to remove versions a user is unlikely to be

          interested in.

        * The return type of remote_search and local_search has changed.  Where

          the string representation used to be returned, a FMRI object is now

          returned.

Version 35:

Compatible with clients using version 34.

    The ImageInterface class has changed as follows:

        * A new method named parse_fmri_patterns has been added to

          help clients parse user input and transform any valid patterns

          into FMRI objects that can be used for comparison.  See pydoc

          'pkg.client.api' for details.

        * New constants for the parse_fmri_patterns method were added:

          MATCH_EXACT, MATCH_FMRI, and MATCH_GLOB.

Version 34:

Incompatible with clients using versions 0-33.

    The pkg.client.publisher.Publisher class has changed as follows:

        * The deprecated get_ssl_creds() and set_origin() methods

          were removed.  These functions have been marked as

          deprecated since the client API was first versioned

          and should not have been used by any clients.

Version 33:

Compatible with clients using version 32.

    The ImageInterface class has changed as follows:

        * file and directory actions will now have their mode validated

          if failure occurs during plan execution to determine if bad

          package metadata was the cause of execution failure.  In

          addition, the client API will catch failures due to corrupt

          or invalid package metadata and re-raise them as an

          InvalidPackageErrors exception.

    The pkg.client.api_errors module has changed as follows:

        * The InvalidPackageErrors exception was added.  See 'pydoc

          pkg.client.api_errors' for details.

Version 32:

Incompatible with clients using versions 0-31.

    The ImageInterface class has changed as follows:

        * The add_publisher and update_publisher methods now validate

          the image's publisher configuration against the origins of

          the publisher.  If any of the origins are found to not match,

          an UnknownRepositoryPublishers exception will be raised.

          If one of the new repository origins does not provide

          publisher configuration information or it is incomplete,

          a RepoPubConfigUnavailable exception will be raised.

    The pkg.client.api module has changed as follows:

        * A new method named image_create has been added.  See 'pydoc

          pkg.client.api' for details.

    The pkg.client.api_errors module has changed as follows:

        * UnknownRepositoryPublishers, RepoPubConfigUnavailable, and

          UnknownErrors expections have been added for use by the

          pkg.client.api.  API consumers are reminded that they should

          catch all ApiException class exceptions, although catching

          specific exception subclasses for case-by-case handling in

          addition to that is acceptable.

Version 31:

Compatible with clients using version 30.

    All image-modifying operations now lock the image for exclusive use

    by the current thread and process.  If the lock cannot be obtained,

    an ImageLockedError exception will be raised.

    The ImageInterface class has changed as follows:

        * A new property named 'blocking_locks' has been added to allow

          clients to control image locking behaviour.  See 'pydoc

          pkg.client.api.ImageInterface' for details.

        * The prepare() and execute_plan() methods will now raise an

          InvalidPlanError if the image state has changed since the

          plan was originally created.  This is likely the result of

          another client or process modifying the image.

Version 30:

Incompatible with clients using versions 0-29:

    The ProgressTracker class has changed as follows:

        * ver_output_warning() and ver_output_info() were added so that

          callers can choose to output warning and info verification

          messages separately from errors.

Version 29:

Incompatible with clients using versions 0-28:

    The ImageInterface class has changed as follows:

        * set_plan_license_status() was added.  This is used to indicate

          whether licenses for the packages being operated on have been

          accepted or displayed.  Clients must do this if the related

          license requires acceptance or display.

    The LicenseInfo class has changed as follows:

        * get_text() may now trigger a remote retrieval of the license

          payload if needed to return the text.

        * The related package FMRI and license attributes are now

          properties: fmri, license, must_accept, and must_display.

    The PlanDescription class has changed as follows:

        * get_changes() is now a generator function.

        * get_licenses() was added to allow clients to retrieve the

          list of licenses related to the plan's operations as well

          as the current accepted and displayed status of each.

Version 28:

Incompatible with clients using versions 0-27:

    CatalogRefreshException.message was changed to

    CatalogRefreshException.errmessage to work around a change

    introduced in python2.5 and removed in python2.6 (Exception.message,

    if used, triggers a deprecation warning).

Version 27:

Compatible with clients using versions 25-26:

    The get_manifest function has been added to the api to allow clients

    to retrieve the manifest directly.

Version 26:

Compatible with clients using version 25.

    The client API has changed such that an immediate refresh is always

    performed when the 'refresh_catalogs' parameter is True for install,

    update, and change variant operations.

Version 25:

Incompatible with clients using versions 0-24:

Changes:

    The PackageInfo class has changed as follows:

        * The NOT_INSTALLED constant has been removed as checking

          for the presence of INSTALLED should be sufficient.

        * A new constant named 'KNOWN' has been added.  It indicates

          that the package is currently available from a publisher's

           repository.

         * A new constant named 'UPGRADABLE' has been added. It

           indicates that a new version of the package is available.

     The following new api functions were added to ImageInterface (see

     'pydoc pkg.client.api.ImageInterface' for more information):

         * get_pkg_categories

         * get_pkg_list

Version 24:

Incompatible with clients using versions 0-23.

    The pkg.client.api module has changed as follows:

        * plan_install no longer takes a filters argument

	* plan_change_variant changed to plan_change_varcets.

	  w/ argument list changes.

	* Added get_pub_search_order

	* Added set_pub_search_after

	* Added set_pub_search_before

Version 23:

Incompatible with clients using versions 0-22.

    The pkg.client.api module has changed as follows:

        * PackageInfo objects no longer take a "state" parameter, but a

	  "states" parameter, and the corresponding "state" member is now

	  "states", and is a list of states, rather than a single value.

Version 22:

Compatible with clients using version 21.

Changes:

	Adds the description field to the PackageInfo class.

Version 21:

Incompatible with clients using versions 0-20.

Changes:

    The pkg.client.api_errors module has changed as follows:

        * All CatalogCacheError class exceptions were removed as the

          catalog cache no longer exists.

Version 20:

Compatible with clients using version 19.

Changes:

   The following exceptions were added to pkg.client.api_errors:

   class ReadOnlyFileSystemException(PermissionsException):

   """Used to indicate that the operation was attempted on a

   read-only filesystem"""

Version 19:

Incompatible with clients using versions 0-18.

Changes:

    The ImageInterface class changed as follows:

        * plan_update_all no longer returns a third value, the exception

          caught.  This value was never set.

        * plan_install no longer returns a second value, the exception

          caught.  This value was never set.

Version 18:

Compatible with clients using versions 15-17.

Changes:

   The following exceptions were added to pkg.client.api_errors:

    class SetDisabledPublisherPreferred(PublisherError):

        """Used to indicate an attempt to set a disabled publisher as

        the preferred publisher was made."""

Version 17:

Compatible with clients using versions 15-16.

Changes:

    The following properties were added to pkg.client.api

    ImageInterface class:

        root

            The absolute pathname of the filesystem root of the image.

            This property is read-only.

Version 16:

Compatible with clients using version 15.

Changes:

   The following exceptions were added to pkg.client.api_errors:

    class NoSuchKey(CertificateError):

        """Used to indicate that a key could not be found."""

Version 15:

Incompatible with clients using versions 1-14.

Changes:

    The unfound_fmris variable in the

    pkg.client.api_errors.PlanCreationException class is now called 

    unmatched_fmris.

Version 14:

Compatible with clients using versions 12-14.

Changes:

    The following methods were added to pkg.client.publisher.Publisher:

        def create_meta_root(self):

                """Create the publisher's meta_root."""

        def remove_meta_root(self):

                """Removes the publisher's meta_root."""

Version 13:

Compatible with clients using version 12.

Changes:

    By default, publisher repositories will be checked for new metadata no more

    than once every four hours unless otherwise requested.  Each time a

    publisher's selected repository is checked for updates, the client will

    store a timestamp (in UTC) marking when the refresh was performed.

    ImageInterface.refresh() has changed as follows:

        * Changed 'full_refresh' to an optional keyword argument that defaults

          to False.

        * Added optional boolean keyword 'immediate' that allows the client to

          request that a publisher be checked for updates even if a check is

          not yet needed.

        * Changed to properly use progress tracker for refreshing of publisher

          metadata.

        * Now only refreshes publisher metadata based on the update interval

          specified by the refresh_seconds property on the publisher's

          selected_repository.

    ImageInterface.update_publisher() has changed as follows:

        * When updating a publisher with 'refresh_allowed' set to False, its

          catalog will no longer be removed.  Instead, it is marked as needing

          refresh, and the next time the client can do so, it will.

    pkg.client.publisher.Publisher has changed as follows:

        * New property 'last_refreshed':

                A datetime object representing the time (in UTC) the

                publisher's selected repository was last refreshed for new

                metadata (such as catalog updates).  'None' if the publisher

                hasn't been refreshed yet or the time is not available.

          The above property will be automatically set by the api as needed

          although api consumers are free to retrieve its value.  Manually

          setting this value is not recommended.

        * New property 'meta_root':

                The absolute pathname of the directory where the publisher's

                metadata should be written to and read from.

          The above property will be automatically set by the api as needed

          although api consumers are free to retrieve its value.  Manually

          setting this value is not recommended.

        * New property 'needs_refresh':

                A boolean value indicating whether the publisher's metadata for

                the currently selected repository needs to be refreshed.

Version 12:

Incompatible with clients using versions 1-12

Changes:

    This versions adds local_search and remote_search to the api and removes

    those functions from pkg.client.image.

Version 11:

Incompatible with clients using versions 1-10

Changes:

   This version changes all parameter names and property names from 'authority'

   to 'publisher'.  For example, parameters named 'auths' were changed to

   'pubs'; parameters named 'authent' were changed to 'pubent' and so forth.

   In addition, the following new api functions were added to ImageInterface:

        def add_publisher(self, pub, refresh_allowed=True):

                """Add the provided publisher object to the image

                configuration."""

        def get_preferred_publisher(self):

                """Returns the preferred publisher object for the image."""

        def get_publisher(self, prefix=None, alias=None, duplicate=False):

                """Retrieves a publisher object matching the provided prefix

                (name) or alias.

                'duplicate' is an optional boolean value indicating whether

                a copy of the publisher object should be returned instead

                of the original.

                """

        def get_publishers(self, duplicate=False):

                """Returns a list of the publisher objects for the current

                image.

                'duplicate' is an optional boolean value indicating whether

                copies of the publisher objects should be returned instead

                of the originals.

                """

        def get_publisher_last_update_time(self, prefix=None, alias=None):

                """Returns a datetime object representing the last time the

                catalog for a publisher was modified or None."""

        def has_publisher(self, prefix=None, alias=None):

                """Retrieves a publisher object matching the provided prefix

                (name) or alias."""

        def remove_publisher(self, prefix=None, alias=None):

                """Removes a publisher object matching the provided prefix

                (name) or alias."""

        def set_preferred_publisher(self, prefix=None, alias=None):

                """Sets the preferred publisher for the image."""

        def update_publisher(self, pub, refresh_allowed=True):

                """Replaces an existing publisher object with the provided one

                using the _source_object_id identifier set during copy."""

        def update_publisher(self, pub, refresh_allowed=True):

                """Replaces an existing publisher object with the provided one

                using the _source_object_id identifier set during copy.

                'refresh_allowed' is an optional boolean value indicating

                whether a refresh of publisher metadata (such as its catalog)

                should be performed if transport information is changed for a

                repository, mirror, or origin.  If False, no attempt will be

                made to retrieve publisher metadata."""

        def log_operation_end(self, error=None, result=None):

                """Marks the end of an operation to be recorded in image

                history.

                'result' should be a pkg.client.history constant value

                representing the outcome of an operation.  If not provided,

                and 'error' is provided, the final result of the operation will

                be based on the class of 'error' and 'error' will be recorded

                for the current operation.  If 'result' and 'error' is not

                provided, success is assumed."""

        def log_operation_error(self, error):

                """Adds an error to the list of errors to be recorded in image

                history for the current opreation."""

        def log_operation_start(self, name):

                """Marks the start of an operation to be recorded in image

                history."""

        def parse_p5i(self, fileobj=None, location=None):

                """Reads the pkg(5) publisher json formatted data at 'location'

                or from the provided file-like object 'fileobj' and returns a

                list of tuples of the format (publisher object, pkg_names).

                pkg_names is a list of strings representing package names or

                FMRIs.  If any pkg_names not specific to a publisher were

                provided, the last tuple returned will be of the format (None,

                pkg_names).

                'fileobj' is an optional file-like object that must support a

                'read' method for retrieving data.