doc: suppression examples would be better using List[NagPackSuppression]

[mrgum]

Describe your issue?

The suppression examples use List[dict] rather than List[NagPackSuppression]

For example "Example 1) Default Construct" has

NagSuppressions.add_resource_suppressions(test, [id="AwsSolutions-EC23", reason="lorem ipsum"])

when

NagSuppressions.add_resource_suppressions(test, [NagPackSuppression(id="AwsSolutions-EC23", reason="lorem ipsum")])

would seem to be better

I'd be happy to spend the time changing these if its accepted

[dontirun]

Hi! Can you provide a link to the documentation that you're referencing?

If you're referencing the python documentation, it is auto-converted from the TypeScript example documentation using jsii and may contain errors

[mrgum]

Hello

https://constructs.dev/packages/cdk-nag/v/2.4.39?lang=python#suppressing-a-rule

But the typescript version shows the same issue
https://constructs.dev/packages/cdk-nag/v/2.4.39?lang=typescript#suppressing-a-rule

No mention of NagPackSuppression

[dontirun]

That is a valid example for TypeScript since the NagPackSuppression type is inferred. We would have to look to see if there are any ways to influence the python documentation generated by jsii.

[mrgum]

Would asserting the type help the generation?
NagSuppressions.addResourceSuppressions(test, [
{
id: 'AwsSolutions-EC23', reason: 'lorem ipsum'
},
]);

[dontirun]

I think we would need to do something like this aws/jsii#826

[github-actions]

This issue is now marked as stale because it hasn't seen activity for a while. Add a comment or it will be closed soon.

[github-actions]

Closing this issue as it hasn't seen activity for a while. Please add a comment @mentioning a maintainer to reopen.