diff options
| author | jwijenbergh <jeroenwijenbergh@protonmail.com> | 2023-03-21 15:26:34 +0100 |
|---|---|---|
| committer | Jeroen Wijenbergh <46386452+jwijenbergh@users.noreply.github.com> | 2023-09-25 09:43:37 +0200 |
| commit | c1cfda027f9509a5420b5e393a7650ced831128a (patch) | |
| tree | 3ff0e07100f6d491341005cd7dfdf693cfa67603 /docs | |
| parent | f576f6c3d9dd409c0fb77cf337b6214de3c42cbd (diff) | |
Docs API: Fix go boolean, add errors section and renew transition
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/src/api/overview/README.md | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/src/api/overview/README.md b/docs/src/api/overview/README.md index 4b5f3d5..475f9fb 100644 --- a/docs/src/api/overview/README.md +++ b/docs/src/api/overview/README.md @@ -5,6 +5,7 @@ This chapter defines the API that is used to build an eduVPN/Let's Connect! clie ## Table of contents 1. [Types](#types) - [JSON](#json) + - [Errors](#errors) - [States](#states) 2. [Functions](#functions) - [Registering](#registering) @@ -133,7 +134,7 @@ func stateCallback(oldState int, newState int, data interface{}) { } c := client.Client{} -c.Register("org.eduvpn.app.linux", "1.0.0", "/home/eduvpn/.config/eduvpn", stateCallback, True) +c.Register("org.eduvpn.app.linux", "1.0.0", "/home/eduvpn/.config/eduvpn", stateCallback, true) ``` </details> @@ -285,6 +286,9 @@ Renew session is used for renewing the VPN. This does not give you a configurati Arguments: - None +State transitions that must be handled: +- `OAuth_Started`: If the server needs authorization. Open the URL in the browser + Return type: - An error |