.. _ref_release_notes:

Release notes
#############

This document contains the release notes for the project.

See `CHANGELOG.md <https://github.com/ansys/openapi-common/blob/main/CHANGELOG.md>`_ for release notes for v2.3.0 and earlier.

.. vale off

.. towncrier release notes start

`2.4.0 <https://github.com/ansys/openapi-common/releases/tag/v2.4.0>`_ - March 04, 2026
=======================================================================================

.. tab-set::


  .. tab-item:: Fixed

    .. list-table::
        :header-rows: 0
        :widths: auto

        * - Improve session management when creating OIDC clients
          - `#849 <https://github.com/ansys/openapi-common/pull/849>`_

        * - Replace asserts with instance checks during deserialization
          - `#910 <https://github.com/ansys/openapi-common/pull/910>`_


  .. tab-item:: Dependencies

    .. list-table::
        :header-rows: 0
        :widths: auto

        * - Prepare for 2.4.0rc0 release
          - `#981 <https://github.com/ansys/openapi-common/pull/981>`_

        * - Prepare 2.4.0 release
          - `#986 <https://github.com/ansys/openapi-common/pull/986>`_


  .. tab-item:: Miscellaneous

    .. list-table::
        :header-rows: 0
        :widths: auto

        * - Update lock file
          - `#830 <https://github.com/ansys/openapi-common/pull/830>`_

        * - Fix changelog fragments
          - `#979 <https://github.com/ansys/openapi-common/pull/979>`_


  .. tab-item:: Documentation

    .. list-table::
        :header-rows: 0
        :widths: auto

        * - Improve HTTPS CA documentation
          - `#792 <https://github.com/ansys/openapi-common/pull/792>`_

        * - Include changelog in documentation
          - `#800 <https://github.com/ansys/openapi-common/pull/800>`_

        * - Fix CA bundle example in User Guide
          - `#938 <https://github.com/ansys/openapi-common/pull/938>`_

        * - Rename fix changelog fragments
          - `#984 <https://github.com/ansys/openapi-common/pull/984>`_


  .. tab-item:: Maintenance

    .. list-table::
        :header-rows: 0
        :widths: auto

        * - Update CHANGELOG for v2.3.0
          - `#783 <https://github.com/ansys/openapi-common/pull/783>`_

        * - Generate provenance attestations
          - `#791 <https://github.com/ansys/openapi-common/pull/791>`_

        * - Use commit SHA to pin action versions
          - `#795 <https://github.com/ansys/openapi-common/pull/795>`_

        * - Bump version to 2.4.0
          - `#796 <https://github.com/ansys/openapi-common/pull/796>`_

        * - Set more restrictive workflow permissions
          - `#801 <https://github.com/ansys/openapi-common/pull/801>`_

        * - Add security.md file
          - `#831 <https://github.com/ansys/openapi-common/pull/831>`_

        * - Bump version to v2.4.0.dev0
          - `#834 <https://github.com/ansys/openapi-common/pull/834>`_

        * - Add write permissions for documentation publish jobs
          - `#835 <https://github.com/ansys/openapi-common/pull/835>`_

        * - Update CHANGELOG for v2.3.1
          - `#879 <https://github.com/ansys/openapi-common/pull/879>`_

        * - Update CHANGELOG for v2.3.2
          - `#882 <https://github.com/ansys/openapi-common/pull/882>`_

        * - Add workflow to check dependencies and action security
          - `#888 <https://github.com/ansys/openapi-common/pull/888>`_

        * - Implement zizmor recommendations
          - `#890 <https://github.com/ansys/openapi-common/pull/890>`_

        * - Fix dependabot auto-approve
          - `#899 <https://github.com/ansys/openapi-common/pull/899>`_

        * - Update missing or outdated files
          - `#920 <https://github.com/ansys/openapi-common/pull/920>`_

        * - Migrate from poetry to uv
          - `#936 <https://github.com/ansys/openapi-common/pull/936>`_

        * - Zizmor - Fix CI warnings with template injection and concurrency
          - `#939 <https://github.com/ansys/openapi-common/pull/939>`_

        * - Update Quoting in Dependabot Approval Workflow
          - `#942 <https://github.com/ansys/openapi-common/pull/942>`_

        * - Remove incorrect semver-patch-days entry in dependabot.yml
          - `#945 <https://github.com/ansys/openapi-common/pull/945>`_

        * - Remove unneeded dependabot_approve step
          - `#948 <https://github.com/ansys/openapi-common/pull/948>`_

        * - Use uv ecosystem in dependabot config
          - `#951 <https://github.com/ansys/openapi-common/pull/951>`_

        * - Add Python 3.14 support to CI/CD
          - `#955 <https://github.com/ansys/openapi-common/pull/955>`_

        * - Standardize uv usage
          - `#962 <https://github.com/ansys/openapi-common/pull/962>`_

        * - Update ansys/actions to v10.2.7
          - `#980 <https://github.com/ansys/openapi-common/pull/980>`_


.. vale on