A humble wishlist for C# SDK generation

[JasonLandbridge]

Speakeasy SDK feature improvements:

NOTE: These are the settings that were used: gen.yaml

1. Give every request/response object the same interface with shared properties, which can then be used to write extension methods for more easily.

   • Given these examples: #1, #2, #3. They all share the same properties, these could all inherit from something like an IBaseResponse interface. I'm writing some wrappers/extension methods for converting responses and I have to rely on reflection as there is no common parent for all responses/requests.

2. Use System.Text.Json instead of the outdated Newtonsoft.Json.

   • From my limited assessment of the response/request objects that are generated, it seems that System.Text.Json should work fine and is near feature parity anyway: System.Text.Json: Migrate from Newtonsoft

3. Provide a typesafe way for every endpoint to show what exceptions are expected based on the possible responses in the spec.

   • Currently this information is lost during the SDK generation and there is no way for the caller to know which exceptions are expected without diving into the source code. Even just a method summary would be a big improvement. Example. Ideally this would be a type-safe way, which is easier said then done.

4. Provide an option to disable throwing exceptions when a request fails (non-success status code) and instead return the HttpResponseMessage.

   • I honestly don't understand this design decision to throw all these exceptions when there is a valid HttpResponseMessage that can be returned, inside the response, when there is a non-success status code. Example

5. C# SDK generation is missing the header for "Accept: application/json", which is present in Typescript SDK but missing everywhere in the C# SDK, Example. This is when the only expected response for an endpoint is "application/json"

6. Please add a URL link to the changelog when there is an update in the CLI, I honestly couldn't find it by going through the website
   

I can think of some more and I am happy to provide more information when needed.

Cheers!