diff --git a/CHANGELOG.md b/CHANGELOG.md index c786130..c571216 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,7 @@ v2.1 ---- - Fix FLEXIAPI-282 Migrate to Laravel 11 and PHP 8.2+ +- Fix FLEXIAPI-371 Add documentation for the Wizard page v2.0 ---- diff --git a/flexiapi/resources/views/admin/account/provisioning_email/create.blade.php b/flexiapi/resources/views/admin/account/provisioning_email/create.blade.php index 8a50d64..de9423d 100644 --- a/flexiapi/resources/views/admin/account/provisioning_email/create.blade.php +++ b/flexiapi/resources/views/admin/account/provisioning_email/create.blade.php @@ -3,13 +3,13 @@ @section('breadcrumb') @include('admin.account.parts.breadcrumb_accounts_index') @include('admin.account.parts.breadcrumb_accounts_show', ['account' => $account]) -
{{ __('An email will be sent to :email with a QR Code and provisioning link.', ['email' => $account->email]) }}
diff --git a/flexiapi/resources/views/provisioning/documentation_markdown.blade.php b/flexiapi/resources/views/provisioning/documentation_markdown.blade.php index 41fe3e2..5dee53b 100644 --- a/flexiapi/resources/views/provisioning/documentation_markdown.blade.php +++ b/flexiapi/resources/views/provisioning/documentation_markdown.blade.php @@ -12,7 +12,7 @@ To request the following URLs client MUST add a specific `x-linphone-provisionin Otherwise the URLs with always return 400. This specific header is required to prevent unsolicited clients (crawlers, embedders) to consume the tokens. ``` -> GET /provisioning/### +> GET /provisioning/{provisioning_token} > x-linphone-provisioning ``` @@ -31,17 +31,25 @@ A provisioning content example The general idea is to allow the clients to access a unique URL returning a custom XML file containing the following elements: -* Public Expose the linphonerc INI file configuration +* Public Expose the main Linphone RC configuration * User Inject the authentication information to allow the application to authenticate on the server directly if a valid account is detected using the `provisioning` token * Public User Using __Custom Hooks__ an admin is also able to have access to the authenticated User internal object and inject custom XML during the provisioning. See the specific section in the `README.md` to learn more about that feature. ### Features -When scanning a provisioning URL with a valid token the server is also: +When querying a provisioning URL with a valid token the server is also: * User Activating the account * User Reseting the password, generating the new authentication information and returning them (if the `reset_password` parameter is present) +## Wizard + +### `GET /wizard/{provisioning_token}` + +Public + +Return a wizard page allowing a user to open Linphone with a `linphone-config` link pointing to a provisioning link having the provided `provisioning_token`. + ## Endpoints When an account is having an available `provisioning_token` it can be provisioned using the following URLs.