Merge branch 'development' into bugfix/add-missing-default-to-user-defined-field

Dorthu · GitHub Enterprise · commit e217c058e1c1 · 2018-06-20T11:28:21.000-04:00
diff --git a/index.html b/index.html
@@ -18,7 +18,7 @@
     </style>
   </head>
   <body>
-    <redoc spec-url="/openapi.yaml" expand-responses="200" hide-download-button path-in-middle-panel required-props-first></redoc>
+    <redoc spec-url="/openapi.yaml" expand-responses="200" hide-download-button path-in-middle-panel required-props-first no-auto-auth></redoc>
     <script src="/redoc.standalone.js"> </script>
   </body>
 </html>
diff --git a/openapi.yaml b/openapi.yaml
@@ -28,7 +28,7 @@ info:
     [View our Changelog](/changelog) to see release
     notes on all changes made to our API.
 
-    # Access
+    # Access and Authentication
 
     Some endpoints are publicly accessible without requiring authentication.
     All endpoints affecting your Account, however, require either a Personal
@@ -44,6 +44,12 @@ info:
     All scopes for the OAuth security model (defined below) apply to this
     security model as well.
 
+    ### Authentication
+
+    | Security Scheme Type: | HTTP |
+    |-----------------------|------|
+    | **HTTP Authorization Scheme** | bearer |
+
     ## OAuth
 
     The OAuth workflow is a three-step process to authenticate a User before an
