Skip to content

Commit

Permalink
Document it is generally breaking to add/remove input trait
Browse files Browse the repository at this point in the history
Closes #1478
  • Loading branch information
mtdowling committed Dec 1, 2022
1 parent 10fd0d1 commit d440e80
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/source-2.0/guides/evolving-models.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,16 @@ The following changes to structure shapes are backward-compatible:
#. Adding the :ref:`required-trait` to a member of a structure if the member
is marked as ``clientOptional`` or the structure is marked with the ``input``
trait.
#. Adding or removing the :ref:`input-trait` from a structure is generally
backward incompatible.

.. note::

Many code generators automatically create dedicated synthetic input
structures for each operation and treat the synthetic structure
as if it is marked with the ``@input`` trait. Code generators that do
this MAY ignore backward incompatible changes around adding or removing
the ``@input`` trait.

The following changes to a structure are not backward-compatible:

Expand Down

0 comments on commit d440e80

Please sign in to comment.