Add documentation url in the offering top level properties

[#171878575]

Author: pivotal-marcela-campo

app/presenters/v3/service_offering_presenter.rb

@@ -22,6 +22,7 @@ def to_hash
             created_at: service_offering.created_at,
             updated_at: service_offering.updated_at,
             shareable: shareable(metadata),
+            documentation_url: documentation_url(metadata),
             broker_catalog: {
               id: service_offering.unique_id,
               metadata: metadata,
@@ -52,6 +53,10 @@ def shareable(metadata)
           metadata['shareable'] == true
         end
 
+        def documentation_url(metadata)
+          metadata['documentation_url'] || ''
+        end
+
         def broker_metadata
           JSON.parse(service_offering.extra)
         rescue JSON::ParserError

docs/v3/source/includes/experimental_resources/service_offerings/_object.md.erb

@@ -18,6 +18,7 @@ Name | Type | Description
 **created_at** | _datetime_ | The time with zone when the object was created.
 **updated_at** | _datetime_ | The time with zone when the object was last updated.
 **shareable** | _boolean_ | Whether or not Service Instances of this Service Offering can be shared across Organizations and Spaces.
+**documentation_url** | _string_ | Url that points to a documentation page for the Service Offering, if provided by the Service Broker as part of the metadata field as specified by [OSBAPI](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#service-metadata)
 **broker_catalog** | _object_ | This object contains information obtained from the Service Broker Catalog.
 **broker_catalog.id** | _string_ | The identifier that the Service Broker provided for this Service Offering.
 **broker_catalog.metadata** | _object_ | Additional information provided by the Service Broker.

spec/request/service_offerings_spec.rb

@@ -1004,6 +1004,7 @@ def create_offering_json(service_offering, labels: {}, annotations: {})
       'created_at' => iso8601,
       'updated_at' => iso8601,
       'shareable' => true,
+      'documentation_url' => 'https://some.url.for.docs/',
       'broker_catalog' => {
         'id' => service_offering.unique_id,
         'metadata' => JSON.parse(service_offering.extra),

spec/support/fakes/blueprints.rb

@@ -305,7 +305,7 @@ module VCAP::CloudController
     active                { true }
     service_broker        { ServiceBroker.make }
     description           { Sham.description } # remove hack
-    extra                 { '{"shareable": true}' }
+    extra                 { '{"shareable": true, "documentation_url": "https://some.url.for.docs/"}' }
     instances_retrievable { false }
     bindings_retrievable  { false }
   end

spec/unit/presenters/v3/service_offering_presenter_spec.rb

@@ -6,6 +6,7 @@
   let(:guid) { 'some-offering-guid' }
   let(:name) { 'some-offering-name' }
   let(:description) { 'some offering description' }
+  let(:documentation_url) { 'https://some.documentation.url/' }
   let(:available) { false }
   let(:bindable) { false }
   let(:extra) { '{"foo": "bar", "baz": {"answer": 42}' }
@@ -70,6 +71,7 @@
         'created_at': created_at,
         'updated_at': service_offering.updated_at,
         'shareable': false,
+        'documentation_url': '',
         'broker_catalog': {
           'id': id,
           'metadata': {
@@ -164,30 +166,39 @@
       end
     end
 
-    context 'when `shareable` is true' do
-      let(:extra) { '{"shareable": true}' }
+    context 'extra' do
+      context 'when `shareable` is true' do
+        let(:extra) { '{"shareable": true}' }
 
-      it 'displays `true``' do
-        expect(result[:shareable]).to be true
+        it 'displays `true``' do
+          expect(result[:shareable]).to be true
+        end
       end
-    end
 
-    context 'when `shareable` is non-boolean' do
-      let(:extra) { '{"shareable": "invalid value"}' }
+      context 'when `shareable` is non-boolean' do
+        let(:extra) { '{"shareable": "invalid value"}' }
 
-      it 'displays `false``' do
-        expect(result[:shareable]).to be false
+        it 'displays `false``' do
+          expect(result[:shareable]).to be false
+        end
       end
-    end
 
-    context 'when `shareable` is explicitly false' do
-      let(:extra) { '{"shareable": false}' }
+      context 'when `shareable` is explicitly false' do
+        let(:extra) { '{"shareable": false}' }
 
-      it 'displays `false``' do
-        expect(result[:shareable]).to be false
+        it 'displays `false``' do
+          expect(result[:shareable]).to be false
+        end
       end
-    end
 
+      context 'when `documentation_url` is set' do
+        let(:extra) { '{"documentation_url": "https://some.documentation.url/"}' }
+
+        it 'displays the value` as a top level field' do
+          expect(result[:documentation_url]).to eq 'https://some.documentation.url/'
+        end
+      end
+    end
     context 'when `metadata` is not set' do
       let(:extra) { nil }