Fix support for included

apis/cf/latest/components/responses/RoleListResponse.yaml

@@ -10,3 +10,6 @@ content:
           type: array
           items:
             $ref: '../schemas/Role.yaml'
+        included:
+          $ref: '../schemas/IncludedResources.yaml'
+          description: Additional related resources included in the response when using the include parameter

apis/cf/latest/components/schemas/App.yaml

@@ -42,5 +42,8 @@ allOf:
           droplets:
             $ref: './Link.yaml'
             description: The URL to get the droplets for this app
+      included:
+        $ref: './IncludedResources.yaml'
+        description: Additional related resources included in the response when using the include parameter
 description: >
   Apps represent the core entities in the Cloud Foundry environment. They are the deployable units that run your code. Each app can have multiple processes, routes, and services associated with it. Apps can be scaled horizontally by increasing the number of instances. They can also be updated and restarted as needed.

apis/cf/latest/components/schemas/AppCredentialBinding.yaml

@@ -35,6 +35,9 @@ allOf:
             $ref: './Link.yaml'
       metadata:
         $ref: './Metadata.yaml'
+      included:
+        $ref: './IncludedResources.yaml'
+        description: Additional related resources included in the response when using the include parameter
     required:
     - type
     - relationships

apis/cf/latest/components/schemas/AppList.yaml

@@ -6,3 +6,6 @@ properties:
     type: array
     items:
       $ref: './App.yaml'
+  included:
+    $ref: './IncludedResources.yaml'
+    description: Additional related resources included in the response when using the include parameter

apis/cf/latest/components/schemas/IncludedResources.yaml

@@ -0,0 +1,51 @@
+type: object
+description: Additional related resources included in the response when using the include parameter
+properties:
+  spaces:
+    type: array
+    items:
+      $ref: './Space.yaml'
+    description: Array of included space resources
+  organizations:
+    type: array
+    items:
+      $ref: './Organization.yaml'
+    description: Array of included organization resources
+  domains:
+    type: array
+    items:
+      $ref: './Domain.yaml'
+    description: Array of included domain resources
+  service_offerings:
+    type: array
+    items:
+      $ref: './ServiceOffering.yaml'
+    description: Array of included service offering resources
+  service_instances:
+    type: array
+    items:
+      oneOf:
+        - $ref: './ManagedServiceInstance.yaml'
+        - $ref: './UserProvidedServiceInstance.yaml'
+      discriminator:
+        propertyName: type
+        mapping:
+          managed: ./ManagedServiceInstance.yaml
+          user-provided: ./UserProvidedServiceInstance.yaml
+    description: Array of included service instance resources
+  apps:
+    type: array
+    items:
+      $ref: './App.yaml'
+    description: Array of included app resources
+  routes:
+    type: array
+    items:
+      $ref: './Route.yaml'
+    description: Array of included route resources
+  users:
+    type: array
+    items:
+      $ref: './User.yaml'
+    description: Array of included user resources
+additionalProperties: false

apis/cf/latest/components/schemas/KeyCredentialBinding.yaml

@@ -29,6 +29,9 @@ allOf:
             $ref: './Link.yaml'
       metadata:
         $ref: './Metadata.yaml'
+      included:
+        $ref: './IncludedResources.yaml'
+        description: Additional related resources included in the response when using the include parameter
     required:
     - type
     - relationships

apis/cf/latest/components/schemas/Role.yaml

@@ -57,6 +57,9 @@ properties:
       space:
         $ref: './Link.yaml'
         description: The URL to get the space for this role
+  included:
+    $ref: './IncludedResources.yaml'
+    description: Additional related resources included in the response when using the include parameter
 description: |
   Roles represent a set of permissions that can be granted to users. Roles are represented as a JSON object.
   A role consists of several required role fields and other attributes specific to the role.

apis/cf/latest/components/schemas/Route.yaml

@@ -32,4 +32,7 @@ allOf:
           destinations:
             $ref: './Link.yaml'
             description: The URL to get the destinations for this route
+      included:
+        $ref: './IncludedResources.yaml'
+        description: Additional related resources included in the response when using the include parameter
 description: A route in Cloud Foundry is used to direct traffic from a URL to an application.

apis/cf/latest/components/schemas/RouteList.yaml

@@ -6,4 +6,7 @@ properties:
     type: array
     items:
       $ref: './Route.yaml'
