Skip to content

[good-first-issue] Expand the SSL / CA-bundle subsection in python/README.md #37

@hvinn

Description

@hvinn

Estimated time

15-20 minutes

Exact files to change

  • python/README.md (the existing one-line note about ONTAP_VERIFY_SSL)

Expected outcome

Replace the single-line mention with a proper subsection that documents:

  1. The default behavior (verify_ssl=False for self-signed certificates).
  2. How to enable verification via ONTAP_VERIFY_SSL=true.
  3. How to point at a custom CA bundle via REQUESTS_CA_BUNDLE, with a
    working code block.

Cross-link to docs/troubleshooting.md § SSL / TLS errors.

How to test

Render the README on GitHub and verify the new subsection appears with
all three knobs explained, includes a code block, and the anchor link to
the troubleshooting page resolves. Keep the section under 25 lines.

ONTAP concepts touched

None.

Hints / gotchas

The relevant code is in python/ontap_client.py (the verify_ssl
constructor parameter and the warning suppression near the top). No
code change needed in this issue — docs only.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions