googleapis / gapic-generator-python

Generate Python API client libraries from Protocol Buffers.
Apache License 2.0
122 stars 69 forks source link

References in square brackets are not referencing to correct UIDs #1086

Open dandhlee opened 2 years ago

dandhlee commented 2 years ago

For a lot of client library documentations generated, references in the format [name][uid] doesn't seem to point to the correct UID. For example, in Cloud KMS: [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] should be google.cloud.kms_v1.types.CryptoKeyVersion.

vchudnov-g commented 2 years ago

@dandhlee Could you provide an update on this? Thanks!

dandhlee commented 2 years ago

@vchudnov-g thanks for checking in! This still seems to be an issue. Sorry for leaving out some actual examples:

https://github.com/googleapis/python-kms/blob/main/google/cloud/kms_v1/types/service.py#L479-L494

As mentioned in the first comment, CryptoKeyVersion is cross referenced to google.cloud.kms.v1.CryptoKeyVersion, but it should be google.cloud.kms_v1.types.CryptoKeyVersion, which is found in https://github.com/googleapis/python-kms/blob/main/google/cloud/kms_v1/types/resources.py#L376.