Blewis/eng 1583 autoscaling infrastructure public api

components/schemas/includes/ServerModelsIncludes.yml

@@ -0,0 +1,5 @@
+title: ServerModelsIncludes
+description: A resource associated with a server models.
+type: object
+additionalProperties:
+  $ref: ../infrastructure/providers/ProviderServer.yml

components/schemas/infrastructure/auto-scale/groups/AutoScaleGroupIncludes.yml

@@ -0,0 +1,10 @@
+title: AutoScaleGroupIncludes
+description: All includable resource linkable to the given auto-scale group.
+type: object
+properties:
+  providers:
+    "$ref": "../../../includes/ProvidersIncludes.yml"
+  models:
+    "$ref": "../../../includes/ServerModelsIncludes.yml"
+  locations:
+    "$ref": "../../../includes/LocationsIncludes.yml"

components/schemas/infrastructure/auto-scale/groups/AutoScaleGroupInfrastructure.yml

@@ -9,13 +9,13 @@ properties:
       type: object
       required:
         - provider
-        - id
+        - model_id
         - priority
         - locations
       properties:
         provider:
           type: string
-        id:
+        model_id:
           type: string
         priority:
           type: integer

components/schemas/infrastructure/providers/LocationProvider.yml

@@ -16,3 +16,7 @@ properties:
   code:
     type: string
     description: A location code returned from the provider.
+  availability_zones:
+    type: array
+    items:
+      type: string

public/paths/infrastructure/auto-scale/groups/group.yml

@@ -9,6 +9,22 @@ get:
       required: true
       schema:
         type: string
+    - 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, with the key being the id of the included
+        resource. In the case of applying an include to a collection of resources, if two
+        resources share the same include, it will only appear once in the return.
+      schema:
+        type: array
+        items:
+          type: string
+          enum:
+            - providers
+            - models
+            - locations
   summary: Fetch Auto-Scale Group
   description: Requires the `autoscale-groups-view` capability.
   responses:
@@ -22,6 +38,8 @@ get:
             properties:
               data:
                 $ref: ../../../../../components/schemas/infrastructure/auto-scale/groups/AutoScaleGroup.yml
+              includes:
+                $ref: ../../../../../components/schemas/infrastructure/auto-scale/groups/AutoScaleGroupIncludes.yml
     default:
       $ref: ../../../../../components/responses/errors/DefaultError.yml
 patch:

public/paths/infrastructure/auto-scale/groups/groups.yml

@@ -4,6 +4,22 @@ get:
     - InfrastructureAutoScaleGroup
   parameters:
     - $ref: ../../../../../components/parameters/PageParam.yml
+    - 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, with the key being the id of the included
+        resource. In the case of applying an include to a collection of resources, if two
+        resources share the same include, it will only appear once in the return.
+      schema:
+        type: array
+        items:
+          type: string
+          enum:
+            - providers
+            - models
+            - locations
   summary: Get Auto-Scale Groups list
   description: Requires the `autoscale-groups-manage` capability.
   responses:
@@ -19,6 +35,8 @@ get:
                 type: array
                 items:
                   $ref: ../../../../../components/schemas/infrastructure/auto-scale/groups/AutoScaleGroup.yml
+              includes:
+                $ref: ../../../../../components/schemas/infrastructure/auto-scale/groups/AutoScaleGroupIncludes.yml
     default:
       $ref: ../../../../../components/responses/errors/DefaultError.yml
 post:

public/paths/sdn/networks.yml

@@ -18,7 +18,6 @@ get:
           enum:
             - creators
             - environments
-
     - name: filter
       in: query
       # Deep nested arrays are undefined https://github.com/OAI/OpenAPI-Specification/issues/1706