Skip to content

Commit 476bec6

Browse files
committed
Added Beta Program commands
1 parent ef82cae commit 476bec6

File tree

1 file changed

+316
-1
lines changed

1 file changed

+316
-1
lines changed

openapi.yaml

Lines changed: 316 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -532,6 +532,146 @@ paths:
532532
--state PA \
533533
--tax_id ATU99999999 \
534534
--zip 19102
535+
/account/betas:
536+
x-linode-cli-command: betas
537+
get:
538+
tags:
539+
- Beta Programs
540+
summary: Enrolled Beta Programs List
541+
operationId: getEnrolledBetaPrograms
542+
servers:
543+
- url: https://api.linode.com/v4
544+
security:
545+
- personalAccessToken: []
546+
- oauth:
547+
- account:read_only
548+
x-linode-cli-action: enrolled-list
549+
x-linode-grant: unrestricted only
550+
parameters:
551+
- $ref: '#/components/parameters/pageOffset'
552+
- $ref: '#/components/parameters/pageSize'
553+
description: |
554+
Display all enrolled Beta Programs for your Account. Includes inactive as well as active Beta Programs.
555+
556+
Only unrestricted Users can access this command.
557+
responses:
558+
'200':
559+
description: Returns a paginated list of all enrolled Beta Program objects for the Account.
560+
content:
561+
application/json:
562+
schema:
563+
allOf:
564+
- $ref: '#/components/schemas/PaginationEnvelope'
565+
- type: object
566+
properties:
567+
data:
568+
type: array
569+
items:
570+
$ref: '#/components/schemas/BetaProgramEnrolled'
571+
default:
572+
$ref: '#/components/responses/ErrorResponse'
573+
x-code-samples:
574+
- lang: Shell
575+
source: >
576+
curl https://api.linode.com/v4/account/betas \
577+
-H "Authorization: Bearer $TOKEN"
578+
- lang: CLI
579+
source: >
580+
linode-cli betas enrolled-list
581+
post:
582+
tags:
583+
- Linode Types
584+
summary: Beta Program Enroll
585+
operationId: enrollBetaProgram
586+
servers:
587+
- url: https://api.linode.com/v4
588+
security:
589+
- personalAccessToken: []
590+
- oauth:
591+
- account:read_write
592+
x-linode-cli-action: enroll
593+
x-linode-grant: unrestricted only
594+
description: |
595+
Enroll your Account in an active Beta Program.
596+
597+
Only unrestricted Users can access this command.
598+
599+
To view active Beta Programs, use the Beta Programs List command.
600+
601+
Active Beta Programs may have a limited number of enrollments. If a Beta Program has reached is maximum number of enrollments, an error is returned even though the request is successful.
602+
603+
Beta Programs with `"greenlight_only": true` can only be enrolled by Accounts that participate in the [Greenlight](https://www.linode.com/green-light/) program.
604+
requestBody:
605+
description: Updated information for the Managed MySQL Database.
606+
required: true
607+
content:
608+
application/json:
609+
schema:
610+
required:
611+
- id
612+
type: object
613+
description: The Beta Program ID to enroll in for your Account.
614+
properties:
615+
id:
616+
$ref: '#/components/schemas/BetaProgram/properties/id'
617+
responses:
618+
'200':
619+
description: Enrollment request successful.
620+
content:
621+
application/json:
622+
schema:
623+
type: object
624+
default:
625+
$ref: '#/components/responses/ErrorResponse'
626+
x-code-samples:
627+
- lang: Shell
628+
source: >
629+
curl https://api.linode.com/v4/account/betas \
630+
-H "Authorization: Bearer $TOKEN" \
631+
-X POST -d '{
632+
"id": "example_open"
633+
}'
634+
- lang: CLI
635+
source: >
636+
linode-cli betas enroll --id example_open
637+
/account/betas/{betaId}:
638+
x-linode-cli-command: betas
639+
get:
640+
tags:
641+
- Beta Programs
642+
summary: Enrolled Beta Program View
643+
operationId: getEnrolledBetaProgram
644+
servers:
645+
- url: https://api.linode.com/v4
646+
security:
647+
- personalAccessToken: []
648+
- oauth:
649+
- account:read_only
650+
x-linode-cli-action: enrolled-view
651+
x-linode-grant: unrestricted only
652+
parameters:
653+
- $ref: '#/components/parameters/betaId'
654+
description: |
655+
Display an enrolled Beta Program for your Account. The Beta Program may be inactive.
656+
657+
Only unrestricted Users can access this command.
658+
responses:
659+
'200':
660+
description: Returns an enrolled Beta Program object for the Account.
661+
content:
662+
application/json:
663+
schema:
664+
$ref: '#/components/schemas/BetaProgramEnrolled'
665+
default:
666+
$ref: '#/components/responses/ErrorResponse'
667+
x-code-samples:
668+
- lang: Shell
669+
source: >
670+
curl https://api.linode.com/v4/account/betas/$betaId \
671+
-H "Authorization: Bearer $TOKEN"
672+
- lang: CLI
673+
source: >
674+
linode-cli betas enrolled-view $betaId
535675
/account/cancel:
536676
x-linode-cli-command: account
537677
post:
@@ -3118,6 +3258,88 @@ paths:
31183258
]
31193259
}' \
31203260
https://api.linode.com/v4/account/users/example_user/grants
3261+
/betas:
3262+
x-linode-cli-command: betas
3263+
get:
3264+
tags:
3265+
- Beta Programs
3266+
summary: Beta Programs List
3267+
operationId: getBetaPrograms
3268+
servers:
3269+
- url: https://api.linode.com/v4
3270+
security:
3271+
- personalAccessToken: []
3272+
- oauth: []
3273+
x-linode-cli-action: list
3274+
x-linode-grant: unrestricted only
3275+
parameters:
3276+
- $ref: '#/components/parameters/pageOffset'
3277+
- $ref: '#/components/parameters/pageSize'
3278+
description: |
3279+
Display all active Beta Programs.
3280+
3281+
Only unrestricted Users can access this command.
3282+
responses:
3283+
'200':
3284+
description: Returns a paginated list of all available Beta Program objects.
3285+
content:
3286+
application/json:
3287+
schema:
3288+
allOf:
3289+
- $ref: '#/components/schemas/PaginationEnvelope'
3290+
- type: object
3291+
properties:
3292+
data:
3293+
type: array
3294+
items:
3295+
$ref: '#/components/schemas/BetaProgram'
3296+
default:
3297+
$ref: '#/components/responses/ErrorResponse'
3298+
x-code-samples:
3299+
- lang: Shell
3300+
source: >
3301+
curl https://api.linode.com/v4/betas \
3302+
-H "Authorization: Bearer $TOKEN"
3303+
- lang: CLI
3304+
source: >
3305+
linode-cli betas list
3306+
/betas/{betaId}:
3307+
x-linode-cli-command: betas
3308+
get:
3309+
tags:
3310+
- Beta Programs
3311+
summary: Beta Program View
3312+
operationId: getBetaProgram
3313+
servers:
3314+
- url: https://api.linode.com/v4
3315+
security:
3316+
- personalAccessToken: []
3317+
- oauth: []
3318+
x-linode-cli-action: view
3319+
x-linode-grant: unrestricted only
3320+
parameters:
3321+
- $ref: '#/components/parameters/betaId'
3322+
description: |
3323+
Display information about a Beta Program. This command can be used to access inactive as well as active Beta Programs.
3324+
3325+
Only unrestricted Users can access this command.
3326+
responses:
3327+
'200':
3328+
description: Returns a paginated list of all available Beta Program objects.
3329+
content:
3330+
application/json:
3331+
schema:
3332+
$ref: '#/components/schemas/BetaProgram'
3333+
default:
3334+
$ref: '#/components/responses/ErrorResponse'
3335+
x-code-samples:
3336+
- lang: Shell
3337+
source: >
3338+
curl https://api.linode.com/v4/betas/$betaId \
3339+
-H "Authorization: Bearer $TOKEN"
3340+
- lang: CLI
3341+
source: >
3342+
linode-cli beta view $betaId
31213343
/databases/engines:
31223344
x-linode-cli-command: databases
31233345
get:
@@ -18787,6 +19009,13 @@ components:
1878719009
items:
1878819010
$ref: '#/components/schemas/ErrorObject'
1878919011
parameters:
19012+
betaId:
19013+
name: betaId
19014+
in: path
19015+
description: The ID of the Beta Program.
19016+
required: true
19017+
schema:
19018+
type: string
1879019019
pageOffset:
1879119020
name: page
1879219021
in: query
@@ -19239,6 +19468,90 @@ components:
1923919468
readOnly: true
1924019469
description: >
1924119470
A list of the disks that are part of the Backup.
19471+
BetaProgram:
19472+
type: object
19473+
description: An object representing Beta Program information.
19474+
properties:
19475+
id:
19476+
type: string
19477+
description: The unique identifier of the Beta Program.
19478+
example: example_open
19479+
x-linode-cli-display: 1
19480+
label:
19481+
type: string
19482+
readOnly: true
19483+
x-linode-filterable: true
19484+
description: The name of the Beta Program.
19485+
example: Example Open Beta
19486+
x-linode-cli-display: 2
19487+
description:
19488+
type: string
19489+
readOnly: true
19490+
nullable: true
19491+
description: Additional details regarding the Beta Program.
19492+
example: "This is an open public beta for an example feature."
19493+
x-linode-cli-display: 3
19494+
greenlight_only:
19495+
type: boolean
19496+
readOnly: true
19497+
x-linode-filterable: true
19498+
description: Whether the Beta Program requires [Green Light](https://www.linode.com/green-light/) participation for enrollment.
19499+
example: true
19500+
x-linode-cli-display: 4
19501+
started:
19502+
type: string
19503+
format: date-time
19504+
readOnly: true
19505+
x-linode-filterable: true
19506+
description: The start date-time of the Beta Program.
19507+
example: '2023-07-11T00:00:00'
19508+
x-linode-cli-display: 5
19509+
ended:
19510+
type: string
19511+
format: date-time
19512+
readOnly: true
19513+
nullable: true
19514+
x-linode-filterable: true
19515+
description: |
19516+
The date-time that the Beta Program ended.
19517+
19518+
`null` indicates that the Beta Program is ongoing.
19519+
example: null
19520+
x-linode-cli-display: 6
19521+
more_info:
19522+
type: string
19523+
readOnly: true
19524+
nullable: true
19525+
description: Additional source of information for the Beta Program.
19526+
example: https://www.linode.com/green-light/
19527+
x-linode-cli-display: 7
19528+
BetaProgramEnrolled:
19529+
type: object
19530+
description: An object representing an enrolled Beta Program for the Account.
19531+
properties:
19532+
id:
19533+
$ref: '#/components/schemas/BetaProgram/properties/id'
19534+
x-linode-cli-display: 1
19535+
label:
19536+
$ref: '#/components/schemas/BetaProgram/properties/label'
19537+
x-linode-cli-display: 2
19538+
description:
19539+
$ref: '#/components/schemas/BetaProgram/properties/description'
19540+
x-linode-cli-display: 3
19541+
started:
19542+
$ref: '#/components/schemas/BetaProgram/properties/started'
19543+
x-linode-cli-display: 4
19544+
ended:
19545+
$ref: '#/components/schemas/BetaProgram/properties/ended'
19546+
x-linode-cli-display: 5
19547+
enrolled:
19548+
type: string
19549+
format: date-time
19550+
readOnly: true
19551+
x-linode-filterable: true
19552+
description: The date-time of Account enrollment to the Beta Program.
19553+
example: '2023-09-11T00:00:00'
19554+
x-linode-cli-display: 6
1924219555
CreditCard:
1924319556
type: object
1924419557
description: |
@@ -19504,7 +19817,7 @@ components:
1950419817
x-linode-cli-display: 2
1950519818
created:
1950619819
type: string
19507-
format: datetime
19820+
format: date-time
1950819821
example: '2022-01-01T00:01:01'
1950919822
description: A time value given in a combined date and time format that represents when the database backup was created.
1951019823
x-linode-filterable: true
@@ -26533,6 +26846,8 @@ components:
2653326846
tags:
2653426847
- name: Account
2653526848
description: Use the Account endpoints to manage user settings, billing, and payments. You can also initiate and maintain OAuth client application authentication, enable the Linode Managed service, and create new users on your account.
26849+
- name: Beta Programs
26850+
description: Use the Beta Programs endpoint to view information to view information about available beta programs. To sign up for eligible beta programs, use the [Beta Program Join]() Account command.
2653626851
- name: Databases
2653726852
description: Managed Databases is Linode's fully-managed, high-performance database service. Use the Managed Databases endpoints to create and manage database clusters.
2653826853
- name: Domains

0 commit comments

Comments
 (0)