smithy-rs/codegen-client-test/model/rest-xml-extras.smithy

$version: "2.0"
namespace aws.protocoltests.restxml

use aws.protocols#restXml
use aws.api#service
use smithy.test#httpResponseTests
use smithy.test#httpRequestTests


/// A REST XML service that sends XML requests and responses.
@service(sdkId: "Rest XML Protocol")
@restXml
service RestXmlExtras {
    version: "2019-12-16",
    operations: [
        AttributeParty,
        XmlMapsFlattenedNestedXmlNamespace,
        EnumKeys,
        PrimitiveIntOpXml,
        ChecksumRequired,
        StringHeader,
        CreateFoo,
        RequiredMember,
        // TODO(https://github.com/smithy-lang/smithy-rs/issues/3315)
        ZeroAndFalseQueryParams,
    ]
}

/// This operation triggers a name collision between the synthetic `CreateFooInput` and `CreateFooInput`
@http(uri: "/reused-input", method: "POST")
operation CreateFoo {
    input: CreateFooRequest,
}

structure CreateFooRequest {
    input: CreateFooInput
}

structure CreateFooInput {}

@httpRequestTests([{
    id: "RestXmlSerPrimitiveIntUnset",
    protocol: "aws.protocols#restXml",
    documentation: "Primitive ints should not be serialized when they are unset",
    uri: "/primitive-document",
    method: "POST",
   body: """
        <PrimitiveIntDocument>
        </PrimitiveIntDocument>
    """,
    bodyMediaType: "application/xml",
    params: { }
}, {
       id: "RestXmlSerPrimitiveIntSetToDefault",
       protocol: "aws.protocols#restXml",
       documentation: "Primitive ints should not be serialized when they are unset",
       uri: "/primitive-document",
       method: "POST",
       body: """
       <PrimitiveIntDocument>
            <value>1</value>
       </PrimitiveIntDocument>
       """,
       bodyMediaType: "application/xml",
       params: { value: 1 }
   }])
@http(uri: "/primitive-document", method: "POST")
operation PrimitiveIntOpXml {
    input: PrimitiveIntDocument,
    output: PrimitiveIntDocument
}

structure PrimitiveIntDocument {
    value: PrimitiveInt
    @default(0)
    defaultedValue: PrimitiveInt
}

integer PrimitiveInt

structure AttributePartyInputOutput {
    @xmlAttribute
    enum: StringEnum,

    @xmlAttribute
    @xmlName("prefix:anumber")
    number: PrimitiveInt,

    @xmlAttribute
    ts: Timestamp,

    @xmlAttribute
    bool: Boolean
}

structure XmlMapEnumKeys {
    data: EnumKeyMap
}

map EnumKeyMap {
    key: StringEnum,
    value: String
}

@httpResponseTests([{
    id: "DeserEnumMap",
    code: 200,
    body: "<XmlMapEnumKeys><data><entry><key>enumvalue</key><value>hello</value></entry></data></XmlMapEnumKeys>",
    params: {
        data: { "enumvalue": "hello" }
    },
    bodyMediaType: "application/xml",
    protocol: "aws.protocols#restXml"
}])
@httpRequestTests([{
    id: "SerEnumMap",
    method: "POST",
    body: "<XmlMapEnumKeys><data><entry><key>enumvalue</key><value>hello</value></entry></data></XmlMapEnumKeys>",
    uri: "/enumkeys",
    bodyMediaType: "application/xml",
    params: {
        data: { "enumvalue": "hello" }
    },
    protocol: "aws.protocols#restXml"
}])
@http(uri: "/enumkeys", method: "POST")
operation EnumKeys {
    input: XmlMapEnumKeys,
    output: XmlMapEnumKeys
}

@httpResponseTests([{
        id: "DeserAttributes",
        code: 200,
        body: "<AttributePartyInputOutput enum=\"enumvalue\" prefix:anumber=\"5\" ts=\"1985-04-12T23:20:50.00Z\" bool=\"true\"/>",
        params: {
            enum: "enumvalue",
            number: 5,
            ts: 482196050,
            bool: true
        },
        protocol: "aws.protocols#restXml"

}])
@http(uri: "/AttributeParty", method: "POST")
operation AttributeParty {
    output: AttributePartyInputOutput
}

