Skip to content

Commit 5014632

Browse files
authored
Updates for DC Get Well Acct Availability (#939)
1 parent c3a5b98 commit 5014632

File tree

1 file changed

+28
-17
lines changed

1 file changed

+28
-17
lines changed

openapi.yaml

Lines changed: 28 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -548,16 +548,17 @@ paths:
548548
get:
549549
tags:
550550
- account
551+
parameters:
552+
- $ref: '#/components/parameters/pageOffset'
553+
- $ref: '#/components/parameters/pageSize'
551554
summary: Account Availability
552555
description: |
553-
Returns service unavailability for all available regions.
556+
Returns a paginated list of the services available to you, for all Linode regions.
554557

555-
Only authorized Users can access this endpoint.
556-
557-
*This endpoint is currently in **Beta**, and should not be used for production workloads.*
558+
**Note**: Only authorized Users can access this endpoint.
558559
operationId: getAvailability
559560
servers:
560-
- url: https://api.linode.com/v4beta
561+
- url: https://api.linode.com/v4
561562
security:
562563
- personalAccessToken: []
563564
- oauth:
@@ -567,7 +568,7 @@ paths:
567568
responses:
568569
'200':
569570
description: |
570-
Returns a paginated list of regions and their unavailable resources.
571+
List of regions and the services available in each.
571572
content:
572573
application/json:
573574
schema:
@@ -594,7 +595,7 @@ paths:
594595
parameters:
595596
- name: id
596597
in: path
597-
description: The id of the data center.
598+
description: The slug for the applicable data center. Run the [GET /regions](/docs/api/regions/#regions-list) operation to view the slug for each data center.
598599
required: true
599600
schema:
600601
type: string
@@ -603,12 +604,12 @@ paths:
603604
- account
604605
summary: Region Service Availability
605606
description: |
606-
Returns a single region's service availability.
607+
View the available services for your account in a specific region.
607608

608-
Only authorized Users can access this.
609+
**Note**: Only authorized users can access this.
609610
operationId: getAccountAvailability
610611
servers:
611-
- url: https://api.linode.com/v4beta
612+
- url: https://api.linode.com/v4
612613
security:
613614
- personalAccessToken: []
614615
- oauth:
@@ -617,7 +618,7 @@ paths:
617618
x-linode-grant: read_only
618619
responses:
619620
'200':
620-
description: Returns an object with a region and the region's unavailable resources.
621+
description: The services available in the specified region.
621622
content:
622623
application/json:
623624
schema:
@@ -20846,20 +20847,30 @@ components:
2084620847
type: string
2084720848
readOnly: true
2084820849
description: >
20849-
Displays the data center represented by a slug.
20850+
The Akamai cloud computing data center (region), represented by a slug value. You can view a full list of regions and their associated slugs via the [GET /regions](/docs/api/regions/#regions-list) endpoint.
2085020851
example: us-east
2085120852
x-linode-cli-display: 1
20852-
unavailable:
20853+
available:
2085320854
type: array
20855+
items:
20856+
type: string
2085420857
readOnly: true
20855-
description: >
20856-
A list of strings of unavailable services.
20858+
description: |
20859+
A list of services *available* to your account in the `region`.
2085720860
example:
2085820861
- "Linodes"
20859-
- "Block Storage"
20862+
- "NodeBalancers"
20863+
unavailable:
20864+
type: array
2086020865
items:
2086120866
type: string
20862-
x-linode-cli-display: 2
20867+
readOnly: true
20868+
description: >
20869+
A list of services *unavailable* to your account in the `region`.
20870+
example:
20871+
- "Kubernetes"
20872+
- "Block Storage"
20873+
x-linode-cli-display: 3
2086320874
AccountSettings:
2086420875
type: object
2086520876
description: Account Settings object

0 commit comments

Comments
 (0)