*********
Changelog
*********

v103
----

 * General

   * Added the ability to utilize credential information during
     :ref:`substitution <substitution>`.
   * Fixed an issue where the Credential Timeout warning would
     erroneously trigger against a valid timeout
   * Fixed an issue where substitution could alter the Snippet Argument
     when there was no match
   * Fixed an issue where custom headers were not being honored
     during OAuth2 requests
   * Fixed an issue where Token Authentication would not honor proxy settings
   * Fixed an issue where ``SOAP/XML`` Credentials required
     ``Embed Value [%1]`` to be an authenticator
   * (SL1 12.3+) Updated the credential, ``Low-code tools: rest v103 Credential``,
      to perform ``%D`` and ``%N`` substitution on the following fields:

     * URL
     * Token Retrieval Endpoint

 * Steps

   * Added a step for converting a :ref:`dict to list <steps-dict-to-list>`
     which can enable easier :ref:`JMESPath <steps-jmespath>` queries
   * Fixed a performance issue when using :ref:`JC <steps-jc>`


v102
----

 * API Breaks

  * Updated Agent configuration generation to use standard parameters
  * Removed ``AgentConfigGenerator`` from the API
  * Added ``ProtocolConfig`` to the API
  * Removed ``get_step_logger`` from the API in favor of standard parameters

 * Steps

  * Added a step for collecting :ref:`JMX <steps-jmx>` data
  * Added a step for collecting :ref:`PowerShell <steps-powershell>` data
  * Added a step for collecting :ref:`WinRM <steps-winrm>` data
  * Fixed an issue where :ref:`http <steps-http>` would use HTTP for HTTPS proxies
  * Fixed an issue where :ref:`cacher_writer <steps-cache-writer>` was unable to
    delete expired entries
  * Fixed an issue where incorrect messages were logged to Device Logs
    when raising ``silo.low_code.DeviceError``.


v101
----

 * Steps

   * Fixed an issue where using the step, ``cache_writer``, could cause
     an OutOfMemoryException.

 * Custom Step Development

   * Fixed an issue in ``silo.low_code.read_step_cache`` that did not
     properly cache a result to Memory which created a new instance
     every time it ran.

 * Snippet Framework App Type (SL1 12.3)

   * Resolved index assignment bug
   * Resolved issue with host/ip substitution in credentials

v100
----

 * General

   * Increased the performance by removing similar calls for all
     steps
   * Updated substitution to use standard Python substitution. Refer
     to :ref:`Substitution <substitution>` for additional information.
   * Custom substitution can now be functions which request
     any out-of-the-box substitution variables. Refer
     to :ref:`Substitution <substitution>` for additional information.
   * Deprecated ``<>`` for substitution. Use ``${}`` instead.
   * Implemented the ability for a Python wheel to automatically
     register with the Snippet Framework. See
     :ref:`Creating a wheel <sf_auto_reg>` for more information.
   * Fixed an issue where Oauth2 ResourceOwner would not correctly
     reference the field ``Additional body Parameters`` in
     ``Low-code tools: rest Credential``

 * Steps

   * Added the step, :ref:`jc <steps-jc>`, that provides general
     parsing.
   * Added the step, :ref:`snmp <steps-snmp>`, that can request
     data through SNMP.
   * Renamed the step, ``paginator_offset_limit``
     to ``paginator_offset``.
   * Updated the step, ``paginator_offset``, to allow `limit` and `offset`
     to be altered to meet the needs of the API.
   * Updated the step, ``http``, to specify how a token should be
     refreshed during the collection cycle. Refer to
     :ref:`Authentication <authentication>` for more information.
   * Deprecated the step, ``jsonpath``. Use ``jmespath``
     instead as it is more performant.
   * Deprecated the step, ``simple_key``. Use ``jmespath``
     instead as it utilizes the same syntax.
   * Deprecated the step, ``stringint``.
   * Deprecated the step, ``stringfloat``.
   * Fixed an issue with the step ``http`` where a URL could be
     created incorrectly.
   * Fixed an issue where the ``ssh`` requestor required a password
     or PEM key when aligning to an agent-based device.

 * Custom Step Development

   * Added the following Standard Parameters

     * ``step_args``
     * ``collection``
     * ``credential``
     * ``debug``
     * ``metadata``
     * ``request_id``
     * ``set_metadata``

   * Updated ``Requestor`` custom step development to use the
     Standard Parameters
   * Updated ``Cacher`` custom step development to use the
     Standard Parameters
   * Updated ``Syntax`` custom step development to require
     a ``:`` to as the step name identifier
   * Created a new registration for ``RequestMoreData``
   * Added the flag to specify if a step is ``mutable`` which
     affects the de-duplication process. Refer to
     :ref:`Mutable Steps <mutable-step>` for more information.
   * Deprecated the Standard Parameter, ``result_container``
   * Deprecated the Standard Parameter, ``action_number``
   * Deprecated the Standard Parameter, ``action_arg``
   * Deprecated Processors to specify ``type`` for ``RequestMoreData``
     step. Use ``register_rmd`` instead.
   * Deprecated TypeChecking
   * Deprecated ``silo.low_code.RequestMaker``
   * Deprecated the ability for a Requestor to request the parameter
     ``request``
   * Deprecated the ability for a Cacher that does not consume
     Standard Parameters


 * Low-code tools: rest Credential

   * Updated the `Low-code tools: rest credential` to include
     `AuthOverride` which allows for custom authenticators.
   * Fixed an issue with the `Low-code tools: rest` credential
     where additional header fields were not always present.
   * Added a new field to specify the token refresh strategy
     as either key based (dynamic) or time based (static).