+  included:
+    $ref: './IncludedResources.yaml'
+    description: Additional related resources included in the response when using the include parameter
 description: A list of routes

apis/cf/latest/components/schemas/ServiceCredentialBindingList.yaml

@@ -13,3 +13,6 @@ properties:
         mapping:
           app: './AppCredentialBinding.yaml'
           key: './KeyCredentialBinding.yaml'
+  included:
+    $ref: './IncludedResources.yaml'
+    description: Additional related resources included in the response when using the include parameter

apis/cf/latest/components/schemas/ServicePlan.yaml

@@ -19,4 +19,7 @@ allOf:
             description: The URL to get the service offering for this plan
           visibility:
             $ref: './Link.yaml'
-            description: The URL to get the visibility for this plan
+            description: The URL to get the visibility for this plan
+      included:
+        $ref: './IncludedResources.yaml'
+        description: Additional related resources included in the response when using the include parameter

apis/cf/latest/components/schemas/ServicePlanList.yaml

@@ -6,3 +6,6 @@ properties:
     type: array
     items:
       $ref: './ServicePlan.yaml'
+  included:
+    $ref: './IncludedResources.yaml'
+    description: Additional related resources included in the response when using the include parameter

apis/cf/latest/components/schemas/ServiceRouteBinding.yaml

@@ -27,6 +27,9 @@ allOf:
             $ref: './Link.yaml'
       metadata:
         $ref: './Metadata.yaml'
+      included:
+        $ref: './IncludedResources.yaml'
+        description: Additional related resources included in the response when using the include parameter
     required:
     - relationships
     - links

apis/cf/latest/components/schemas/ServiceRouteBindingList.yaml

@@ -6,3 +6,6 @@ properties:
     type: array
     items:
       $ref: './ServiceRouteBinding.yaml'
+  included:
+    $ref: './IncludedResources.yaml'
+    description: Additional related resources included in the response when using the include parameter

apis/cf/latest/components/schemas/Space.yaml

@@ -26,6 +26,9 @@ allOf:
             $ref: './Link.yaml'
       metadata:
         $ref: './Metadata.yaml'
+      included:
+        $ref: './IncludedResources.yaml'
+        description: Additional related resources included in the response when using the include parameter
     required:
     - name
     - relationships

apis/cf/latest/components/schemas/SpaceList.yaml

@@ -6,3 +6,6 @@ properties:
     type: array
     items:
       $ref: './Space.yaml'
+  included:
+    $ref: './IncludedResources.yaml'
+    description: Additional related resources included in the response when using the include parameter

apis/cf/latest/paths/Apps.yaml

@@ -156,6 +156,16 @@
     - Apps
     parameters:
     - $ref: '../components/parameters/Guid.yaml'
+    - name: include
+      in: query
+      schema:
+        type: array
+        items:
+          type: string
+          enum:
+          - space
+          - space.organization
+      description: Optionally include a list of unique related resources in the response
     responses:
       '200':
         description: Successfully retrieved app

apis/cf/latest/paths/Routes.yaml

@@ -157,6 +157,17 @@
     - Routes
     parameters:
     - $ref: '../components/parameters/Guid.yaml'
+    - name: include
+      in: query
+      schema:
+        type: array
+        items:
+          type: string
+          enum:
+          - domain
+          - space
+          - space.organization
+      description: Optionally include a list of unique related resources in the response
     responses:
       '200':
         description: Successfully retrieved route

apis/cf/latest/paths/ServicePlans.yaml

@@ -128,6 +128,16 @@
     - Service Plans
     parameters:
     - $ref: '../components/parameters/Guid.yaml'
+    - name: include
+      in: query
+      schema:
+        type: array
+        items:
+          type: string
+          enum:
+          - space.organization
+          - service_offering
+      description: Optionally include a list of unique related resources in the response
     responses:
       '200':
         description: OK

apis/cf/latest/paths/ServiceRouteBindings.yaml

@@ -145,6 +145,16 @@
     - Service Route Bindings
     parameters:
     - $ref: '../components/parameters/Guid.yaml'
+    - name: include
+      in: query
+      schema:
+        type: array
+        items:
+          type: string
+          enum:
+          - route
+          - service_instance
+      description: Optionally include a list of unique related resources in the response
     responses:
       '200':
         description: OK