Limit route policy includes to 'route' and 'source' only

Remove 'app', 'space', and 'organization' as separate include values.
The 'source' include already resolves the underlying app/space/org
from the source string (e.g. cf:app:<guid>), making the individual
keywords redundant and confusing — especially since space_guids
filters by route space while include=space would include the source
space.

Author: rkoster

app/decorators/include_route_policy_source_decorator.rb

@@ -8,8 +8,7 @@ class IncludeRoutePolicySourceDecorator
     def self.match?(include_params)
       return false unless include_params
 
-      # Match if any of: source, app, space, organization
-      include_params.intersect?(%w[source app space organization])
+      include_params.include?('source')
     end
 
     def self.decorate(hash, route_policies)

app/messages/route_policies_list_message.rb

@@ -12,7 +12,7 @@ class RoutePoliciesListMessage < ListMessage
     ]
 
     validates_with NoAdditionalParamsValidator
-    validates_with IncludeParamValidator, valid_values: %w[source route app space organization]
+    validates_with IncludeParamValidator, valid_values: %w[source route]
 
     validates :space_guids, array: true, allow_nil: true
     validates :source_guids, array: true, allow_nil: true

app/messages/route_policy_show_message.rb

@@ -5,7 +5,7 @@ class RoutePolicyShowMessage < BaseMessage
     register_allowed_keys [:include]
 
     validates_with NoAdditionalParamsValidator
-    validates_with IncludeParamValidator, valid_values: %w[source route app space organization]
+    validates_with IncludeParamValidator, valid_values: %w[source route]
 
     def self.from_params(params)
       super(params, %w[include])

docs/v3/source/includes/resources/route_policies/_get.md.erb

@@ -28,7 +28,7 @@ Content-Type: application/json
 
 Name | Type | Description
 ---- | ---- | ------------
-**include** | _list of strings_ | Optionally include a list of unique related resources in the response; valid values are `route`, `app`, `space`, `organization`, and `source` (which includes the app, space, or organization referenced by the source field)
+**include** | _list of strings_ | Optionally include a list of unique related resources in the response; valid values are `route` and `source` (source includes the app, space, or organization referenced by the source field)
 
 #### Permitted roles
 

docs/v3/source/includes/resources/route_policies/_list.md.erb

@@ -57,7 +57,7 @@ curl "https://api.example.org/v3/route_policies?include=route,source" \
 | **per_page**             | _integer_                                        | Number of results per page; valid values are 1 through 5000
 | **order_by**             | _string_                                         | Value to sort by. Defaults to ascending; prepend with `-` to sort descending. Valid values are `created_at`, `updated_at`
 | **label_selector**       | _string_                                         | A query string containing a list of [label selector](#labels-and-selectors) requirements
-| **include**              | _string_                                         | Optionally include related resources in the response; valid values are `route`, `app`, `space`, `organization`, and `source` (which includes app, space, or organization based on the source type)
+| **include**              | _string_                                         | Optionally include related resources in the response; valid values are `route` and `source` (source includes the app, space, or organization based on the source type)
 | **created_ats**          | _[timestamp](#timestamps)_                       | Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. Also supports filtering with [relational operators](#relational-operators)
 | **updated_ats**          | _[timestamp](#timestamps)_                       | Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. Also supports filtering with [relational operators](#relational-operators)
 
@@ -68,7 +68,7 @@ curl "https://api.example.org/v3/route_policies?include=route,source" \
 - **Filter by source type**: `GET /v3/route_policies?sources=cf:any`
 - **Find policies referencing a specific app**: `GET /v3/route_policies?source_guids=d76446a1-f429-4444-8797-be2f78b75b08`
 - **Include source resources**: `GET /v3/route_policies?include=source` (batch-loads the app, space, or org referenced in each policy's source)
-- **Include route and app**: `GET /v3/route_policies?include=route,app`
+- **Include route and source**: `GET /v3/route_policies?include=route,source`
 
 #### Use cases
 

spec/unit/messages/route_policies_list_message_spec.rb

@@ -14,7 +14,7 @@ module VCAP::CloudController
           'page' => 1,
           'per_page' => 5,
           'order_by' => 'created_at',
-          'include' => 'source,route,app,space,organization'
+          'include' => 'source,route'
         }
       end
 
@@ -30,7 +30,7 @@ module VCAP::CloudController
         expect(message.page).to eq(1)
         expect(message.per_page).to eq(5)
         expect(message.order_by).to eq('created_at')
-        expect(message.include).to eq(%w[source route app space organization])
+        expect(message.include).to eq(%w[source route])
       end
 
       it 'converts requested keys to symbols' do
@@ -59,7 +59,7 @@ module VCAP::CloudController
           page: 1,
           per_page: 5,
           order_by: 'created_at',
-          include: %w[source route app space organization]
+                                                 include: %w[source route]
         }
       end
 
@@ -81,7 +81,7 @@ module VCAP::CloudController
                                                  page: 1,
                                                  per_page: 5,
                                                  order_by: 'created_at',
-                                                 include: %w[source route app space organization]
+          include: %w[source route]
                                                })
         end.not_to raise_error
       end
@@ -106,22 +106,22 @@ module VCAP::CloudController
           message = RoutePoliciesListMessage.from_params({ 'include' => 'route' })
           expect(message).to be_valid
 
-          message = RoutePoliciesListMessage.from_params({ 'include' => 'app' })
-          expect(message).to be_valid
-
-          message = RoutePoliciesListMessage.from_params({ 'include' => 'space' })
-          expect(message).to be_valid
-
-          message = RoutePoliciesListMessage.from_params({ 'include' => 'organization' })
-          expect(message).to be_valid
-
-          message = RoutePoliciesListMessage.from_params({ 'include' => 'source,route,app,space,organization' })
+          message = RoutePoliciesListMessage.from_params({ 'include' => 'source,route' })
           expect(message).to be_valid
         end
 
         it 'rejects invalid include values' do
           message = RoutePoliciesListMessage.from_params({ 'include' => 'invalid' })
           expect(message).not_to be_valid
+
+          message = RoutePoliciesListMessage.from_params({ 'include' => 'app' })
+          expect(message).not_to be_valid
+
+          message = RoutePoliciesListMessage.from_params({ 'include' => 'space' })
+          expect(message).not_to be_valid
+
+          message = RoutePoliciesListMessage.from_params({ 'include' => 'organization' })
+          expect(message).not_to be_valid
         end
       end