@httpResponseTests([{
        id: "DeserFlatNamespaceMaps",
        code: 200,
        body: "<XmlMapsFlattenedNestedXmlNamespaceInputOutput xmlns=\"http://aoo.com\"><myMap><yek xmlns=\"http://doo.com\">map2</yek><eulav xmlns=\"http://eoo.com\"><entry><K xmlns=\"http://goo.com\">third</K><V xmlns=\"http://hoo.com\">plz</V></entry><entry><K xmlns=\"http://goo.com\">fourth</K><V xmlns=\"http://hoo.com\">onegai</V></entry></eulav></myMap><myMap><yek xmlns=\"http://doo.com\">map1</yek><eulav xmlns=\"http://eoo.com\"><entry><K xmlns=\"http://goo.com\">second</K><V xmlns=\"http://hoo.com\">konnichiwa</V></entry><entry><K xmlns=\"http://goo.com\">first</K><V xmlns=\"http://hoo.com\">hi</V></entry></eulav></myMap></XmlMapsFlattenedNestedXmlNamespaceInput>",
        params: {
            "myMap": {
                "map2": {"fourth": "onegai", "third": "plz" },
                "map1": {"second": "konnichiwa", "first": "hi" }
            }
        },
        protocol: "aws.protocols#restXml"
}])
@http(uri: "/XmlMapsFlattenedNestedXmlNamespace", method: "POST")
operation XmlMapsFlattenedNestedXmlNamespace {
    input: XmlMapsFlattenedNestedXmlNamespaceInputOutput,
    output: XmlMapsFlattenedNestedXmlNamespaceInputOutput
}

@xmlNamespace(uri: "http://aoo.com")
structure XmlMapsFlattenedNestedXmlNamespaceInputOutput {
    @xmlNamespace(uri: "http://boo.com")
    @xmlFlattened
    myMap: XmlMapsNestedNamespaceInputOutputMap,
}

@xmlNamespace(uri: "http://coo.com")
map XmlMapsNestedNamespaceInputOutputMap {
    @xmlNamespace(uri: "http://doo.com")
    @xmlName("yek")
    key: String,

    @xmlNamespace(uri: "http://eoo.com")
    @xmlName("eulav")
    value: XmlMapsNestedNestedNamespaceInputOutputMap
}

@xmlNamespace(uri: "http://foo.com")
map XmlMapsNestedNestedNamespaceInputOutputMap {
    @xmlNamespace(uri: "http://goo.com")
    @xmlName("K")
    key: String,

    @xmlNamespace(uri: "http://hoo.com")
    @xmlName("V")
    value: String
}

@httpRequestTests([{
    id: "ChecksumRequiredHeader",
    method: "POST",
    body: "<ChecksumRequiredInput><field>hello</field></ChecksumRequiredInput>",
    uri: "/ChecksumRequired",
    bodyMediaType: "application/xml",
    params: {
        field: "hello"
    },
    headers: { "Content-Md5": "JAJAqYA61wMhATGeQqRcMQ==" },
    protocol: "aws.protocols#restXml"
}])
@httpChecksumRequired
@http(uri: "/ChecksumRequired", method: "POST")
operation ChecksumRequired {
    input: ChecksumRequiredInput
}

structure ChecksumRequiredInput {
    field: String
}


@httpResponseTests([{
    id: "DeserHeaderStringCommas",
    code: 200,
    documentation: """
    Regression test for https://github.com/awslabs/aws-sdk-rust/issues/122
    where `,` was eagerly used to split fields in cases where the input was not
    a list.
    """,
    body: "",
    headers: { "x-field": "a,b,c" },
    params: {
        field: "a,b,c"
    },
    protocol: "aws.protocols#restXml"
}])
@http(uri: "/StringHeader", method: "POST")
operation StringHeader {
    output: StringHeaderOutput
}

structure StringHeaderOutput {
    @httpHeader("x-field")
    field: String,

    @httpHeader("x-enum")
    enumHeader: StringEnum,
}

/// This operation tests that we can serialize `required` members.
@http(uri: "/required-member", method: "GET")
operation RequiredMember {
    input: RequiredMemberInputOutput
    output: RequiredMemberInputOutput
}

structure RequiredMemberInputOutput {
    @required
    requiredString: String
}

@httpRequestTests([
    {
        id: "RestXmlZeroAndFalseQueryParamsAreSerialized"
        protocol: restXml
        code: 200
        method: "GET"
        uri: "/ZeroAndFalseQueryParams"
        body: ""
        queryParams: [
            "Zero=0",
            "False=false"
        ]
        params: {
            zeroValue: 0
            falseValue: false
        }
    }
])
@http(uri: "/ZeroAndFalseQueryParams", method: "GET")
operation ZeroAndFalseQueryParams {
    input := {
        @httpQuery("Zero")
        zeroValue: Integer

        @httpQuery("False")
        falseValue: Boolean
    }
}