Skip to content

Commit ad35e20

Browse files
author
Josh Sager
committed
Review of Longview documentation
ARB-644 #done
1 parent ef0f014 commit ad35e20

File tree

1 file changed

+37
-32
lines changed

1 file changed

+37
-32
lines changed

openapi.yaml

Lines changed: 37 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -823,7 +823,7 @@ paths:
823823
- account
824824
summary: Create OAuth Client
825825
description: >
826-
Create a new OAuth Client, which can be used to allow users to login to
826+
Creates a new OAuth Client, which can be used to allow users to login to
827827
your own applications using their Linode account, and optionally grant
828828
your application some amount of access to their Linodes or other entities.
829829
operationId: createClient
@@ -1430,7 +1430,7 @@ paths:
14301430
- account:read_only
14311431
responses:
14321432
'200':
1433-
description: Returns a Transfer object.
1433+
description: Returns a single Transfer object.
14341434
content:
14351435
application/json:
14361436
schema:
@@ -2213,7 +2213,7 @@ paths:
22132213
- domains:read_write
22142214
summary: Update Domain Record
22152215
description: >
2216-
Update a single Record on this Domain.
2216+
Updates a single Record on this Domain.
22172217
operationId: updateDomainRecord
22182218
x-linode-cli-action: records-update
22192219
requestBody:
@@ -4231,7 +4231,7 @@ paths:
42314231
- Linode Instances
42324232
summary: Delete IPv4 Address
42334233
description: >
4234-
Delete a public IPv4 address associated with this Linode. This will
4234+
Deletes a public IPv4 address associated with this Linode. This will
42354235
fail if it is the Linode's last remaining IP address. Private
42364236
IPv4 addresses cannot be removed via this endpoint.
42374237
operationId: removeLinodeIP
@@ -5172,8 +5172,8 @@ paths:
51725172
- longview
51735173
summary: Create Longview Client
51745174
description: >
5175-
Create a new Longview Client. This client will not begin monitoring
5176-
the status of one of your servers until you configure the Longview
5175+
Creates a new Longview Client. This Client will not begin monitoring
5176+
the status of your server until you configure the Longview
51775177
Client application on your server using the returning `install_code`
51785178
and `api_key`.
51795179
operationId: createLongviewClient
@@ -5256,7 +5256,7 @@ paths:
52565256
summary: Update Longview Client
52575257
description: >
52585258
Updates a Longview Client. This cannot update how it monitors your
5259-
server - use the Longview Client application on your server for
5259+
server; use the Longview Client application on your server for
52605260
monitoring configuration.
52615261
operationId: updateLongviewClient
52625262
x-linode-cli-action: update
@@ -5298,9 +5298,14 @@ paths:
52985298
- longview
52995299
summary: Delete Longview Client
53005300
description: >
5301-
Deletes a Longview Client from your Account. All information stored
5302-
for this client will be lost. This _does not_ uninstall the Longview
5303-
Client application for your server - you must do that manually.
5301+
Deletes a Longview Client from your Account.
5302+
5303+
5304+
**All information stored for this client will be lost.**
5305+
5306+
5307+
This _does not_ uninstall the Longview Client application for your
5308+
server - you must do that manually.
53045309
operationId: deleteLongviewClient
53055310
x-linode-cli-action: delete
53065311
security:
@@ -5336,7 +5341,7 @@ paths:
53365341
summary: List Longview Subscriptions
53375342
description: >
53385343
Returns a paginated list of available Longview Subscriptions. This is
5339-
a public endpoint, and requires no authentication.
5344+
a public endpoint and requires no authentication.
53405345
operationId: getLongviewSubscriptions
53415346
x-linode-cli-action: subscriptions-list
53425347
responses:
@@ -8328,7 +8333,7 @@ paths:
83288333
- account:read_only
83298334
responses:
83308335
'200':
8331-
description: Returns a SupportTicket object.
8336+
description: Returns a single SupportTicket object.
83328337
content:
83338338
application/json:
83348339
schema:
@@ -10438,7 +10443,7 @@ components:
1043810443
unitprice:
1043910444
type: integer
1044010445
readOnly: true
10441-
description: The monthly service fee, in US Dollars, for this Item.
10446+
description: The monthly service fee in US Dollars for this Item.
1044210447
example: 10
1044310448
IPAddress:
1044410449
type: object
@@ -11520,27 +11525,27 @@ components:
1152011525
description: >
1152111526
The apps this Client is monitoring on your server. This is configured
1152211527
when you install the Longview Client application, and is present here
11523-
only for your information.
11528+
for information purposes only.
1152411529
readOnly: true
1152511530
properties:
1152611531
apache:
1152711532
type: boolean
1152811533
description: >
11529-
If true, the Apache Longview Client module is monitoring Apache on
11534+
If True, the Apache Longview Client module is monitoring Apache on
1153011535
your server.
1153111536
example: true
1153211537
readOnly: true
1153311538
nginx:
1153411539
type: boolean
1153511540
description: >
11536-
If true, the nginx Longview Client module is monitoring nginx on
11541+
If True, the Nginx Longview Client module is monitoring Nginx on
1153711542
your server.
1153811543
example: false
1153911544
readOnly: true
1154011545
mysql:
1154111546
type: boolean
1154211547
description: >
11543-
If true, the MySQL Longview Client modules is monitoring MySQL on
11548+
If True, the MySQL Longview Client modules is monitoring MySQL on
1154411549
your server.
1154511550
example: true
1154611551
readOnly: true
@@ -11568,42 +11573,42 @@ components:
1156811573
id:
1156911574
type: string
1157011575
description: >
11571-
The unique ID of this subscription tier.
11576+
The unique ID of this Subscription tier.
1157211577
example: longview-10
1157311578
readOnly: true
1157411579
x-linode-cli-display: 1
1157511580
price:
1157611581
type: object
1157711582
description: >
11578-
Pricing information about this Longview Subscription tier.
11583+
Pricing information about this Subscription tier.
1157911584
readOnly: true
1158011585
x-linode-cli-display: 4
1158111586
properties:
1158211587
hourly:
1158311588
type: number
1158411589
description: >
11585-
The hourly price for this subscription tier, in US Dollars.
11590+
The hourly price in US dollars for this Subscription tier.
1158611591
example: 0.06
1158711592
readOnly: true
1158811593
monthly:
1158911594
type: number
1159011595
description: >
11591-
The maximum monthly price for this subscription tier, in US
11592-
Dollars. You will never be charged more than this amount per
11596+
The maximum monthly price in US Dollars for this Subscription tier.
11597+
You will never be charged more than this amount per
1159311598
month for this subscription.
1159411599
example: 40
1159511600
readOnly: true
1159611601
label:
1159711602
type: string
1159811603
description: >
11599-
A display name for this subscription tier.
11604+
A display name for this Subscription tier.
1160011605
example: Longivew Pro 10 pack
1160111606
readOnly: true
1160211607
x-linode-cli-display: 2
1160311608
clients_included:
1160411609
type: integer
1160511610
description: >
11606-
The number of Longview Clients that may be created with this tier.
11611+
The number of Longview Clients that may be created with this Subscription tier.
1160711612
example: 10
1160811613
readOnly: true
1160911614
x-linode-cli-display: 3
@@ -12538,7 +12543,7 @@ components:
1253812543
usd:
1253912544
type: string
1254012545
description: >
12541-
The amount, in US Dollars, of the payment.
12546+
The amount in US Dollars of the Payment.
1254212547
example: '120.50'
1254312548
PayPal:
1254412549
type: object
@@ -12547,27 +12552,27 @@ components:
1254712552
- redirect_url
1254812553
- usd
1254912554
description: >
12550-
An object representing the staging of a payment via PayPal.
12555+
An object representing the staging of a Payment via PayPal.
1255112556
properties:
1255212557
cancel_url:
1255312558
type: string
12554-
description: The URL to have PayPal redirect to when payment is cancelled.
12559+
description: The URL to have PayPal redirect to when Payment is cancelled.
1255512560
example: https://example.org
1255612561
redirect_url:
1255712562
type: string
12558-
description: The URL to have PayPal redirect to when payment is approved.
12563+
description: The URL to have PayPal redirect to when Payment is approved.
1255912564
example: https://example.org
1256012565
usd:
1256112566
type: string
12562-
description: The amount, in US dollars, of the payment.
12567+
description: The amount, in US dollars, of the Payment.
1256312568
example: '120.50'
1256412569
PayPalExecute:
1256512570
type: object
1256612571
required:
1256712572
- payer_id
1256812573
- payment_id
1256912574
description: >
12570-
An object representing an execution of payment to PayPal to capture the
12575+
An object representing an execution of Payment to PayPal to capture the
1257112576
funds and credit your Linode Account.
1257212577
properties:
1257312578
payer_id:
@@ -12732,8 +12737,8 @@ components:
1273212737
credit:
1273312738
type: integer
1273412739
description: >
12735-
The amount of account credit issued to you through the referral
12736-
program, in US Dollars.
12740+
The amount of account credit in US Dollars issued to you through
12741+
the referral program.
1273712742
example: 0
1273812743
readOnly: true
1273912744
ip_whitelist_enabled:

0 commit comments

Comments
 (0)