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

docs build failed in google-cloud-dialogflow-cx

Open parthea opened this issue 1 year ago • 0 comments

The the build log below where the docs build for google-cloud-dialogflow-cx failed with

sphinx.errors.SphinxWarning: /home/runner/work/google-cloud-python/google-cloud-python/packages/google-cloud-dialogflow-cx/google/cloud/dialogflowcx_v3beta1/types/tool.py:docstring of google.cloud.dialogflowcx_v3beta1.types.tool.Tool.TLSConfig.CACert:24:Unexpected indentation.

https://github.com/googleapis/google-cloud-python/actions/runs/7934450775/job/21665468219?pr=12314

The issue is that this docstring is poorly formatted https://github.com/googleapis/googleapis/blob/64497b3fb8db224d3817071dce8feace67b33153/google/cloud/dialogflow/cx/v3beta1/tool.proto#L417-L426

      // Required. The allowed custom CA certificates (in DER format) for
      // HTTPS verification. This overrides the default SSL trust store. If this
      // is empty or unspecified, Dialogflow will use Google's default trust
      // store to verify certificates. N.B. Make sure the HTTPS server
      // certificates are signed with "subject alt name". For instance a
      // certificate can be self-signed using the following command,
      //    openssl x509 -req -days 200 -in example.com.csr \
      //      -signkey example.com.key \
      //      -out example.com.crt \
      //      -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")

The following change appears to fix the issue

                    Required. The allowed custom CA certificates
                    (in DER format) for HTTPS verification. This
                    overrides the default SSL trust store. If this
                    is empty or unspecified, Dialogflow will use
                    Google's default trust store to verify
                    certificates. N.B. Make sure the HTTPS server
                    certificates are signed with "subject alt name".
                    For instance a certificate can be self-signed
                    using the following command:

                    ::

                        openssl x509
                        -req -days 200 -in example.com.csr \
                        -signkey example.com.key \
                            -out example.com.crt \
                            -extfile <(printf
                        "\nsubjectAltName='DNS:www.example.com'")

parthea avatar Feb 21 '24 19:02 parthea