JSii generates an incorrect type in aws_eks (Python)

[otaviomacedo]

🐛 Bug Report

Affected Languages

• TypeScript or Javascript
• Python
• Java
• .NET (C#, F#, ...)
• Go

General Information

• JSII Version: 1.39.0 (build 8af72c2), typescript 3.9.10
• Platform: Darwin Kernel Version 20.4.0: Thu Apr 22 21:46:47 PDT 2021; root:xnu-7195.101.2~1/RELEASE_X86_64 x86_64

What is the problem?

The method EndpointAccess.only_from, from the aws_eks Python module has a parameter cidr of type string. But in the source code, it is an array of string:

class EndpointAccess(
    metaclass=jsii.JSIIMeta,
    jsii_type="@aws-cdk/aws-eks.EndpointAccess",
):
    '''Endpoint access characteristics.'''

    @jsii.member(jsii_name="onlyFrom")
    def only_from(self, *cidr: builtins.str) -> "EndpointAccess":
        '''Restrict public access to specific CIDR blocks.

        If public access is disabled, this method will result in an error.

        :param cidr: CIDR blocks.
        '''
        return typing.cast("EndpointAccess", jsii.invoke(self, "onlyFrom", [*cidr]))

Original bug: aws/aws-cdk#16661

[shcherbak]

we are still suffering of this issue

[sumupitchayan]

It also looks like the documentation page shows the incorrect parameter type for cidr in TS:

I believe it should say cidr string[] — CIDR blocks under Parameters instead

[sumupitchayan]

It looks like it is also incorrect in Java, as the parameter is a String too? Java Docs

[sumupitchayan]

Closing as a non-issue.

The method EndpointAccess.only_from, from the aws_eks Python module has a parameter cidr of type string. But in the source code, it is an array of string:

This is incorrect --*cidr: builtins.str in python denotes a variadic string argument, where it accepts multiple strings (where each individual argument is still of type str).

The TS source code you linked also represents the same thing: ...cidr: string[] is a rest parameter that allows the method to accept any number of string arguments.

The docs might be slightly confusing if you haven't encountered variadic arguments before, but it is correct.

[github-actions]

This issue is now closed. Comments on closed issues are hard for our team to see.
If you need more assistance, please open a new issue that references this one.

[iliapolo]

@sumupitchayan it looks like doc generation is incorrect here, both on the documentation page and on construct hub

Can you check if jsii-docgen already has a bug filed for this? same for the documentation? (documentation page bugs should be filed in the CDK repo).

[sumupitchayan]

@sumupitchayan it looks like doc generation is incorrect here, both on the documentation page and on construct hub

Can you check if jsii-docgen already has a bug filed for this? same for the documentation? (documentation page bugs should be filed in the CDK repo).

@iliapolo yes there is an issue for exactly this in jsii-docgen, looks like you filed it 😄 #648

I guess we can still mark this issue as closed since we have one in docgen to track this bug.

[iliapolo]

@sumupitchayan we also need to file a bug in the CDK repo regarding the documentation page. Unfortunately it doesn't use jsii-docgen so we'll need to fix in two places.