BasPH commented on a change in pull request #8257: [docs-only] Simplify
language re roll-your-own secrets backend
URL: https://github.com/apache/airflow/pull/8257#discussion_r407155205
##########
File path: docs/howto/use-alternative-secrets-backend.rst
##########
@@ -308,19 +308,14 @@ of the connection object.
Roll your own secrets backend
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-A secrets backend is a subclass of
:py:class:`airflow.secrets.BaseSecretsBackend`, and just has to implement the
-:py:meth:`~airflow.secrets.BaseSecretsBackend.get_connections` method.
+A secrets backend is a subclass of
:py:class:`airflow.secrets.BaseSecretsBackend` and must implement either
Review comment:
I had to read the current docs and the implementation of
`BaseSecretsBackend` more than once to understand what's going on. I think it's
written wrong in the current docs, so happy with this change.
The thing that confused me is the current docs say to implement
`airflow.secrets.BaseSecretsBackend.get_conn_uri` or `get_connections`, but
`get_conn_uri` should only return an (internal) URI given an Airflow connection
id, not an actual Connection object, so I think it's up to the person
implementing to decide to use this or not. Instead, the method that should be
implemented is `get_connections`.
Can we simply write that? ("... and must implement
:py:meth:`~airflow.secrets.BaseSecretsBackend.get_connections`.")
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
