Skip to content

Commit 83cba90

Browse files
author
Josh Sager
committed
Sidebar descriptions, removed v4 ref, def err response, helpful error
ARB-605 #done ARB-610 #done ARB-612 #done ARB-613 #done * Finalized descriptive sidebar nav with specific verb rules * Removed reference to "v4" in our spec title * Removed description in ErrorResponse so it doesn't appear in every default response * Changed "Helpeful error message goes here" to a generic error response
1 parent 428d221 commit 83cba90

File tree

1 file changed

+18
-28
lines changed

1 file changed

+18
-28
lines changed

openapi.yaml

Lines changed: 18 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
openapi: 3.0.1
22
info:
33
version: 4.0.0
4-
title: Linode API V4
4+
title: Linode API
55
description: |
66
This is Linode's next generation API. The API was designed around the concepts of REST and does
77
its best to conform to a RESTful model whenever possible. When not possible the goal was to be
@@ -313,7 +313,7 @@ paths:
313313
- $ref: '#/components/parameters/pageSize'
314314
tags:
315315
- account
316-
summary: Returns a paginated list of InvoiceItem objects identified by `invoiceId`.
316+
summary: List Invoice Items
317317
description: Returns a paginated list of Invoice items.
318318
operationId: getInvoiceItems
319319
security:
@@ -1115,7 +1115,7 @@ paths:
11151115
x-linode-grant: add_domains
11161116
tags:
11171117
- domains
1118-
summary: Manage Domain
1118+
summary: Create Domain
11191119
description: >
11201120
Adds a new domain to Linode's DNS Manager. Linode is not a registrar, and
11211121
you must own the domain before adding it here. Be sure to point your
@@ -1180,7 +1180,7 @@ paths:
11801180
x-linode-grant: read_write
11811181
tags:
11821182
- domains
1183-
summary: Update Domain Zone
1183+
summary: Update Domain
11841184
description: |
11851185
Update information about a domain in Linode's DNS Manager.
11861186
operationId: updateDomain
@@ -1536,10 +1536,6 @@ paths:
15361536
default:
15371537
$ref: '#/components/responses/ErrorResponse'
15381538
/linode/instances:
1539-
summary: A collection of your Linodes.
1540-
description: >
1541-
A collection of Linodes you have access to. Through this collection you can create servers and
1542-
view servers active on your account.
15431539
get:
15441540
x-linode-grant: read_only
15451541
parameters:
@@ -1788,7 +1784,7 @@ paths:
17881784
type: integer
17891785
get:
17901786
x-linode-grant: read_only
1791-
summary: View Linode's Backups
1787+
summary: List Backups
17921788
description: >
17931789
Returns information about this Linode's available backups.
17941790
tags:
@@ -1873,7 +1869,7 @@ paths:
18731869
type: integer
18741870
post:
18751871
x-linode-grant: read_write
1876-
summary: Cancel Linode's Backups
1872+
summary: Cancel Backups
18771873
description: >
18781874
Cancels the backup service on the given Linode.
18791875
tags:
@@ -1902,7 +1898,7 @@ paths:
19021898
type: integer
19031899
post:
19041900
x-linode-grant: read_write
1905-
summary: Enable Linode's Backups
1901+
summary: Enable Backups
19061902
description: >
19071903
Enables backups for the specified Linode.
19081904
tags:
@@ -1972,7 +1968,7 @@ paths:
19721968
type: integer
19731969
post:
19741970
x-linode-grant: read_write
1975-
summary: Restore Linode's Backup
1971+
summary: Restore Backup
19761972
description: >
19771973
Restores a Linode's backup to the specified Linode.
19781974
tags:
@@ -2346,7 +2342,7 @@ paths:
23462342
- $ref: '#/components/parameters/pageSize'
23472343
tags:
23482344
- linode/instances
2349-
summary: View Linode's Disks
2345+
summary: List Disks
23502346
description: >
23512347
View Disk information for disks associated with this Linode.
23522348
operationId: getLinodeDisks
@@ -2871,7 +2867,7 @@ paths:
28712867
get:
28722868
tags:
28732869
- linode/kernels
2874-
summary: View kernel
2870+
summary: View Kernel
28752871
description: >
28762872
Get information about a single kernel.
28772873
operationId: getKernel
@@ -2895,7 +2891,7 @@ paths:
28952891
format: int32
28962892
post:
28972893
x-linode-grant: read_write
2898-
summary: Upgrade Linode Generation
2894+
summary: Upgrade Linode
28992895
description: >
29002896
Linodes created with now-deprecated types are entitled to a free
29012897
upgrade to the next generation. A mutating Linode will be allocated any new
@@ -3396,7 +3392,7 @@ paths:
33963392
get:
33973393
tags:
33983394
- linode/types
3399-
summary: List Linode Types
3395+
summary: List Types
34003396
description: >
34013397
Returns collection of Linode types, including pricing and
34023398
specifications for each type. These are used when creating or resizing
@@ -3429,7 +3425,7 @@ paths:
34293425
get:
34303426
tags:
34313427
- linode/types
3432-
summary: View Linode Type
3428+
summary: View Type
34333429
description: >
34343430
Returns information about a specific Linode type, including pricing and
34353431
specifications. This is used when creating or resizing a Linode.
@@ -3948,7 +3944,7 @@ paths:
39483944
- $ref: '#/components/parameters/pageSize'
39493945
tags:
39503946
- managed
3951-
summary: List Managed Service Issues
3947+
summary: List Managed Issues
39523948
description: >
39533949
Returns a paginated list of recent and ongoing issues detected on your
39543950
Managed Services.
@@ -3987,7 +3983,7 @@ paths:
39873983
x-linode-grant: unrestricted only
39883984
tags:
39893985
- managed
3990-
summary: View Managed Service Issue
3986+
summary: View Managed Issue
39913987
description: >
39923988
Returns a single issue that is impacting or did impact one of your
39933989
Managed Services.
@@ -5855,12 +5851,6 @@ paths:
58555851
default:
58565852
$ref: '#/components/responses/ErrorResponse'
58575853
/volumes:
5858-
summary: List Volumes
5859-
description: >
5860-
A collection of Volumes you have access to. Through this collection you
5861-
can view Volumes active on your account, create new Volumes, resize an
5862-
existing Volume to a higher capacity, attach and detach a Volume to/from
5863-
a Linode, and clone an existing Volume.
58645854
get:
58655855
x-linode-grant: read_only
58665856
parameters:
@@ -6051,7 +6041,7 @@ paths:
60516041
type: integer
60526042
format: int32
60536043
post:
6054-
summary: Attach Volume to Linode
6044+
summary: Attach Volume
60556045
description: >
60566046
This endpoint allows you to attach a Volume on your account
60576047
to an existing Linode on your account. In order for this request to
@@ -7036,14 +7026,14 @@ components:
70367026
changing the data you sent in the request, but in some cases you will be instructed to
70377027
open a support ticket or perform some other action before you can complete the request
70387028
successfully.
7039-
example: Helpful error message goes here.
7029+
example: `fieldname` must be a valid value
70407030
field:
70417031
type: string
70427032
description: >
70437033
The field in the request that caused this error. This may be a path, separated by
70447034
periods in the case of nested fields. In some cases this may come back as "null" if the
70457035
error is not specific to any single element of the request.
7046-
example: null
7036+
example: fieldname
70477037
Event:
70487038
type: object
70497039
description: >

0 commit comments

Comments
 (0)