diff mbox series

[2/2] doc: Add new DeviceProvisioning API properties

Message ID 20220624164346.254771-2-jesse@twosheds.org (mailing list archive)
State Accepted, archived
Headers show
Series [1/2] dpp: Add Started, Role, and URI properties to API | expand

Checks

Context Check Description
tedd_an/pre-ci_am success Success
prestwoj/iwd-ci-gitlint success GitLint

Commit Message

Jesse Lentz June 24, 2022, 4:43 p.m. UTC 
Document the Started, Role, and URI properties of the DeviceProvisioning
API.
---
 doc/device-provisioning-api.txt | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

Comments

James Prestwood June 27, 2022, 4:37 p.m. UTC | #1 
Hi Jesse,

On Fri, 2022-06-24 at 12:43 -0400, Jesse Lentz wrote:
> Document the Started, Role, and URI properties of the
> DeviceProvisioning
> API.
> ---
>  doc/device-provisioning-api.txt | 15 +++++++++++++++
>  1 file changed, 15 insertions(+)
> 
> diff --git a/doc/device-provisioning-api.txt b/doc/device-
> provisioning-api.txt
> index 0aba2557..ac204f46 100644
> --- a/doc/device-provisioning-api.txt
> +++ b/doc/device-provisioning-api.txt
> @@ -56,3 +56,18 @@ Methods              string StartEnrollee()
>                                                 net.connman.iwd.NotCo
> nfigured
>                                                 net.connman.iwd.NotSu
> pported
>                                                 net.connman.iwd.Busy
> +
> +Properties     boolean Started [readonly]
> +
> +                       True if DPP is currently active.
> +
> +               string Role [readonly, optional]
> +
> +                       Indicates the DPP role. Possible values are
> "enrollee"
> +                       or "configurator". This property is only
> available when
> +                       Started is true.
> +
> +               string URI [readonly, optional]
> +
> +                       Indicates the DPP URI. This property is only
> available
> +                       when Started is true.

This looks good to me.

Just a note for next time, please send with a "v2" prefix. This lets
Patchwork remove old patch sets automatically.

Thanks,
James
Jesse Lentz June 27, 2022, 7:34 p.m. UTC | #2 
Hi James,

> This looks good to me.
>
> Just a note for next time, please send with a "v2" prefix. This lets
> Patchwork remove old patch sets automatically.

Will do, thanks.

Sincerely,
Jesse
diff mbox series

Patch

diff --git a/doc/device-provisioning-api.txt b/doc/device-provisioning-api.txt
index 0aba2557..ac204f46 100644
--- a/doc/device-provisioning-api.txt
+++ b/doc/device-provisioning-api.txt
@@ -56,3 +56,18 @@  Methods		string StartEnrollee()
 						net.connman.iwd.NotConfigured
 						net.connman.iwd.NotSupported
 						net.connman.iwd.Busy
+
+Properties	boolean Started [readonly]
+
+			True if DPP is currently active.
+
+		string Role [readonly, optional]
+
+			Indicates the DPP role. Possible values are "enrollee"
+			or "configurator". This property is only available when
+			Started is true.
+
+		string URI [readonly, optional]
+
+			Indicates the DPP URI. This property is only available
+			when Started is true.