Merge pull request #2 from mbeyt/add-ons

fix formatting

Author: mbeyt

specification/resources/addons/addons_delete.yml

@@ -20,6 +20,9 @@ responses:
   '401':
     $ref: '../../shared/responses/unauthorized.yml'
 
+  '404':
+    $ref: '../../shared/responses/not_found.yml'
+
   '429':
     $ref: '../../shared/responses/too_many_requests.yml'
 

specification/resources/addons/addons_get.yml

@@ -1,4 +1,4 @@
-operation: addons_get
+operationId: addons_get
 
 summary: Get details on an Add-On Resource
 
@@ -13,6 +13,7 @@ parameters:
   - name: resource_uuid
     in: path
     required: true
+    example: "123e4567-e89b-12d3-a456-426614174000"
     schema:
       type: string
     description: The UUID of the add-on resource to retrieve.
@@ -24,6 +25,9 @@ responses:
   '401':
     $ref: '../../shared/responses/unauthorized.yml'
 
+  '404':
+    $ref: '../../shared/responses/not_found.yml'
+
   '429':
     $ref: '../../shared/responses/too_many_requests.yml'
 

specification/resources/addons/addons_get_app_metadata.yml

@@ -13,6 +13,7 @@ parameters:
   - name: app_slug
     in: path
     required: true
+    example: example_app
     schema:
       type: string
     description: The slug identifier for the application whose metadata is being requested.
@@ -24,6 +25,9 @@ responses:
   '401':
     $ref: '../../shared/responses/unauthorized.yml'
 
+  '404':
+    $ref: '../../shared/responses/not_found.yml'
+
   '429':
     $ref: '../../shared/responses/too_many_requests.yml'
 

specification/resources/addons/addons_list.yml

@@ -1,4 +1,4 @@
-operation: addons_list
+operationId: addons_list
 
 summary: List all Add-On Resources
 

specification/resources/addons/addons_update.yml

@@ -1,4 +1,4 @@
-operation: addons_update
+operationId: addons_patch
 
 summary: Update the name for an Add-On Resource
 
@@ -13,6 +13,7 @@ parameters:
   - name: resource_uuid
     in: path
     required: true
+    example: "123e4567-e89b-12d3-a456-426614174000"
     schema:
       type: string
     description: The UUID of the add-on resource to rename.
@@ -40,6 +41,9 @@ responses:
   '401':
     $ref: '../../shared/responses/unauthorized.yml'
 
+  '404':
+    $ref: '../../shared/responses/not_found.yml'
+
   '429':
     $ref: '../../shared/responses/too_many_requests.yml'
 

specification/resources/addons/addons_update_plan.yml

@@ -1,4 +1,4 @@
-operation: addons_update_plan
+operationId: addons_patch_plan
 
 summary: Update the plan for an Add-On Resource
 
@@ -13,6 +13,7 @@ parameters:
   - name: resource_uuid
     in: path
     required: true
+    example: "123e4567-e89b-12d3-a456-426614174000"
     schema:
       type: string
     description: The UUID of the add-on resource to update.
@@ -40,6 +41,9 @@ responses:
   '401':
     $ref: '../../shared/responses/unauthorized.yml'
 
+  '404':
+    $ref: '../../shared/responses/not_found.yml'
+
   '429':
     $ref: '../../shared/responses/too_many_requests.yml'
 

specification/resources/addons/models/addons_app_metadata.yml

@@ -37,6 +37,10 @@ properties:
   options:
     title: options
     type: array
+    example:
+      - "US"
+      - "UK"
+      - "CA"
     items:
       type: string
       example: "UK"

specification/resources/addons/models/addons_feature.yml

@@ -38,6 +38,7 @@ properties:
     description: Unit of measurement for the feature, if applicable. Units apply to allowance features.
 
   value:
+    example: "Unlimited"
     oneOf:
       - title: string_value
         type: string

specification/resources/addons/models/addons_resource_metadata.yml

@@ -8,6 +8,7 @@ properties:
     description: The name of the metadata item to be set.
 
   value:
+    example: "example_value"
     oneOf:
       - title: string_value
         type: string