From 11b82f1a6f9b64cf1fabae927cd83f23c8bd681d Mon Sep 17 00:00:00 2001
From: Gerhard Jungwirth <gjungwirth@sipwise.com>
Date: Wed, 17 Aug 2016 14:45:14 +0200
Subject: [PATCH] MT#16931 some api documentation examples

for the *preferences items

Change-Id: I53b3bd3c3706a25a9881222d9ab62fb3eddaf659
---
 lib/NGCP/Panel/Controller/API/CustomerPreferences.pm  |  9 +++++++++
 lib/NGCP/Panel/Controller/API/DomainPreferences.pm    |  9 +++++++++
 .../Panel/Controller/API/PeeringServerPreferences.pm  |  8 ++++++++
 .../Panel/Controller/API/SubscriberPreferences.pm     | 11 +++++++++++
 4 files changed, 37 insertions(+)

diff --git a/lib/NGCP/Panel/Controller/API/CustomerPreferences.pm b/lib/NGCP/Panel/Controller/API/CustomerPreferences.pm
index b62e7d18e9..ac669d1832 100644
--- a/lib/NGCP/Panel/Controller/API/CustomerPreferences.pm
+++ b/lib/NGCP/Panel/Controller/API/CustomerPreferences.pm
@@ -9,6 +9,7 @@ use Data::HAL::Link qw();
 use HTTP::Headers qw();
 use HTTP::Status qw(:constants);
 
+use JSON qw();
 use NGCP::Panel::Utils::DateTime;
 use Path::Tiny qw(path);
 use Safe::Isa qw($_isa);
@@ -34,6 +35,14 @@ sub query_params {
     ];
 }
 
+sub documentation_sample {
+    return {
+        block_in_mode  => JSON::true,
+        block_in_list  => [ "1234" ],
+        concurrent_max => 5,
+    };
+}
+
 use parent qw/Catalyst::Controller NGCP::Panel::Role::API::Preferences/;
 
 sub resource_name{
diff --git a/lib/NGCP/Panel/Controller/API/DomainPreferences.pm b/lib/NGCP/Panel/Controller/API/DomainPreferences.pm
index e80c2bcf6b..56105f1afc 100644
--- a/lib/NGCP/Panel/Controller/API/DomainPreferences.pm
+++ b/lib/NGCP/Panel/Controller/API/DomainPreferences.pm
@@ -25,6 +25,15 @@ sub api_description {
     return 'Specifies certain properties (preferences) for a <a href="#domains">Domain</a>. The full list of properties can be obtained via <a href="/api/domainpreferencedefs/">DomainPreferenceDefs</a>.';
 };
 
+sub documentation_sample {
+    return {
+        outbound_from_user => "upn",
+        outbound_to_user => "callee",
+        concurrent_max => 5,
+        use_rtpproxy => "ice_strip_candidates",
+    };
+}
+
 use parent qw/Catalyst::Controller NGCP::Panel::Role::API::Preferences/;
 
 sub resource_name{
diff --git a/lib/NGCP/Panel/Controller/API/PeeringServerPreferences.pm b/lib/NGCP/Panel/Controller/API/PeeringServerPreferences.pm
index 9216c55da9..8f174c6497 100644
--- a/lib/NGCP/Panel/Controller/API/PeeringServerPreferences.pm
+++ b/lib/NGCP/Panel/Controller/API/PeeringServerPreferences.pm
@@ -25,6 +25,14 @@ sub api_description {
     return 'Specifies certain properties (preferences) for a <a href="#peeringservers">Peering servers</a>. The full list of properties can be obtained via <a href="/api/peeringserverpreferencedefs/">PeeringSserverPreferenceDefs</a>.';
 };
 
+sub documentation_sample {
+    return {
+        force_outbound_calls_to_peer => "never",
+        transport_protocol => "transparent",
+        use_rtpproxy => "ice_strip_candidates",
+    };
+}
+
 use parent qw/Catalyst::Controller NGCP::Panel::Role::API::Preferences/;
 
 sub resource_name{
diff --git a/lib/NGCP/Panel/Controller/API/SubscriberPreferences.pm b/lib/NGCP/Panel/Controller/API/SubscriberPreferences.pm
index 79a7b07bb3..26a9b112b4 100644
--- a/lib/NGCP/Panel/Controller/API/SubscriberPreferences.pm
+++ b/lib/NGCP/Panel/Controller/API/SubscriberPreferences.pm
@@ -9,6 +9,7 @@ use Data::HAL::Link qw();
 use HTTP::Headers qw();
 use HTTP::Status qw(:constants);
 
+use JSON qw();
 use NGCP::Panel::Utils::DateTime;
 use NGCP::Panel::Utils::ProfilePackages qw();
 use Path::Tiny qw(path);
@@ -55,6 +56,16 @@ sub query_params {
     ];
 }
 
+sub documentation_sample {
+    return {
+        block_in_mode  => JSON::true,
+        block_in_list  => [ "1234" ],
+        concurrent_max => 5,
+        music_on_hold  => JSON::true,
+        peer_auth_user => "mypeer",
+    };
+}
+
 use parent qw/Catalyst::Controller NGCP::Panel::Role::API::Preferences/;
 
 sub resource_name{