Merge ~teknoraver/snappy-hwe-snaps/+git/wifi-ap:master into ~snappy-hwe-team/snappy-hwe-snaps/+git/wifi-ap:master

Proposed by Matteo Croce
Status: Merged
Approved by: Simon Fels
Approved revision: 17cca0009416cce6925be3fb448621fd6f215557
Merged at revision: 043e0f5b1226ddbb013821db88871969dd3c2210
Proposed branch: ~teknoraver/snappy-hwe-snaps/+git/wifi-ap:master
Merge into: ~snappy-hwe-team/snappy-hwe-snaps/+git/wifi-ap:master
Diff against target: 62 lines (+10/-5)
3 files modified
docs/reference/rest-api.md (+6/-1)
docs/reference/rest-api/v1-configuration.md (+2/-2)
docs/reference/rest-api/v1-status.md (+2/-2)
Reviewer Review Type Date Requested Status
Simon Fels Approve
System Enablement Bot continuous-integration Approve
Jim Hodapp (community) Needs Information
Review via email: mp+318769@code.launchpad.net

Description of the change

update documentation

To post a comment you must log in.
Revision history for this message
System Enablement Bot (system-enablement-ci-bot) wrote :
review: Needs Fixing (continuous-integration)
Revision history for this message
System Enablement Bot (system-enablement-ci-bot) wrote :
review: Approve (continuous-integration)
Revision history for this message
Jim Hodapp (jhodapp) :
review: Needs Information
Revision history for this message
Simon Fels (morphis) :
review: Needs Fixing
Revision history for this message
System Enablement Bot (system-enablement-ci-bot) wrote :
review: Needs Fixing (continuous-integration)
Revision history for this message
System Enablement Bot (system-enablement-ci-bot) wrote :
review: Needs Fixing (continuous-integration)
Revision history for this message
System Enablement Bot (system-enablement-ci-bot) wrote :
review: Needs Fixing (continuous-integration)
Revision history for this message
System Enablement Bot (system-enablement-ci-bot) wrote :
review: Needs Fixing (continuous-integration)
Revision history for this message
System Enablement Bot (system-enablement-ci-bot) wrote :
review: Needs Fixing (continuous-integration)
Revision history for this message
System Enablement Bot (system-enablement-ci-bot) wrote :
review: Needs Fixing (continuous-integration)
Revision history for this message
Simon Fels (morphis) :
review: Needs Fixing
Revision history for this message
System Enablement Bot (system-enablement-ci-bot) wrote :
review: Approve (continuous-integration)
Revision history for this message
System Enablement Bot (system-enablement-ci-bot) wrote :
review: Approve (continuous-integration)
Revision history for this message
Simon Fels (morphis) wrote :

LGTM

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1diff --git a/docs/reference/rest-api.md b/docs/reference/rest-api.md
2index 8a1e482..cd239bf 100644
3--- a/docs/reference/rest-api.md
4+++ b/docs/reference/rest-api.md
5@@ -34,7 +34,12 @@ $ snap connect wifi-ap-example-consumer:control wifi-ap:control
6 ```
7 The socket will be available as $SNAP_DATA/sockets/control within the wifi-ap-example-consumer snap.
8
9-If you need a simple client to talk with the service, you can use, for example, the unixhttpc tool to do raw HTTP queries.
10+If you need a simple client to talk with the service, you can use, for example, the wifi-ap-client snap to do raw HTTP queries. You can install it with:
11+
12+```
13+ $ snap install wifi-ap-client
14+ $ snap connect ..
15+```
16
17 ## Responses
18
19diff --git a/docs/reference/rest-api/v1-configuration.md b/docs/reference/rest-api/v1-configuration.md
20index 459d63e..158e245 100644
21--- a/docs/reference/rest-api/v1-configuration.md
22+++ b/docs/reference/rest-api/v1-configuration.md
23@@ -38,7 +38,7 @@ The following errors can occur:
24 ### Example
25
26 ```
27-$ sudo unixhttpc /var/snap/wifi-ap/current/sockets/control /v1/configuration
28+$ sudo wifi-ap-client /v1/configuration
29 {
30 “result”: {
31 "disabled": true,
32@@ -95,7 +95,7 @@ The following errors can occur:
33 ### Example
34
35 ```
36-$ sudo unixhttpc -d '{“wifi.security”: “open”, “wifi.interface”: “wlan0”}' /v1/configuration
37+$ sudo wifi-ap-client -d '{“wifi.security”: “open”, “wifi.interface”: “wlan0”}' /v1/configuration
38 {
39 “result”: { },
40 “status”: “OK”,
41diff --git a/docs/reference/rest-api/v1-status.md b/docs/reference/rest-api/v1-status.md
42index 9d555eb..9308c57 100644
43--- a/docs/reference/rest-api/v1-status.md
44+++ b/docs/reference/rest-api/v1-status.md
45@@ -32,7 +32,7 @@ The following errors can occur:
46 ### Example
47
48 ```
49-$ sudo unixhttpc /var/snap/wifi-ap/current/sockets/control /v1/status
50+$ sudo wifi-ap-client /v1/status
51 {
52 “result”: {
53 “ap.active”: “0”,
54@@ -85,7 +85,7 @@ The following errors can occur:
55 ### Example
56
57 ```
58-$ sudo unixhttpc -d '{“action”:”restart-ap”}' /var/snap/wifi-ap/current/sockets/control /v1/status
59+$ sudo wifi-ap-client -d '{“action”:”restart-ap”}' /var/snap/wifi-ap/current/sockets/control /v1/status
60 {
61 “result”: { },
62 “status”: “OK”,

Subscribers

People subscribed via source and target branches

to all changes: