Merge pull request #495 from bbiggerr/202-response

Add 202 response

Author: bbiggerr

openapi.yaml

@@ -154,6 +154,7 @@ info:
     | STATUS  | DESCRIPTION |
     |---------|-------------|
     | 200 OK  | The request was successful. |
+    | 202 Accepted | The request was successful, but processing has not been completed. The response body includes a "warnings" array containing the details of incomplete processes. |
     | 204 No Content | The server successfully fulfilled the request and there is no additional content to send. |
     | 400 Bad Request | You submitted an invalid request (missing parameters, etc.). |
     | 401 Unauthorized | You failed to authenticate for this resource. |
@@ -1916,6 +1917,8 @@ paths:
             application/json:
               schema:
                   $ref: '#/components/schemas/Payment'
+        '202':
+          $ref: '#/components/responses/WarningResponse'
         default:
           $ref: '#/components/responses/ErrorResponse'
       x-code-samples:
@@ -2070,6 +2073,8 @@ paths:
             application/json:
              schema:
                type: object
+        '202':
+          $ref: '#/components/responses/WarningResponse'
         default:
           $ref: '#/components/responses/ErrorResponse'
       x-code-samples:
@@ -15662,6 +15667,20 @@ components:
                 type: array
                 items:
                   $ref: '#/components/schemas/ErrorObject'
+    WarningResponse:
+      description: |
+        Accepted with warning.
+
+        A warning object is included with the standard 200 response.
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              warnings:
+                type: array
+                items:
+                  $ref: '#/components/schemas/WarningObject'
   parameters:
     pageOffset:
       name: page
@@ -22230,6 +22249,21 @@ components:
           example:
           - example tag
           - another example
+    WarningObject:
+      type: object
+      description: >
+        An object for describing a single warning for incomplete processing associated with an accepted request.
+      properties:
+        title:
+          type: string
+          description: >
+            The general warning message.
+          example: Unable to reboot Linode.
+        details:
+          type: string
+          description: >
+            Specific information related to the warning.
+          example: Linode 123 could not be rebooted.
 tags:
   - name: Account
     description: Use the Account endpoints to manage user settings, billing, and payments. You can also initiate and maintain OAuth client application authentication, enable the Linode Managed service, and create new users on your account.