Skip to content

Commit 9972795

Browse files
authored
Merge pull request #3114 from jeff1evesque/feature-3113
#3113: Remove anon reference from '/login' doc
2 parents dc6582c + 5a532ad commit 9972795

File tree

1 file changed

+7
-15
lines changed
  • doc/programmatic_interface/authentication

1 file changed

+7
-15
lines changed

doc/programmatic_interface/authentication/login.rst

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Login
33
=====
44

5-
Users can submit a ``/login`` request, for the programmatic-api:
5+
Users can submit a ``/login`` request, for the programmatic rest-api:
66

77
.. code:: python
88
@@ -19,9 +19,8 @@ Users can submit a ``/login`` request, for the programmatic-api:
1919
)
2020
token = login.json['access_token']
2121
22-
The returned ``token`` value, can be supplied on successive requests, to a rest
23-
endpoint, expecting the corresponding ``token`` value. For example, supplying
24-
a valid token, to the ``/load-data`` endpoint:
22+
The returned ``token``, will be required to be supplied on successive requests.
23+
For example, supplying a valid token, to the ``/load-data`` endpoint:
2524

2625
.. code:: python
2726
@@ -48,17 +47,10 @@ a valid token, to the ``/load-data`` endpoint:
4847
data=payload
4948
)
5049
51-
The following sessions, can be implemented with the above token, or omitted as
52-
an anonymous user:
50+
**Note:** all programmatic rest endpoints (except ``/login``), requires a valid
51+
token to be supplied, in order to properly submit a corresponding request.
52+
53+
The following sessions, can be implemented with the above token:
5354

5455
- `data-new <https://github.com/jeff1evesque/machine-learning/blob/master/doc/programmatic_interface/data/data_new.rst>`_
5556
- `data-append <https://github.com/jeff1evesque/machine-learning/blob/master/doc/programmatic_interface/data/data_new.rst>`_
56-
57-
The following unit tests, provides examples of the `flask-jwt <http://flask-jwt-extended.readthedocs.io/en/latest/>`_
58-
implementation:
59-
60-
- |pytest_6_user_session.py|_
61-
62-
.. |pytest_6_user_session.py| replace:: ``pytest_6_user_session.py``
63-
.. _pytest_6_user_session.py: https://github.com/jeff1evesque/machine-learning/tree/master/test/live_server/1_authentication/pytest_6_user_login.py
64-

0 commit comments

Comments
 (0)