diff --git a/apis/cf/latest/components/responses/RoleListResponse.yaml b/apis/cf/latest/components/responses/RoleListResponse.yaml index 877a6ce..fb8b083 100644 --- a/apis/cf/latest/components/responses/RoleListResponse.yaml +++ b/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 diff --git a/apis/cf/latest/components/schemas/App.yaml b/apis/cf/latest/components/schemas/App.yaml index 4c40eeb..01e53d3 100644 --- a/apis/cf/latest/components/schemas/App.yaml +++ b/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. diff --git a/apis/cf/latest/components/schemas/AppCredentialBinding.yaml b/apis/cf/latest/components/schemas/AppCredentialBinding.yaml index 4a2865f..ed97907 100644 --- a/apis/cf/latest/components/schemas/AppCredentialBinding.yaml +++ b/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 diff --git a/apis/cf/latest/components/schemas/AppList.yaml b/apis/cf/latest/components/schemas/AppList.yaml index ebe9a26..dcd3ea8 100644 --- a/apis/cf/latest/components/schemas/AppList.yaml +++ b/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 diff --git a/apis/cf/latest/components/schemas/IncludedResources.yaml b/apis/cf/latest/components/schemas/IncludedResources.yaml new file mode 100644 index 0000000..a2d3158 --- /dev/null +++ b/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 diff --git a/apis/cf/latest/components/schemas/KeyCredentialBinding.yaml b/apis/cf/latest/components/schemas/KeyCredentialBinding.yaml index 97bf9f7..644d52d 100644 --- a/apis/cf/latest/components/schemas/KeyCredentialBinding.yaml +++ b/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 diff --git a/apis/cf/latest/components/schemas/Role.yaml b/apis/cf/latest/components/schemas/Role.yaml index babc86b..fcbb6ed 100644 --- a/apis/cf/latest/components/schemas/Role.yaml +++ b/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. diff --git a/apis/cf/latest/components/schemas/Route.yaml b/apis/cf/latest/components/schemas/Route.yaml index 076121a..d972b35 100644 --- a/apis/cf/latest/components/schemas/Route.yaml +++ b/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. diff --git a/apis/cf/latest/components/schemas/RouteList.yaml b/apis/cf/latest/components/schemas/RouteList.yaml index 3150ae5..6f69144 100644 --- a/apis/cf/latest/components/schemas/RouteList.yaml +++ b/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 diff --git a/apis/cf/latest/components/schemas/ServiceCredentialBindingList.yaml b/apis/cf/latest/components/schemas/ServiceCredentialBindingList.yaml index 8b22723..7ce0810 100644 --- a/apis/cf/latest/components/schemas/ServiceCredentialBindingList.yaml +++ b/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 diff --git a/apis/cf/latest/components/schemas/ServicePlan.yaml b/apis/cf/latest/components/schemas/ServicePlan.yaml index 4fb7954..bb03450 100644 --- a/apis/cf/latest/components/schemas/ServicePlan.yaml +++ b/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 \ No newline at end of file + 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 \ No newline at end of file diff --git a/apis/cf/latest/components/schemas/ServicePlanList.yaml b/apis/cf/latest/components/schemas/ServicePlanList.yaml index 6706224..5a6663c 100644 --- a/apis/cf/latest/components/schemas/ServicePlanList.yaml +++ b/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 diff --git a/apis/cf/latest/components/schemas/ServiceRouteBinding.yaml b/apis/cf/latest/components/schemas/ServiceRouteBinding.yaml index 0753017..03fbeae 100644 --- a/apis/cf/latest/components/schemas/ServiceRouteBinding.yaml +++ b/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 \ No newline at end of file diff --git a/apis/cf/latest/components/schemas/ServiceRouteBindingList.yaml b/apis/cf/latest/components/schemas/ServiceRouteBindingList.yaml index bbbbc20..dbe3c61 100644 --- a/apis/cf/latest/components/schemas/ServiceRouteBindingList.yaml +++ b/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 diff --git a/apis/cf/latest/components/schemas/Space.yaml b/apis/cf/latest/components/schemas/Space.yaml index be35698..e9dfc68 100644 --- a/apis/cf/latest/components/schemas/Space.yaml +++ b/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 diff --git a/apis/cf/latest/components/schemas/SpaceList.yaml b/apis/cf/latest/components/schemas/SpaceList.yaml index 1e22939..af67020 100644 --- a/apis/cf/latest/components/schemas/SpaceList.yaml +++ b/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 diff --git a/apis/cf/latest/paths/Apps.yaml b/apis/cf/latest/paths/Apps.yaml index 9e583a1..ef98ca9 100644 --- a/apis/cf/latest/paths/Apps.yaml +++ b/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 diff --git a/apis/cf/latest/paths/Routes.yaml b/apis/cf/latest/paths/Routes.yaml index 3526de3..e336a13 100644 --- a/apis/cf/latest/paths/Routes.yaml +++ b/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 diff --git a/apis/cf/latest/paths/ServicePlans.yaml b/apis/cf/latest/paths/ServicePlans.yaml index c5370d8..a393255 100644 --- a/apis/cf/latest/paths/ServicePlans.yaml +++ b/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 diff --git a/apis/cf/latest/paths/ServiceRouteBindings.yaml b/apis/cf/latest/paths/ServiceRouteBindings.yaml index 21b90c9..8797507 100644 --- a/apis/cf/latest/paths/ServiceRouteBindings.yaml +++ b/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