Skip to content

Commit

Permalink
Explain server defaults and endpoints
Browse files Browse the repository at this point in the history
  • Loading branch information
mrvanes committed Oct 16, 2024
1 parent de2a4ec commit 91b4658
Showing 1 changed file with 21 additions and 5 deletions.
26 changes: 21 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,29 @@ usage: server.py [-h] [--host HOST] [--port PORT] [--mongo_db MONGO_DB] [--db_ur
SCIM Test server.
options:
-h, --help show this help message and exit
--host HOST
--port PORT
-h, --help show this help message and exit
--host HOST (0.0.0.0)
--port PORT (8000)
--mongo_db MONGO_DB, -m MONGO_DB
--db_url DB_URL, -d DB_URL
--data_path DATA_PATH, -p DATA_PATH
--api-key API_KEY, -k API_KEY
--data_path DATA_PATH, -p DATA_PATH (/tmp)
--api-key API_KEY, -k API_KEY (secret)
Start the server in simple mode
$ ./server.py
using FilePlugin: /tmp
INFO: Started server process [674017]
INFO: Waiting for application startup.
INFO: Application startup complete.
INFO: Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit)
The ResourceTypes endpoint is now available at:
curl --request GET \
--url http://localhost:8000/ResourceTypes \
--header 'x-api-key: secret'
```

---
Expand Down

0 comments on commit 91b4658

Please sign in to comment.