Unverified Commit 87d6e978 authored by Dj's avatar Dj Committed by GitHub
Browse files

Update Pokémon models to Smithy IDL v2 (#3494) 

## Motivation and Context
Resolves [issue
2523](https://github.com/smithy-lang/smithy-rs/issues/2523) to migrate
to Smithy IDL v2

## Description

I followed the [Smithy Migration
Guide](https://smithy.io/2.0/guides/model-translations/migrating-idl-1-to-2.html)
to convert the models. One change was that by moving the inputs/outputs
into the operation, it did result in a renaming of the CapturePokemon
structures. They went from CapturePokemonEvents(Input|Output) to
CapturePokemon(Input|Output). From a brief look at the commit history,
it seems the API used to be named different and the inputs/outputs
weren't renamed at that time. So I decided to have them match the normal
naming convention (it didn't seem to break any tests).

## Testing
As this was my first commit, I ran almost every target I could discover,
but I think the key ones were:
* codegen-server-test
* codegen-client-test
* examples: `make test`

## Checklist
<!--- If a checkbox below is not applicable, then please DELETE it
rather than leaving it unchecked -->
- [ ] I have updated `CHANGELOG.next.toml` if I made changes to the
smithy-rs codegen or runtime crates
- [ ] I have updated `CHANGELOG.next.toml` if I made changes to the AWS
SDK, generated SDK code, or SDK runtime crates

----

_By submitting this pull request, I confirm that you can use, modify,
copy, and redistribute this contribution, under the terms of your
choice._
parent 23cdff1d

codegen-core/common-test-models/pokemon-awsjson.smithy

+32 −34
Original line number Diff line number Diff line 
$version: "1.0"

$version: "2"



// TODO(https://github.com/smithy-lang/smithy-rs/issues/2215)

// This is a temporary model to test AwsJson 1.0 with @streaming.
@@ -17,80 +17,78 @@ use com.aws.example#CheckHealth 
@title("Pokémon Service")

@awsJson1_0

service PokemonService {

    version: "2021-12-01",

    version: "2024-03-18"

    operations: [

        GetServerStatistics,

        DoNothing,

        CapturePokemon,

        GetServerStatistics

        DoNothing

        CapturePokemon

        CheckHealth

    ],

    ]

}



/// Capture Pokémons via event streams.

operation CapturePokemon {

    input: CapturePokemonEventsInput,

    output: CapturePokemonEventsOutput,

    errors: [UnsupportedRegionError, ThrottlingError, ValidationException]

    input := {

        events: AttemptCapturingPokemonEvent

    }



@input

structure CapturePokemonEventsInput {

    events: AttemptCapturingPokemonEvent,

    output := {

        events: CapturePokemonEvents

    }



@output

structure CapturePokemonEventsOutput {

    events: CapturePokemonEvents,

    errors: [

        UnsupportedRegionError

        ThrottlingError

        ValidationException

    ]

}



@streaming

union AttemptCapturingPokemonEvent {

    event: CapturingEvent,

    masterball_unsuccessful: MasterBallUnsuccessful,

    event: CapturingEvent

    masterball_unsuccessful: MasterBallUnsuccessful

}



structure CapturingEvent {

    @eventPayload

    payload: CapturingPayload,

    payload: CapturingPayload

}



structure CapturingPayload {

    name: String,

    pokeball: String,

    name: String

    pokeball: String

}



@streaming

union CapturePokemonEvents {

    event: CaptureEvent,

    invalid_pokeball: InvalidPokeballError,

    throttlingError: ThrottlingError,

    event: CaptureEvent

    invalid_pokeball: InvalidPokeballError

    throttlingError: ThrottlingError

}



structure CaptureEvent {

    @eventHeader

    name: String,

    name: String

    @eventHeader

    captured: Boolean,

    captured: Boolean

    @eventHeader

    shiny: Boolean,

    shiny: Boolean

    @eventPayload

    pokedex_update: Blob,

    pokedex_update: Blob

}



@error("server")

structure UnsupportedRegionError {

    @required

    region: String,

    region: String

}



@error("client")

structure InvalidPokeballError {

    @required

    pokeball: String,

    pokeball: String

}

@error("server")

structure MasterBallUnsuccessful {

    message: String,

    message: String

}



@error("client")

codegen-core/common-test-models/pokemon-common.smithy

+41 −69
Original line number Diff line number Diff line 
$version: "1.0"

$version: "2"



namespace com.aws.example
@@ -9,53 +9,44 @@ use smithy.framework#ValidationException 
resource PokemonSpecies {

    identifiers: {

        name: String

    },

    read: GetPokemonSpecies,

    }

    read: GetPokemonSpecies

}



/// Retrieve information about a Pokémon species.

@readonly

@http(uri: "/pokemon-species/{name}", method: "GET")

operation GetPokemonSpecies {

    input: GetPokemonSpeciesInput,

    output: GetPokemonSpeciesOutput,

    errors: [ResourceNotFoundException, ValidationException],

}



@input

structure GetPokemonSpeciesInput {

    input := {

        @required

        @httpLabel

        name: String

    }



@output

structure GetPokemonSpeciesOutput {

    output := {

        /// The name for this resource.

        @required

    name: String,

        name: String



        /// A list of flavor text entries for this Pokémon species.

        @required

        flavorTextEntries: FlavorTextEntries

    }

    errors: [

        ResourceNotFoundException

        ValidationException

    ]

}



/// Retrieve HTTP server statistiscs, such as calls count.

@readonly

@http(uri: "/stats", method: "GET")

operation GetServerStatistics {

    input: GetServerStatisticsInput,

    output: GetServerStatisticsOutput,

}



@input

structure GetServerStatisticsInput { }



@output

structure GetServerStatisticsOutput {

    input := {}

    output := {

        /// The number of calls executed by the server.

        @required

    calls_count: Long,

        calls_count: Long

    }

}



list FlavorTextEntries {
@@ -65,52 +56,33 @@ list FlavorTextEntries { 
structure FlavorText {

    /// The localized flavor text for an API resource in a specific language.

    @required

    flavorText: String,

    flavorText: String



    /// The language this name is in.

    @required

    language: Language,

    language: Language

}



/// Supported languages for FlavorText entries.

@enum([

    {

        name: "ENGLISH",

        value: "en",

        documentation: "American English.",

    },

    {

        name: "SPANISH",

        value: "es",

        documentation: "Español.",

    },

    {

        name: "ITALIAN",

        value: "it",

        documentation: "Italiano.",

    },

    {

        name: "JAPANESE",

        value: "jp",

        documentation: "日本語。",

    },

])

string Language

enum Language {

    /// American English.

    ENGLISH = "en"

    /// Español.

    SPANISH = "es"

    /// Italiano.

    ITALIAN = "it"

    /// 日本語。

    JAPANESE = "jp"

}



/// DoNothing operation, used to stress test the framework.

@readonly

@http(uri: "/do-nothing", method: "GET")

operation DoNothing {

    input: DoNothingInput,

    output: DoNothingOutput,

    input := {}

    output := {}

}



@input

structure DoNothingInput { }



@output

structure DoNothingOutput { }



/// Health check operation, to check the service is up

/// Not yet a deep check

@readonly
@@ -122,5 +94,5 @@ operation CheckHealth { 
@httpError(404)

structure ResourceNotFoundException {

    @required

    message: String,

    message: String

}

codegen-core/common-test-models/pokemon.smithy

+67 −74
Original line number Diff line number Diff line 
$version: "1.0"

$version: "2"



namespace com.aws.example
@@ -14,32 +14,49 @@ use com.aws.example#ResourceNotFoundException 
@title("Pokémon Service")

@restJson1

service PokemonService {

    version: "2021-12-01",

    resources: [PokemonSpecies, Storage],

    version: "2024-03-18"

    resources: [

        PokemonSpecies

        Storage

    ]

    operations: [

        GetServerStatistics,

        DoNothing,

        CapturePokemon,

        CheckHealth,

        GetServerStatistics

        DoNothing

        CapturePokemon

        CheckHealth

        StreamPokemonRadio

    ],

    ]

}



/// A users current Pokémon storage.

resource Storage {

    identifiers: {

        user: String

    },

    read: GetStorage,

    }

    read: GetStorage

}



/// Retrieve information about your Pokédex.

@readonly

@http(uri: "/pokedex/{user}", method: "GET")

operation GetStorage {

    input: GetStorageInput,

    output: GetStorageOutput,

    errors: [ResourceNotFoundException, StorageAccessNotAuthorized, ValidationException],

    input := @sensitive @documentation("A request to access Pokémon storage.") {

        @required

        @httpLabel

        user: String

        @required

        @httpHeader("passcode")

        passcode: String

    }

    output := @documentation("Contents of the Pokémon storage.") {

        @required

        collection: SpeciesCollection

    }

    errors: [

        ResourceNotFoundException

        StorageAccessNotAuthorized

        ValidationException

    ]

}



/// Not authorized to access Pokémon storage.
@@ -47,102 +64,81 @@ operation GetStorage { 
@httpError(401)

structure StorageAccessNotAuthorized {}



/// A request to access Pokémon storage.

@input

@sensitive

structure GetStorageInput {

    @required

    @httpLabel

    user: String,

    @required

    @httpHeader("passcode")

    passcode: String,

}



/// A list of Pokémon species.

list SpeciesCollection {

    member: String

}



/// Contents of the Pokémon storage.

@output

structure GetStorageOutput {

    @required

    collection: SpeciesCollection

}



/// Capture Pokémons via event streams.

@http(uri: "/capture-pokemon-event/{region}", method: "POST")

operation CapturePokemon {

    input: CapturePokemonEventsInput,

    output: CapturePokemonEventsOutput,

    errors: [UnsupportedRegionError, ThrottlingError, ValidationException]

}



@input

structure CapturePokemonEventsInput {

    input := {

        @httpPayload

    events: AttemptCapturingPokemonEvent,

        events: AttemptCapturingPokemonEvent



        @httpLabel

        @required

    region: String,

        region: String

    }



@output

structure CapturePokemonEventsOutput {

    output := {

        @httpPayload

    events: CapturePokemonEvents,

        events: CapturePokemonEvents

    }

    errors: [

        UnsupportedRegionError

        ThrottlingError

        ValidationException

    ]

}



@streaming

union AttemptCapturingPokemonEvent {

    event: CapturingEvent,

    masterball_unsuccessful: MasterBallUnsuccessful,

    event: CapturingEvent

    masterball_unsuccessful: MasterBallUnsuccessful

}



structure CapturingEvent {

    @eventPayload

    payload: CapturingPayload,

    payload: CapturingPayload

}



structure CapturingPayload {

    name: String,

    pokeball: String,

structure CapturingPayload for PokemonSpecies {

    $name

    pokeball: String

}



@streaming

union CapturePokemonEvents {

    event: CaptureEvent,

    invalid_pokeball: InvalidPokeballError,

    throttlingError: ThrottlingError,

    event: CaptureEvent

    invalid_pokeball: InvalidPokeballError

    throttlingError: ThrottlingError

}



structure CaptureEvent {

    @eventHeader

    name: String,

    name: String

    @eventHeader

    captured: Boolean,

    captured: Boolean

    @eventHeader

    shiny: Boolean,

    shiny: Boolean

    @eventPayload

    pokedex_update: Blob,

    pokedex_update: Blob

}



@error("server")

structure UnsupportedRegionError {

    @required

    region: String,

    region: String

}



@error("client")

structure InvalidPokeballError {

    @required

    pokeball: String,

    pokeball: String

}

@error("server")

structure MasterBallUnsuccessful {

    message: String,

    message: String

}



@error("client")
@@ -152,13 +148,10 @@ structure ThrottlingError {} 
@readonly

@http(uri: "/radio", method: "GET")

operation StreamPokemonRadio {

    output: StreamPokemonRadioOutput

}



@output

structure StreamPokemonRadioOutput {

    output := {

        @httpPayload

    data: StreamingBlob

        data: StreamingBlob = ""

    }

}



@streaming