Skip to content

Commit

Permalink
docs(readme): add extra features
Browse files Browse the repository at this point in the history
  • Loading branch information
christian-hawk committed Jan 4, 2023
1 parent da8564d commit ecc7b6a
Showing 1 changed file with 26 additions and 5 deletions.
31 changes: 26 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,13 +68,34 @@ python3 main.py

* navigate to `https://localhost:9090/protected-content`

## Developing
## Extra Features

### Auto-register endpoint

Sending a `POST` request to `/register` endpoint containing a `JSON` with the OP/AS url and client url, like this:

```json
{
"op_url": "https://idpproxy-test.usg.edu",
"client_url": "https://tempclient.techno24x7.com"
}
```

Will return client id and client secret

### Auto-config endpoint

Sending a `POST` request to `/configuration` endpoint, containing client id, client secret, and metadata endpoint will fetch data from metadata url and override `config.py` settings during runtime.

```json
{
"client_id": "e4f2c3a9-0797-4c6c-9268-35c5546fb3e9",
"client_secret": "5c9e4775-0f1d-4a56-87c9-a629e1f88b9b",
"op_metadata_url": "https://t1.techno24x7.com/.well-known/openid-configuration"
}
```

### Test First

- BDD black box: independent testing using behave and selenium
- TDD: Test first, always: unit tests using unittest lib and pytest
- Coverage: minimum accepted: 80%



0 comments on commit ecc7b6a

Please sign in to comment.