@@ -91,10 +97,11 @@ info:
     Authorization: Bearer 03d084436a6c91fbafd5c4b20c82e5056a2e9ce1635920c30dc8d81dc7a6665c
     ```
 
-    ## Authentication Schema
+    ### Authentication
 
-    See our [Authentication Schema](/#section/Authentication) for
-    information on scopes and authorization/token URLs.
+    | Security Scheme Type: | Oauth2 |
+    |-----------------------|--------|
+    | **AuthorizationCode Oauth Flow** |  **Authorization URL:** https://login.linode.com/oauth/authorize<br />**Token URL:** https://login.linode.com/oauth/token<br />**Scopes:**<br /><ul><li>`account:read_only` - Allows access to GET information about your Account.</li><li>`account:read_write` - Allows access to all endpoints related to your Account.</li><li>`domains:read_only` - Allows access to GET Domains on your Account.</li><li>`domains:read_write` - Allows access to all Domain endpoints.</li><li>`events:read_only` - Allows access to GET your Events.</li><li>`events:read_write` - Allows access to all endpoints related to your Events.</li><li>`images:read_only` - Allows access to GET your Images.</li><li>`images:read_write` - Allows access to all endpoints related to your Images.</li><li>`ips:read_only` - Allows access to GET your ips.</li><li>`ips:read_write` - Allows access to all endpoints related to your ips.</li><li>`linodes:read_only` - Allows access to GET Linodes on your Account.</li><li>`linodes:read_write` - Allow access to all endpoints related to your Linodes.</li><li>`longview:read_only` - Allows access to GET your Longview Clients.</li><li>`longview:read_write` - Allows access to all endpoints related to your Longview Clients.</li><li>`nodebalancers:read_only` - Allows access to GET NodeBalancers on your Account.</li><li>`nodebalancers:read_write` - Allows access to all NodeBalancer endpoints.</li><li>`stackscripts:read_only` - Allows access to GET your StackScripts.</li><li>`stackscripts:read_write` - Allows access to all endpoints related to your StackScripts.</li><li>`volumes:read_only` - Allows access to GET your Volumes.</li><li>`volumes:read_write` - Allows access to all endpoints related to your Volumes.</li></ul><br />|
 
     # Requests
 
@@ -2678,14 +2685,11 @@ paths:
         content:
           application/json:
             schema:
-              type: object
               required:
               - type
               - region
-              allOf:
-              - $ref: '#/components/schemas/LinodeRequest'
-              - $ref: '#/components/schemas/LinodeBase'
-              - properties:
+              type: object
+              properties:
                   backup_id:
                     type: integer
                     example: 1234
@@ -2715,13 +2719,13 @@ paths:
                   type:
                     type: string
                     description: >
-                      The type of Linode to deploy.
-                    readOnly: false
+                      The [Linode Type](#operation/getLinodeTypes) of the Linode
+                      you are creating.
                   region:
                     type: string
                     description: >
-                      The Region to deploy this Linode in.
-                    readOnly: false
+                      The [Region](#operation/getRegions) where the Linode
+                      will be located.
       responses:
         '200':
           description: >
@@ -5013,7 +5017,12 @@ paths:
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/StackScript'
+              required:
+              - script
+              - label
+              - images
+              allOf:
+              - $ref: '#/components/schemas/StackScript'
       responses:
         '200':
           description: StackScript successfully created.
@@ -7099,6 +7108,25 @@ paths:
                   $ref: '#/components/schemas/NodeBalancer/properties/label'
                 client_conn_throttle:
                   $ref: '#/components/schemas/NodeBalancer/properties/client_conn_throttle'
+                configs:
+                  type: array
+                  description: >
+                    The ports to configure this NodeBalancer with on creation.
+                    Each config must have a unique port and at least one Node.
+                  items:
+                      allOf:
+                      - $ref: '#/components/schemas/NodeBalancerConfig'
+                      - type: object
+                        properties:
+                          nodes:
+                            type: array
+                            description: >
+                              The NodeBalancer Nodes that serve this port.  When
+                              creating a NodeBalancer this way, at least one Node
+                              is required per configured port.
+                            items:
+                              $ref: '#/components/schemas/NodeBalancerNode'
+
       responses:
         '200':
           description: NodeBalancer created successfully.
@@ -8399,8 +8427,6 @@ paths:
         content:
           application/json:
             schema:
-              required:
-              - label
               properties:
                 scopes:
                   type: string
@@ -10874,6 +10900,7 @@ components:
           x-linode-cli-display: 1
         gateway:
           type: string
+          nullable: true
           format: ip
           description: >
             The default gateway for this address.
@@ -11264,6 +11291,7 @@ components:
         image:
           x-linode-filterable: true
           readOnly: true
+          nullable: true
           allOf:
           - $ref: '#/components/schemas/DiskRequest/properties/image'
           x-linode-cli-display: 6
@@ -11458,6 +11486,7 @@ components:
               properties:
                 day:
                   type: string
+                  nullable: true
                   description: |
                     The day of the week that your Linode's weekly Backup is taken.
                     If not set manually, a day will be chosen for you. Backups
@@ -11479,6 +11508,7 @@ components:
                   - Saturday
                 window:
                   type: string
+                  nullable: true
                   description: |
                     The window in which your backups will be taken, in UTC. A
                     backups window is a two-hour span of time in which the backup
@@ -13308,6 +13338,7 @@ components:
           example: keys_only
         authorized_keys:
           type: array
+          nullable: true
           items:
             type: string
             format: ssh-key
@@ -13507,6 +13538,7 @@ components:
         closed:
           x-linode-filterable: true
           type: string
+          nullable: true
           format: date-time
           readOnly: true
           description: >
@@ -13527,6 +13559,7 @@ components:
           x-linode-cli-display: 5
         entity:
           type: object
+          nullable: true
           readOnly: true
           description: >
             The entity this Ticket was opened for.
@@ -13609,6 +13642,7 @@ components:
           example: '2015-06-04T16:07:03'
         updated_by:
           type: string
+          nullable: true
           readOnly: true
           description: >
             The User who last updated this Ticket.
@@ -13943,6 +13977,7 @@ components:
           x-linode-cli-display: 5
         linode_id:
           type: integer
+          nullable: true
           description: >
             If a Volume is attached to a specific Linode, the ID of that Linode
             will be displayed here.
