Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs build failed in google-cloud-dialogflow-cx #1952

Open
parthea opened this issue Feb 21, 2024 · 0 comments
Open

docs build failed in google-cloud-dialogflow-cx #1952

parthea opened this issue Feb 21, 2024 · 0 comments
Labels
type: cleanup An internal cleanup or hygiene concern.

Comments

@parthea
Copy link
Contributor

parthea commented Feb 21, 2024

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 parthea added the type: cleanup An internal cleanup or hygiene concern. label Feb 21, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Feb 21, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Mar 4, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Mar 5, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Mar 27, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue May 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: cleanup An internal cleanup or hygiene concern.
Projects
None yet
Development

No branches or pull requests

1 participant