Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions platform/paths/infrastructure/external-volumes/external-volume.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,19 @@ get:
type: string
enum:
- containers
- name: include
in: query
required: false
description: |
A comma-separated list of include values. Included resources will show up under the root document's `include` field.
In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return.
schema:
type: array
items:
type: string
enum:
- servers
- locations
responses:
200:
description: Returns the requested virtual machine.
Expand All @@ -39,6 +52,8 @@ get:
properties:
data:
$ref: ../../../../components/schemas/infrastructure/external-volumes/ExternalVolume.yml
includes:
$ref: ./includes/ExternalVolumeIncludes.yml
default:
$ref: ../../../../components/responses/errors/DefaultError.yml

Expand All @@ -58,6 +73,34 @@ patch:
required: true
schema:
type: string
- name: meta
in: query
required: false
description:
A comma separated list of meta values. Meta values will show up under a resource's
`meta` field. In the case of applying a meta to a collection of resources, each
resource will have it's own relevant meta data. In some rare cases, meta may not
apply to individual resources, and may appear in the root document. These will be
clearly labeled.
schema:
type: array
items:
type: string
enum:
- containers
- name: include
in: query
required: false
description: |
A comma-separated list of include values. Included resources will show up under the root document's `include` field.
In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return.
schema:
type: array
items:
type: string
enum:
- servers
- locations
requestBody:
description: Parameters for updating the external volume.
content:
Expand Down Expand Up @@ -91,6 +134,8 @@ patch:
properties:
data:
$ref: ../../../../components/schemas/infrastructure/external-volumes/ExternalVolume.yml
includes:
$ref: ./includes/ExternalVolumeIncludes.yml
default:
$ref: ../../../../components/responses/errors/DefaultError.yml

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,19 @@ get:
type: string
enum:
- containers
- name: include
in: query
required: false
description: |
A comma-separated list of include values. Included resources will show up under the root document's `include` field.
In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return.
schema:
type: array
items:
type: string
enum:
- servers
- locations
- name: filter
in: query
# Deep nested arrays are undefined https://github.com/OAI/OpenAPI-Specification/issues/1706
Expand Down Expand Up @@ -64,10 +77,7 @@ get:
items:
$ref: ../../../../components/schemas/infrastructure/external-volumes/ExternalVolume.yml
includes:
type: object
properties:
creators:
$ref: ../../../../components/schemas/includes/CreatorInclude.yml
$ref: ./includes/ExternalVolumeIncludes.yml
default:
$ref: ../../../../components/responses/errors/DefaultError.yml

Expand All @@ -77,7 +87,35 @@ post:
description: Requires the `external-volumes-manage` capability.
tags:
- External Volumes
parameters: []
parameters:
- name: meta
in: query
required: false
description:
A comma separated list of meta values. Meta values will show up under a resource's
`meta` field. In the case of applying a meta to a collection of resources, each
resource will have it's own relevant meta data. In some rare cases, meta may not
apply to individual resources, and may appear in the root document. These will be
clearly labeled.
schema:
type: array
items:
type: string
enum:
- containers
- name: include
in: query
required: false
description: |
A comma-separated list of include values. Included resources will show up under the root document's `include` field.
In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return.
schema:
type: array
items:
type: string
enum:
- servers
- locations
requestBody:
content:
application/json:
Expand Down Expand Up @@ -142,5 +180,7 @@ post:
properties:
data:
$ref: ../../../../components/schemas/infrastructure/external-volumes/ExternalVolume.yml
includes:
$ref: ./includes/ExternalVolumeIncludes.yml
default:
$ref: ../../../../components/responses/errors/DefaultError.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
title: ExternalVolumeIncludes
description: All includable resources linked to the given external volume.
type: object
properties:
servers:
type: object
additionalProperties:
$ref: ../../../../../components/schemas/infrastructure/servers/Server.yml
locations:
type: object
additionalProperties:
$ref: ../../../../../components/schemas/infrastructure/providers/ProviderLocation.yml