contract_tests: contract_create_read_success and primaryIdentifiers in responses

When a customer wants to create a our resource, he sends a request like so:

{
    "ourObj": {
        "someProp": "someValue"
    }
}

And our API, upon successful creation, will return the following:

{
    "ourObj": {
        "someProp": "someValue",
        "id": "ourJustGeneratedObjId"
    }
}

It seems that there is no way at all to pass the contract-tests with this schema. Passing a hard-coded value for ourObj.id does not make sense, as the delete test will fail.

I’ve worked around the contract_create_delete failure by copying ourObj.id to another property in the schema:

{
    "CfnId": "ourJustGeneratedObjId",
    "ourObj": {
        "someProp": "someValue",
        "id": "ourJustGeneratedObjId"
     }
}

CfnId is set as the primaryIdentifier.

This way, the model sent in the request is returned back in the response - none have the ourObj.id. However, our customers may be relying on the existence of this id inside ourObj.

What can be done about this?

[benbridts]

Can you share a snippet of your schema?

Is your issue that id is a nested property, or that you need it to be readonly?

[SHxKM]

Thanks @benbridts.

I’m keeping this open as nested primaryIdentifiers seem to fail the tests, which shouldn’t happen.