Types are too loosely defined to be useful

[FraserMuir]

• Package Name: @azure/arm-securityinsight
• Package Version: 1.0.0-beta.5
• Operating system: Windows 10
• [x] nodejs
  • version: 18.12.1
• [ ] browser
  • name/version:
• [x] typescript
  • version: 4.9.4
• Is the bug related to documentation in
  • [ ] README.md
  • [ ] source code documentation
  • [ ] SDK API docs on https://docs.microsoft.com

Describe the bug When using the declared types within the @azure/arm-securityinsight every property is optional and hence could be undefined, even in cases where it is obvious the underlying service (Sentinel in this case) will definitely return required properties (IDs for example)

To Reproduce Steps to reproduce the behavior:

1. Get a typed response from any method within the Security Insights client.
2. Access a properly that surely must be required in Sentinel (the id of the incident)
3. Try to do anything with the id, and you must first check that it is defined, since it's type is string | undefined

Expected behavior Properties like IDs (and many others) will obviously always be present of their respective entities. These should not be optional properties on their declared types.

Screenshots

Additional context I don't believe it is acceptable to expect the end user of the types exported from this package to conditionally access all properties on Incident objects (also applied to most others such as Entity, Alert, Comment) in cases where these properties must surely not actually be optional in practise.

[xirzec]

@qiaozha looks like a bad swagger input, maybe we can reach out to the service team or do a few transforms?

[qiaozha]

I will send an email to service team about this.

[FraserMuir]

any update on this?

[qiaozha]

I think this is a limitation of the current design. I will update this issue when we have a better design to resolve this issue. Please note that, it will probably take a long time to support it.