Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document it is generally breaking to add/remove input trait #1519

Merged
merged 1 commit into from
Dec 1, 2022
Merged

Document it is generally breaking to add/remove input trait #1519

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/source-2.0/guides/evolving-models.rst
View file
Open in desktop
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