Skip to content

Commit

Permalink
Docs should reference test@test.com test user not test.
Browse files Browse the repository at this point in the history
  • Loading branch information
failys committed Aug 19, 2022
1 parent fc1d5da commit f8c1929
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,13 @@ SwaggerHub provides a virtual server at https://virtserver.swaggerhub.com/failys
Authenticating with the CAIRIS server
-------------------------------------

For a more representative test, you'll want to run up cairisd and import a model. If you do this, the first thing you need to do is authentication to get a session. You can get this by posting to /api/session with your credentials. Let's assume our username and password is test and test:
For a more representative test, you'll want to run up cairisd and import a model. If you do this, the first thing you need to do is authentication to get a session. You can get this by posting to /api/session with your credentials. Let's assume our username and password is test@test.com and test:

.. code-block:: bash
curl -u test:test -X POST http://localhost:7071/api/session
{"message": "Session created", "session_id": "S9A3U7XkKEzqPwjwzKqR8jPGPVK0dvtf", "user": "test"}
curl -u test@test.com -X POST http://localhost:7071/api/session
Enter host password for user 'test@test.com':
{"message": "Session created", "session_id": "S9A3U7XkKEzqPwjwzKqR8jPGPVK0dvtf", "user": "test@test.com"}
By default, the session will point to the user's default database, but posting to api/settings/database/{name}/open can change the database the session points to, where name is the name of the database you want to point to.

Expand Down

0 comments on commit f8c1929

Please sign in to comment.