Skip to content

Documentation about query_param auth bundle configuration #238

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.

Sign up for GitHub

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

Closed
wants to merge 1 commit into from
Closed

Documentation about query_param auth bundle configuration #238

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion integrations/symfony-bundle.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ Authentication
``````````````

You can configure a client with authentication. Valid authentication types are
``basic``, ``bearer``, ``service`` and ``wsse``. See more examples at the
``basic``, ``bearer``, ``service``, ``wsse`` and ``query_param``. See more examples at the
:doc:`full configuration </integrations/symfony-full-configuration>`.

.. code-block:: yaml
Expand All @@ -288,6 +288,11 @@ You can configure a client with authentication. Valid authentication types are
factory: 'httplug.factory.guzzle6'
plugins: ['httplug.plugin.authentication.my_wsse']

.. warning::

Using query parameters for authentication is :doc:`not safe </message/authentication#query-params>`.
Copy link
Contributor

@dbu dbu Jul 10, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the most robust way to cross reference to an anchor is to define the target like .. _ShortAnchor: right above the heading we want to link to, and then use :ref:`my text <ShortAnchor>`

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

edited the example for a custom text of the link

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the most robust way to cross reference to an anchor is to define the target like .. _ShortAnchor:

I'm not sure to follow you. Could you please bring me a existing case?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://raw.githubusercontent.com/php-http/documentation/master/clients/curl-client.rst

The cURL client needs a :ref:`message factory <message-factory>` and a

points to https://raw.githubusercontent.com/php-http/documentation/master/message/message-factory.rst

.. _message-factory:

(not a very good use case, as that could also just link to that doc file - the main point of anchors is to deep link into a page... but a working example)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm sorry but I still not see how this will help me with #query-params anchor... ^^"

The auth params will appear on the URL and we recommend to NOT log your request, especially on production side.

Special HTTP Clients
````````````````````

Expand Down
4 changes: 4 additions & 0 deletions integrations/symfony-full-configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ This page shows an example of all configuration values provided by the bundle.
my_bearer:
type: 'bearer'
token: 'authentication_token_hash'
my_query_param:
type: 'query_param'
params:
access_token: '9zh987g86fg87gh978hg9g79'
my_service:
type: 'service'
service: 'my_authentication_service'
Expand Down