azure-http-specs, validate orphan model serializable #2318
Conversation
| @global.Azure.ClientGenerator.Core.convenientAPI(false) | ||
| @route("/orphanModelSerializable") | ||
| @put | ||
| op orphanModelSerializable(@body body: unknown): NoContentResponse; |
There was a problem hiding this comment.
I use the unknown to avoid ref the OrphanModel.
Let me know any language that having difficulty to serialize a OrphanModel model into the request body of this op.
|
All changed packages have been documented.
Show changes
|
| model OrphanModel { | ||
| @global.Azure.ClientGenerator.Core.clientName("modelName") | ||
| name: string; | ||
|
|
||
| @encodedName("application/json", "desc") | ||
| description: string; | ||
| } |
There was a problem hiding this comment.
I've updated the model a little, to mix typespec name, client name, encoded name. And we expect SDK find the correct name for JSON serialization (it should be encoded name of application/json, if not available then typespec name).
|
You can try these changes here
|
| } | ||
|
|
||
| @doc("Not used anywhere, but access is override to public so still need to be generated and exported with serialization.") | ||
| @global.Azure.ClientGenerator.Core.usage(global.Azure.ClientGenerator.Core.Usage.input) | ||
| @global.Azure.ClientGenerator.Core.access(global.Azure.ClientGenerator.Core.Access.public) | ||
| model OrphanModel { | ||
| @global.Azure.ClientGenerator.Core.clientName("modelName") |
There was a problem hiding this comment.
i think we do need to have a way to indicate how to serialize an orphan model. it seems weird that i have an orphan model that one property has a client name.
There was a problem hiding this comment.
@clientName appears expected for me. This case maybe a bit uncommon that here rename is non-scoped, but I assume it be pretty common in scoped case that one language want one name, while other language want another.
And the eventgrid lib does exact this with @clientName on different SDKs.
https://github.com/Azure/azure-rest-api-specs/blob/main/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideCsharp.tsp
https://github.com/Azure/azure-rest-api-specs/blob/main/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideJava.tsp
But yes, we may need some way to say default to JSON, either argument to TCGC, option to emitter, or param to @service
weidongxu-microsoft
requested review from
iscai-msft,
lmazuel,
m-nash,
joheredi,
srnagar,
jhendrixMSFT,
bterlson,
markcowl,
allenjzhang and
timotheeguerin
as code owners
As discussed, we want to verify that an orphan model is by default serializable as JSON.
Since there were an existing test on orphan model, I just enhanced it and added an operation to verify the serialization.