Skip to content

Commit abbd580

Browse files
Josh SagerGitHub Enterprise
authored andcommitted
Merge branch 'development' into nullable-linodes
2 parents ab8b242 + 54719d3 commit abbd580

File tree

2 files changed

+23
-8
lines changed

2 files changed

+23
-8
lines changed

index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
</style>
1919
</head>
2020
<body>
21-
<redoc spec-url="/openapi.yaml" expand-responses="200" hide-download-button path-in-middle-panel required-props-first></redoc>
21+
<redoc spec-url="/openapi.yaml" expand-responses="200" hide-download-button path-in-middle-panel required-props-first no-auto-auth></redoc>
2222
<script src="/redoc.standalone.js"> </script>
2323
</body>
2424
</html>

openapi.yaml

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ info:
2828
[View our Changelog](/changelog) to see release
2929
notes on all changes made to our API.
3030
31-
# Access
31+
# Access and Authentication
3232
3333
Some endpoints are publicly accessible without requiring authentication.
3434
All endpoints affecting your Account, however, require either a Personal
@@ -44,6 +44,12 @@ info:
4444
All scopes for the OAuth security model (defined below) apply to this
4545
security model as well.
4646
47+
### Authentication
48+
49+
| Security Scheme Type: | HTTP |
50+
|-----------------------|------|
51+
| **HTTP Authorization Scheme** | bearer |
52+
4753
## OAuth
4854
4955
The OAuth workflow is a three-step process to authenticate a User before an
@@ -91,10 +97,11 @@ info:
9197
Authorization: Bearer 03d084436a6c91fbafd5c4b20c82e5056a2e9ce1635920c30dc8d81dc7a6665c
9298
```
9399
94-
## Authentication Schema
100+
### Authentication
95101
96-
See our [Authentication Schema](/#section/Authentication) for
97-
information on scopes and authorization/token URLs.
102+
| Security Scheme Type: | Oauth2 |
103+
|-----------------------|--------|
104+
| **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 />|
98105
99106
# Requests
100107
@@ -5010,7 +5017,12 @@ paths:
50105017
content:
50115018
application/json:
50125019
schema:
5013-
$ref: '#/components/schemas/StackScript'
5020+
required:
5021+
- script
5022+
- label
5023+
- images
5024+
allOf:
5025+
- $ref: '#/components/schemas/StackScript'
50145026
responses:
50155027
'200':
50165028
description: StackScript successfully created.
@@ -8396,8 +8408,6 @@ paths:
83968408
content:
83978409
application/json:
83988410
schema:
8399-
required:
8400-
- label
84018411
properties:
84028412
scopes:
84038413
type: string
@@ -13309,6 +13319,7 @@ components:
1330913319
example: keys_only
1331013320
authorized_keys:
1331113321
type: array
13322+
nullable: true
1331213323
items:
1331313324
type: string
1331413325
format: ssh-key
@@ -13508,6 +13519,7 @@ components:
1350813519
closed:
1350913520
x-linode-filterable: true
1351013521
type: string
13522+
nullable: true
1351113523
format: date-time
1351213524
readOnly: true
1351313525
description: >
@@ -13528,6 +13540,7 @@ components:
1352813540
x-linode-cli-display: 5
1352913541
entity:
1353013542
type: object
13543+
nullable: true
1353113544
readOnly: true
1353213545
description: >
1353313546
The entity this Ticket was opened for.
@@ -13610,6 +13623,7 @@ components:
1361013623
example: '2015-06-04T16:07:03'
1361113624
updated_by:
1361213625
type: string
13626+
nullable: true
1361313627
readOnly: true
1361413628
description: >
1361513629
The User who last updated this Ticket.
@@ -13939,6 +13953,7 @@ components:
1393913953
x-linode-cli-display: 5
1394013954
linode_id:
1394113955
type: integer
13956+
nullable: true
1394213957
description: >
1394313958
If a Volume is attached to a specific Linode, the ID of that Linode
1394413959
will be displayed here.

0 commit comments

Comments
 (0)