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.

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

Prevent bad list, set, map recursion #204

Merged
merged 1 commit into from
Nov 14, 2019
Merged

Commits on Nov 14, 2019

  1. Prevent bad list, set, map recursion

    We currently don't allow a directly recursive list or set shape.
    However, we still allow for list, set, and map shapes to be
    transitively recursive unconditionally (e.g., listA -> listA is invalid,
    but listA -> set -> listA is valid). This is problematic for code
    generators in various languages that want to use parameteric types and
    standard libraries to codegen lists, sets, and maps. For example, in
    Java, a list in Smithy should be generated as a `List<X>` where X is
    the code generated member of the list. However, if the list is recursive
    onto itself, then it's impossible to generate valid code (e.g.,
    `List<List<List...`).
    
    This change requires that recursive list, set, and map shapes must have
    one or more structure or union members in their recursive path in order to
    define a valid shape. This will result in shapes that are far easier to
    generate and provides constraints that are very helpful when converting
    to other formats (for example, this might be useful in JSON schema
    conversions if we want to always inline list and set shape definitions).
    This change should not have a practical impact on models since no
    current AWS service defines an unconditionally recursive list, set,
    or map shape.
    mtdowling committed Nov 14, 2019
    Configuration menu
    Copy the full SHA
    7729b04 View commit details
    Browse the repository at this point in the history