gapic-generator-python icon indicating copy to clipboard operation
gapic-generator-python copied to clipboard

Published 20 hours ago • verified publisher icon googleapis

References in square brackets are not referencing to correct UIDs

Open dandhlee opened this issue 3 years ago • 2 comments

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.

dandhlee avatar Nov 15 '21 22:11 dandhlee

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

vchudnov-g avatar Jun 23 '22 20:06 vchudnov-g

@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.

  • kms.v1 should be kms_v1 as per directory structure
  • it's missing types in between as the directory suggests: google/cloud/kms_v1/types/resources.

dandhlee avatar Jun 24 '22 17:06 dandhlee