From 0788592cbb73dd7d663b40bd065bd28fe5741392 Mon Sep 17 00:00:00 2001 From: Matt Wildman Date: Fri, 1 Aug 2025 09:06:06 -0400 Subject: [PATCH] Update openapi.json file (2025-08-01) --- openapi.json | 22040 +++++++++++++++++++++++++++++-------------------- 1 file changed, 13089 insertions(+), 8951 deletions(-) diff --git a/openapi.json b/openapi.json index 43d548c12..920a0ce09 100644 --- a/openapi.json +++ b/openapi.json @@ -12,6 +12,9 @@ "v4beta" ], "type": "string" + }, + "x-akamai": { + "file-path": "parameters/api-version-path.yaml" } }, "beta-id": { @@ -21,6 +24,9 @@ "required": true, "schema": { "type": "string" + }, + "x-akamai": { + "file-path": "parameters/beta-id.yaml" } }, "client-id-path": { @@ -30,6 +36,9 @@ "required": true, "schema": { "type": "string" + }, + "x-akamai": { + "file-path": "parameters/client-id-path.yaml" } }, "client-id-path-ecf807fb": { @@ -39,6 +48,9 @@ "required": true, "schema": { "type": "string" + }, + "x-akamai": { + "file-path": "parameters/client-id-path-ecf807fb.yaml" } }, "eeuid": { @@ -48,6 +60,9 @@ "required": true, "schema": { "type": "string" + }, + "x-akamai": { + "file-path": "parameters/eeuid.yaml" } }, "event-id-path-214cd042": { @@ -58,6 +73,9 @@ "schema": { "example": 824, "type": "integer" + }, + "x-akamai": { + "file-path": "parameters/event-id-path-214cd042.yaml" } }, "event-id-path-39255fcf": { @@ -68,6 +86,9 @@ "schema": { "example": 824, "type": "integer" + }, + "x-akamai": { + "file-path": "parameters/event-id-path-39255fcf.yaml" } }, "id-path": { @@ -77,6 +98,9 @@ "required": true, "schema": { "type": "string" + }, + "x-akamai": { + "file-path": "parameters/id-path.yaml" } }, "invoice-id-path": { @@ -87,6 +111,9 @@ "schema": { "example": 387, "type": "integer" + }, + "x-akamai": { + "file-path": "parameters/invoice-id-path.yaml" } }, "login-id-path": { @@ -97,6 +124,9 @@ "schema": { "example": 863, "type": "integer" + }, + "x-akamai": { + "file-path": "parameters/login-id-path.yaml" } }, "page-offset": { @@ -109,6 +139,9 @@ "example": 6, "minimum": 1, "type": "integer" + }, + "x-akamai": { + "file-path": "parameters/page-offset.yaml" } }, "page-size": { @@ -121,6 +154,9 @@ "maximum": 500, "minimum": 25, "type": "integer" + }, + "x-akamai": { + "file-path": "parameters/page-size.yaml" } }, "payment-id-path": { @@ -131,6 +167,9 @@ "schema": { "example": 627, "type": "integer" + }, + "x-akamai": { + "file-path": "parameters/payment-id-path.yaml" } }, "payment-method-id-path-6078bc7b": { @@ -141,6 +180,9 @@ "schema": { "example": 267, "type": "integer" + }, + "x-akamai": { + "file-path": "parameters/payment-method-id-path-6078bc7b.yaml" } }, "payment-method-id-path-fb39a844": { @@ -151,6 +193,9 @@ "schema": { "example": 267, "type": "integer" + }, + "x-akamai": { + "file-path": "parameters/payment-method-id-path-fb39a844.yaml" } }, "token-path-f857f5a2": { @@ -161,6 +206,9 @@ "schema": { "format": "uuid", "type": "string" + }, + "x-akamai": { + "file-path": "parameters/token-path-f857f5a2.yaml" } }, "token-path-faf66b58": { @@ -171,6 +219,9 @@ "schema": { "format": "uuid", "type": "string" + }, + "x-akamai": { + "file-path": "parameters/token-path-faf66b58.yaml" } }, "username-path": { @@ -180,6 +231,9 @@ "required": true, "schema": { "type": "string" + }, + "x-akamai": { + "file-path": "parameters/username-path.yaml" } } }, @@ -205,14 +259,20 @@ "type": "array" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/added-post-cancel-account-409.yaml" + } }, "x-example": { "x-ref": "../examples/tbd.json" } } }, - "description": "Could not charge the credit card on file." + "description": "Could not charge the credit card on file.", + "x-akamai": { + "file-path": "errors/409.yaml" + } }, "504-account-cancel": { "content": { @@ -235,14 +295,20 @@ "type": "array" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/added-post-cancel-account-504.yaml" + } }, "x-example": { "x-ref": "../examples/tbd.json" } } }, - "description": "Account is taking longer than expected to cancel." + "description": "Account is taking longer than expected to cancel.", + "x-akamai": { + "file-path": "errors/504-account-cancel.yaml" + } }, "accepted-response": { "content": { @@ -266,7 +332,10 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/warning-object.yaml" + } }, "type": "array" } @@ -299,7 +368,10 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/warning-object.yaml" + } }, "type": "array" } @@ -332,7 +404,10 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/error-object.yaml" + } }, "type": "array" } @@ -352,7 +427,7 @@ "active_promotions": { "items": { "additionalProperties": false, - "description": "Promotions generally offer a set amount of credit that can be used toward your Linode services, and the promotion expires after a specified date. As well, a monthly cap on the promotional offer is set.\n\nSimply put, a promotion offers a certain amount of credit month, until either the expiration date is passed, or until the total promotional credit is used, whichever comes first.", + "description": "__Read-only__ Promotions generally offer a set amount of credit that can be used toward your Linode services, and the promotion expires after a specified date. As well, a monthly cap on the promotional offer is set.\n\nSimply put, a promotion offers a certain amount of credit month, until either the expiration date is passed, or until the total promotional credit is used, whichever comes first.", "properties": { "credit_monthly_cap": { "description": "The amount available to spend per month.", @@ -418,13 +493,16 @@ } }, "readOnly": true, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/promotion.yaml" + } }, "readOnly": true, "type": "array" }, "active_since": { - "description": "The date and time the account was activated.", + "description": "__Read-only__ The date and time the account was activated.", "example": "2018-01-01T00:01:01", "format": "date-time", "readOnly": true, @@ -443,21 +521,21 @@ "type": "string" }, "balance": { - "description": "This account's balance, in US dollars.", + "description": "__Read-only__ This account's balance, in US dollars.", "example": 200, "readOnly": true, "type": "number", "x-linode-cli-display": 4 }, "balance_uninvoiced": { - "description": "This account's current estimated invoice in US dollars. This is not your final invoice balance. Transfer charges are not included in the estimate.", + "description": "__Read-only__ This account's current estimated invoice in US dollars. This is not your final invoice balance. Transfer charges are not included in the estimate.", "example": 145, "readOnly": true, "type": "number", "x-linode-cli-display": 4 }, "billing_source": { - "description": "The source of service charges for this account. Accounts that are associated with Akamai-specific customers return a value of `akamai`. All other accounts return a value of `linode`.", + "description": "__Read-only__ The source of service charges for this account. Accounts that are associated with Akamai-specific customers return a value of `akamai`. All other accounts return a value of `linode`.", "enum": [ "akamai", "linode" @@ -467,7 +545,7 @@ "type": "string" }, "capabilities": { - "description": "The Akamai Cloud Computing services your account supports.", + "description": "__Read-only__ The Akamai Cloud Computing services your account supports.", "example": [ "Linodes", "NodeBalancers", @@ -501,7 +579,7 @@ }, "credit_card": { "additionalProperties": false, - "description": "The credit card information assigned to this account.", + "description": "__Read-only__ The credit card information assigned to this account.", "properties": { "expiry": { "description": "The expiration month and year of the `credit_card`.", @@ -525,7 +603,7 @@ "x-linode-cli-display": 3 }, "euuid": { - "description": "An external unique identifier for this account.", + "description": "__Read-only__ An external unique identifier for this account.", "example": "E1AF5EEC-526F-487D-B317EBEB34C87D71", "format": "uuid", "readOnly": true, @@ -569,14 +647,17 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/account.yaml" + } }, "account-availability": { "additionalProperties": false, "description": "Account Service Availability object.", "properties": { "available": { - "description": "A list of services _available_ to your account in the `region`.", + "description": "__Read-only__ A list of services _available_ to your account in the `region`.", "example": [ "Linodes", "NodeBalancers" @@ -588,14 +669,14 @@ "type": "array" }, "region": { - "description": "The Akamai cloud computing data center (region), represented by a slug value. You can view a full list of regions and their associated slugs with the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation.", + "description": "__Read-only__ The Akamai cloud computing data center (region), represented by a slug value. You can view a full list of regions and their associated slugs with the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation.", "example": "us-east", "readOnly": true, "type": "string", "x-linode-cli-display": 1 }, "unavailable": { - "description": "A list of services _unavailable_ to your account in the `region`.", + "description": "__Read-only__ A list of services _unavailable_ to your account in the `region`.", "example": [ "Kubernetes", "Block Storage" @@ -608,7 +689,10 @@ "x-linode-cli-display": 3 } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/account-availability.yaml" + } }, "account-settings": { "additionalProperties": false, @@ -621,7 +705,7 @@ "x-linode-cli-display": 4 }, "interfaces_for_new_linodes": { - "description": "Defines if new Linodes can use legacy configuration interfaces:\n- `legacy_config_only`. All new Linodes need to use legacy configuration interfaces. Prevously created Linodes with Linode Interfaces can still exist. Linodes using legacy configuration interfaces can't be upgraded to use Linode Interfaces.\n- `legacy_config_default_but_linode_allowed`. New Linodes can use legacy configuration interfaces or Linode Interfaces, depending on the `interface_generation` setting specified when creating the Linode. By default, new Linodes use legacy configuration interfaces unless otherwise specified. Linodes that use legacy configuration interfaces can upgrade to Linode Interfaces. This is the default setting for existing accounts.\n- `linode_default_but_legacy_config_allowed`. New Linodes can use legacy configuration interfaces or Linode Interfaces, depending on the `interface_generation` setting specified when creating the Linode. By default, new Linodes use Linode Interfaces unless otherwise specified. Linodes that use legacy configuration interfaces can upgrade to Linode interfaces. This is the default setting for new accounts.\n- `linode_only`. All new Linodes need to use Linode Interfaces. Prevously created Linodes with legacy configuration profile interfaces can still exist if they were created under a previous setting. Linodes using legacy configuration interfaces can be upgraded to Linode Interfaces.", + "description": "__Beta__ Defines if new Linodes can use legacy configuration interfaces:\n- `legacy_config_only`. All new Linodes need to use legacy configuration interfaces. Prevously created Linodes with Linode Interfaces can still exist. Linodes using legacy configuration interfaces can't be upgraded to use Linode Interfaces.\n- `legacy_config_default_but_linode_allowed`. New Linodes can use legacy configuration interfaces or Linode Interfaces, depending on the `interface_generation` setting specified when creating the Linode. By default, new Linodes use legacy configuration interfaces unless otherwise specified. Linodes that use legacy configuration interfaces can upgrade to Linode Interfaces. This is the default setting for existing accounts.\n- `linode_default_but_legacy_config_allowed`. New Linodes can use legacy configuration interfaces or Linode Interfaces, depending on the `interface_generation` setting specified when creating the Linode. By default, new Linodes use Linode Interfaces unless otherwise specified. Linodes that use legacy configuration interfaces can upgrade to Linode interfaces. This is the default setting for new accounts.\n- `linode_only`. All new Linodes need to use Linode Interfaces. Prevously created Linodes with legacy configuration profile interfaces can still exist if they were created under a previous setting. Linodes using legacy configuration interfaces can be upgraded to Linode Interfaces.", "enum": [ "legacy_config_only", "legacy_config_default_but_linode_allowed", @@ -636,14 +720,14 @@ "x-linode-cli-display": 6 }, "longview_subscription": { - "description": "The Longview Pro tier you are currently subscribed to. The value must be a [Longview subscription](https://techdocs.akamai.com/linode-api/reference/get-longview-subscriptions) ID or `null` for Longview Free.", + "description": "__Read-only__ The Longview Pro tier you are currently subscribed to. The value must be a [Longview subscription](https://techdocs.akamai.com/linode-api/reference/get-longview-subscriptions) ID or `null` for Longview Free.", "example": "longview-3", "readOnly": true, "type": "string", "x-linode-cli-display": 2 }, "managed": { - "description": "Our 24/7 incident response service. This robust, multi-homed monitoring system distributes monitoring checks to ensure that your servers remain online and available at all times. Linode Managed can monitor any service or software stack reachable over TCP or HTTP. Once you add a service to Linode Managed, we'll monitor it for connectivity, response, and total request time.", + "description": "__Read-only__ Our 24/7 incident response service. This robust, multi-homed monitoring system distributes monitoring checks to ensure that your servers remain online and available at all times. Linode Managed can monitor any service or software stack reachable over TCP or HTTP. Once you add a service to Linode Managed, we'll monitor it for connectivity, response, and total request time.", "example": true, "readOnly": true, "type": "boolean", @@ -657,7 +741,7 @@ }, "object_storage": { "default": "disabled", - "description": "A string describing the status of this account's Object Storage service enrollment.", + "description": "__Read-only__ A string describing the status of this account's Object Storage service enrollment.", "enum": [ "disabled", "suspended", @@ -669,12 +753,18 @@ "x-linode-cli-display": 5 } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/account-settings.yaml" + } }, "added-empty-obj": { "description": "The API responds with an empty object.", "maxProperties": 0, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/added-empty-obj.yaml" + } }, "added-get-account-logins-200": { "additionalProperties": false, @@ -685,7 +775,7 @@ "description": "An object representing a previous successful login for a User.", "properties": { "datetime": { - "description": "When the login was initiated.", + "description": "__Read-only__ When the login was initiated.", "example": "2018-01-01T00:01:01", "format": "date-time", "readOnly": true, @@ -693,14 +783,14 @@ "x-linode-cli-display": 2 }, "id": { - "description": "The unique ID of this login object.", + "description": "__Read-only__ The unique ID of this login object.", "example": 1234, "readOnly": true, "type": "integer", "x-linode-cli-display": 1 }, "ip": { - "description": "The remote IP address that requested the login.", + "description": "__Read-only__ The remote IP address that requested the login.", "example": "192.0.2.0", "format": "ip", "readOnly": true, @@ -708,14 +798,14 @@ "x-linode-cli-display": 3 }, "restricted": { - "description": "True if the User that attempted the login was a restricted User, false otherwise.", + "description": "__Read-only__ True if the User that attempted the login was a restricted User, false otherwise.", "example": true, "readOnly": true, "type": "boolean", "x-linode-cli-display": 6 }, "status": { - "description": "Whether the login attempt succeeded or failed.", + "description": "__Read-only__ Whether the login attempt succeeded or failed.", "enum": [ "successful", "failed" @@ -726,37 +816,43 @@ "x-linode-cli-display": 5 }, "username": { - "description": "The username of the User that attempted the login.", + "description": "__Read-only__ The username of the User that attempted the login.", "example": "example_user", "readOnly": true, "type": "string", "x-linode-cli-display": 4 } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/login.yaml" + } }, "type": "array" }, "page": { - "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { - "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "results": { - "description": "The total number of results.", + "description": "__Read-only__ The total number of results.", "example": 1, "readOnly": true, "type": "integer" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/added-get-account-logins-200.yaml" + } }, "added-get-availability-200": { "allOf": [ @@ -769,7 +865,7 @@ "description": "Account Service Availability object.", "properties": { "available": { - "description": "A list of services _available_ to your account in the `region`.", + "description": "__Read-only__ A list of services _available_ to your account in the `region`.", "example": [ "Linodes", "NodeBalancers" @@ -781,14 +877,14 @@ "type": "array" }, "region": { - "description": "The Akamai cloud computing data center (region), represented by a slug value. You can view a full list of regions and their associated slugs with the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation.", + "description": "__Read-only__ The Akamai cloud computing data center (region), represented by a slug value. You can view a full list of regions and their associated slugs with the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation.", "example": "us-east", "readOnly": true, "type": "string", "x-linode-cli-display": 1 }, "unavailable": { - "description": "A list of services _unavailable_ to your account in the `region`.", + "description": "__Read-only__ A list of services _unavailable_ to your account in the `region`.", "example": [ "Kubernetes", "Block Storage" @@ -801,7 +897,10 @@ "x-linode-cli-display": 3 } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/account-availability.yaml" + } }, "type": "array" } @@ -813,27 +912,33 @@ "description": "An envelope for paginated response. When accessing a collection through a GET endpoint, the results are wrapped in this envelope which includes metadata about those results. Results are presented within a `data` array. See [Pagination](https://techdocs.akamai.com/linode-api/reference/pagination) for more information.", "properties": { "page": { - "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { - "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "results": { - "description": "The total number of results.", + "description": "__Read-only__ The total number of results.", "example": 1, "readOnly": true, "type": "integer" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/pagination-envelope.yaml" + } } - ] + ], + "x-akamai": { + "file-path": "schemas/added-get-availability-200.yaml" + } }, "added-get-child-accounts-200": { "additionalProperties": false, @@ -844,14 +949,14 @@ "description": "Child account object.", "properties": { "active_since": { - "description": "The activation date and time for the child account.", + "description": "__Read-only__ The activation date and time for the child account.", "example": "2018-01-01T00:01:01", "format": "date-time", "readOnly": true, "type": "string" }, "address_1": { - "description": "First line of this child account's billing address.", + "description": "__Filterable__ First line of this child account's billing address.", "example": "123 Main Street", "maxLength": 64, "type": "string", @@ -863,7 +968,7 @@ "x-linode-filterable": true }, "address_2": { - "description": "Second line of this child account's billing address, if applicable.", + "description": "__Filterable__ Second line of this child account's billing address, if applicable.", "example": "Suite A", "maxLength": 64, "type": "string", @@ -875,21 +980,21 @@ "x-linode-filterable": true }, "balance": { - "description": "This child account's balance, in US dollars.", + "description": "__Read-only__ This child account's balance, in US dollars.", "example": 200, "readOnly": true, "type": "number", "x-linode-cli-display": 4 }, "balance_uninvoiced": { - "description": "This child account's current estimated invoice in US dollars. This is not your final invoice balance. Transfer charges are not included in the estimate.", + "description": "__Read-only__ This child account's current estimated invoice in US dollars. This is not your final invoice balance. Transfer charges are not included in the estimate.", "example": 145, "readOnly": true, "type": "number", "x-linode-cli-display": 4 }, "billing_source": { - "description": "The source of service charges for this account, as determined by its relationship with Akamai. The API returns a value of `external` to describe a child account in a parent-child account environment.", + "description": "__Read-only__ The source of service charges for this account, as determined by its relationship with Akamai. The API returns a value of `external` to describe a child account in a parent-child account environment.", "enum": [ "external" ], @@ -898,7 +1003,7 @@ "type": "string" }, "capabilities": { - "description": "A list of the capabilities the child account supports.", + "description": "__Read-only__ A list of the capabilities the child account supports.", "example": [ "Linodes", "NodeBalancers", @@ -912,7 +1017,7 @@ "type": "array" }, "city": { - "description": "The city for this child account's billing address.", + "description": "__Filterable__ The city for this child account's billing address.", "example": "San Diego", "maxLength": 24, "type": "string", @@ -924,7 +1029,7 @@ "x-linode-filterable": true }, "company": { - "description": "The company name for the owner of this child account. It can't include any of these characters: `<` `>` `(` `)` `\"` `=`. You can't change this value yourself. We use it to create the proxy users that a parent account uses to access a child account. Talk to your account team if you need to change this value.", + "description": "__Filterable__ The company name for the owner of this child account. It can't include any of these characters: `<` `>` `(` `)` `\"` `=`. You can't change this value yourself. We use it to create the proxy users that a parent account uses to access a child account. Talk to your account team if you need to change this value.", "example": "Acme", "maxLength": 128, "type": "string", @@ -936,7 +1041,7 @@ "x-linode-filterable": true }, "country": { - "description": "The two-letter ISO 3166 country code for this child account's billing address.", + "description": "__Filterable__ The two-letter ISO 3166 country code for this child account's billing address.", "example": "US", "type": "string", "x-akamai": { @@ -948,7 +1053,7 @@ }, "credit_card": { "additionalProperties": false, - "description": "Information for the credit card you've assigned to this child account.", + "description": "__Read-only__ Information for the credit card you've assigned to this child account.", "properties": { "expiry": { "description": "The expiration month and year of the credit card.", @@ -965,7 +1070,7 @@ "type": "object" }, "email": { - "description": "The email address of the owner of this child account.", + "description": "__Filterable__ The email address of the owner of this child account.", "example": "john.smith@linode.com", "maxLength": 128, "type": "string", @@ -978,14 +1083,14 @@ "x-linode-filterable": true }, "euuid": { - "description": "An external, unique identifier that Akamai assigned to the child account.", + "description": "__Read-only__ An external, unique identifier that Akamai assigned to the child account.", "example": "A1BC2DEF-34GH-567I-J890KLMN12O34P56", "format": "uuid", "readOnly": true, "type": "string" }, "first_name": { - "description": "The first name of the owner of this child account. It can't include any of these characters: `<` `>` `(` `)` `\"` `=`.", + "description": "__Filterable__ The first name of the owner of this child account. It can't include any of these characters: `<` `>` `(` `)` `\"` `=`.", "example": "John", "maxLength": 50, "type": "string", @@ -998,7 +1103,7 @@ "x-linode-filterable": true }, "last_name": { - "description": "The last name of the owner of this child account. It can't include any of these characters: `<` `>` `(` `)` `\"` `=`.", + "description": "__Filterable__ The last name of the owner of this child account. It can't include any of these characters: `<` `>` `(` `)` `\"` `=`.", "example": "Smith", "maxLength": 50, "type": "string", @@ -1011,7 +1116,7 @@ "x-linode-filterable": true }, "phone": { - "description": "The phone number for the owner of this child account.", + "description": "__Filterable__ The phone number for the owner of this child account.", "example": "858-555-1212", "maxLength": 32, "type": "string", @@ -1023,7 +1128,7 @@ "x-linode-filterable": true }, "state": { - "description": "The state or province for the billing address (`address_1` and `address_2, if applicable`). If in the United States (US) or Canada (CA), this is the two-letter ISO 3166 State or Province code.\n\n> \ud83d\udcd8\n>\n> If this is a US military address, use state abbreviations (AA, AE, AP).", + "description": "__Filterable__ The state or province for the billing address (`address_1` and `address_2, if applicable`). If in the United States (US) or Canada (CA), this is the two-letter ISO 3166 State or Province code.\n\n> \ud83d\udcd8\n>\n> If this is a US military address, use state abbreviations (AA, AE, AP).", "example": "CA", "maxLength": 24, "type": "string", @@ -1041,7 +1146,7 @@ "type": "string" }, "zip": { - "description": "The zip code of this Account's billing address. The following restrictions apply:\n\n- Can only contain ASCII letters, numbers, and hyphens (`-`).\n- Can't contain more than 9 letter or number characters.", + "description": "__Filterable__ The zip code of this Account's billing address. The following restrictions apply:\n\n- Can only contain ASCII letters, numbers, and hyphens (`-`).\n- Can't contain more than 9 letter or number characters.", "example": "92111-1234", "type": "string", "x-akamai": { @@ -1052,30 +1157,36 @@ "x-linode-filterable": true } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/child-account.yaml" + } }, "type": "array" }, "page": { - "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { - "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "results": { - "description": "The total number of results.", + "description": "__Read-only__ The total number of results.", "example": 1, "readOnly": true, "type": "integer" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/added-get-child-accounts-200.yaml" + } }, "added-get-clients-200": { "additionalProperties": false, @@ -1086,14 +1197,14 @@ "description": "A third-party application registered to Linode that users may log into with their Linode account through our authentication server at [login.linode.com](https://login.linode.com). Using an OAuth Client, a third-party developer may be given access to some, or all, of a User's account for the purposes of their application.", "properties": { "id": { - "description": "The OAuth Client ID. This is used to identify the client, and is a publicly known value (it is not a secret).", + "description": "__Read-only__ The OAuth Client ID. This is used to identify the client, and is a publicly known value (it is not a secret).", "example": "2737bf16b39ab5d7b4a1", "readOnly": true, "type": "string", "x-linode-cli-display": 1 }, "label": { - "description": "The name of this application. This will be presented to users when they are asked to grant it access to their Account.", + "description": "__Filterable__ The name of this application. This will be presented to users when they are asked to grant it access to their Account.", "example": "Test_Client_1", "maxLength": 512, "minLength": 1, @@ -1108,7 +1219,7 @@ }, "public": { "default": false, - "description": "If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the [OAuth spec](https://oauth.net/2/) for more details.", + "description": "__Filterable__ If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the [OAuth spec](https://oauth.net/2/) for more details.", "example": false, "type": "boolean", "x-akamai": { @@ -1127,13 +1238,13 @@ "x-linode-cli-display": 5 }, "secret": { - "description": "The OAuth Client secret, used in the OAuth exchange. This is returned as `` except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly.", + "description": "__Read-only__ The OAuth Client secret, used in the OAuth exchange. This is returned as `` except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly.", "example": "", "readOnly": true, "type": "string" }, "status": { - "description": "The status of this application. `active` by default.", + "description": "__Read-only__ The status of this application. `active` by default.", "enum": [ "active", "disabled", @@ -1149,7 +1260,7 @@ "x-linode-cli-display": 3 }, "thumbnail_url": { - "description": "The URL where this client's thumbnail may be viewed, or `null` if this client does not have a thumbnail set.", + "description": "__Read-only__ The URL where this client's thumbnail may be viewed, or `null` if this client does not have a thumbnail set.", "example": "https://api.linode.com/v4/account/clients/2737bf16b39ab5d7b4a1/thumbnail", "format": "url", "nullable": true, @@ -1157,30 +1268,36 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/oauth-client.yaml" + } }, "type": "array" }, "page": { - "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { - "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "results": { - "description": "The total number of results.", + "description": "__Read-only__ The total number of results.", "example": 1, "readOnly": true, "type": "integer" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/added-get-clients-200.yaml" + } }, "added-get-enrolled-beta-programs-200": { "allOf": [ @@ -1189,25 +1306,28 @@ "description": "An envelope for paginated response. When accessing a collection through a GET endpoint, the results are wrapped in this envelope which includes metadata about those results. Results are presented within a `data` array. See [Pagination](https://techdocs.akamai.com/linode-api/reference/pagination) for more information.", "properties": { "page": { - "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { - "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "results": { - "description": "The total number of results.", + "description": "__Read-only__ The total number of results.", "example": 1, "readOnly": true, "type": "integer" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/pagination-envelope.yaml" + } }, { "properties": { @@ -1217,7 +1337,7 @@ "description": "An object representing an enrolled Beta Program for the Account.", "properties": { "description": { - "description": "Additional details regarding the Beta Program.", + "description": "__Read-only__ Additional details regarding the Beta Program.", "example": "This is an open public beta for an example feature.", "nullable": true, "readOnly": true, @@ -1225,7 +1345,7 @@ "x-linode-cli-display": 3 }, "ended": { - "description": "The date-time that the Beta Program ended.\n\n`null` indicates that the Beta Program is ongoing.", + "description": "__Filterable__, __Read-only__ The date-time that the Beta Program ended.\n\n`null` indicates that the Beta Program is ongoing.", "example": null, "format": "date-time", "nullable": true, @@ -1240,7 +1360,7 @@ "x-linode-filterable": true }, "enrolled": { - "description": "The date-time of Account enrollment to the Beta Program.", + "description": "__Filterable__, __Read-only__ The date-time of Account enrollment to the Beta Program.", "example": "2023-09-11T00:00:00", "format": "date-time", "readOnly": true, @@ -1260,7 +1380,7 @@ "x-linode-cli-display": 1 }, "label": { - "description": "The name of the Beta Program.", + "description": "__Filterable__, __Read-only__ The name of the Beta Program.", "example": "Example Open Beta", "readOnly": true, "type": "string", @@ -1273,7 +1393,7 @@ "x-linode-filterable": true }, "started": { - "description": "The start date-time of the Beta Program.", + "description": "__Filterable__, __Read-only__ The start date-time of the Beta Program.", "example": "2023-07-11T00:00:00", "format": "date-time", "readOnly": true, @@ -1287,14 +1407,20 @@ "x-linode-filterable": true } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/beta-program-enrolled.yaml" + } }, "type": "array" } }, "type": "object" } - ] + ], + "x-akamai": { + "file-path": "schemas/added-get-enrolled-beta-programs-200.yaml" + } }, "added-get-entity-transfers-200": { "allOf": [ @@ -1303,25 +1429,28 @@ "description": "An envelope for paginated response. When accessing a collection through a GET endpoint, the results are wrapped in this envelope which includes metadata about those results. Results are presented within a `data` array. See [Pagination](https://techdocs.akamai.com/linode-api/reference/pagination) for more information.", "properties": { "page": { - "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { - "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "results": { - "description": "The total number of results.", + "description": "__Read-only__ The total number of results.", "example": 1, "readOnly": true, "type": "integer" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/pagination-envelope.yaml" + } }, { "properties": { @@ -1363,7 +1492,7 @@ "x-linode-cli-display": 3 }, "is_sender": { - "description": "If the requesting account created this transfer.", + "description": "__Filterable__ If the requesting account created this transfer.", "example": true, "type": "boolean", "x-akamai": { @@ -1375,7 +1504,7 @@ "x-linode-filterable": true }, "status": { - "description": "The status of the transfer request:\n\n`accepted`: The transfer has been accepted by another user and is currently in progress. Transfers can take up to 3 hours to complete.\n`canceled`: The transfer has been canceled by the sender.\n`completed`: The transfer has completed successfully.\n`failed`: The transfer has failed after initiation.\n`pending`: The transfer is ready to be accepted.\n`stale`: The transfer has exceeded its expiration date. It can no longer be accepted or canceled.", + "description": "__Filterable__ The status of the transfer request:\n\n`accepted`: The transfer has been accepted by another user and is currently in progress. Transfers can take up to 3 hours to complete.\n`canceled`: The transfer has been canceled by the sender.\n`completed`: The transfer has completed successfully.\n`failed`: The transfer has failed after initiation.\n`pending`: The transfer is ready to be accepted.\n`stale`: The transfer has exceeded its expiration date. It can no longer be accepted or canceled.", "enum": [ "accepted", "canceled", @@ -1417,13 +1546,19 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/entity-transfer.yaml" + } }, "type": "array" } } } - ] + ], + "x-akamai": { + "file-path": "schemas/added-get-entity-transfers-200.yaml" + } }, "added-get-invoice-items-200": { "additionalProperties": false, @@ -1434,14 +1569,14 @@ "description": "An InvoiceItem object.", "properties": { "amount": { - "description": "The price, in US dollars, of the Invoice Item. Equal to the unit price multiplied by quantity.", + "description": "__Read-only__ The price, in US dollars, of the Invoice Item. Equal to the unit price multiplied by quantity.", "example": 20.2, "readOnly": true, "type": "number", "x-linode-cli-display": 4 }, "from": { - "description": "The date the Invoice Item started, based on month.", + "description": "__Read-only__ The date the Invoice Item started, based on month.", "example": "2018-01-01T00:01:01", "format": "date-time", "readOnly": true, @@ -1449,20 +1584,20 @@ "x-linode-cli-display": 2 }, "label": { - "description": "The Invoice Item's display label.", + "description": "__Read-only__ The Invoice Item's display label.", "example": "Linode 123", "readOnly": true, "type": "string", "x-linode-cli-display": 1 }, "quantity": { - "description": "The quantity of this Item for the specified Invoice.", + "description": "__Read-only__ The quantity of this Item for the specified Invoice.", "example": 4, "readOnly": true, "type": "integer" }, "region": { - "description": "The ID of the applicable Region associated with this Invoice Item.\n\n`null` if there is no applicable Region.", + "description": "__Read-only__ The ID of the applicable Region associated with this Invoice Item.\n\n`null` if there is no applicable Region.", "example": "us-west", "nullable": true, "readOnly": true, @@ -1470,14 +1605,14 @@ "x-linode-cli-display": 7 }, "tax": { - "description": "The amount of tax levied on this Item in US Dollars.", + "description": "__Read-only__ The amount of tax levied on this Item in US Dollars.", "example": 1.25, "readOnly": true, "type": "number", "x-linode-cli-display": 5 }, "to": { - "description": "The date the Invoice Item ended, based on month.", + "description": "__Read-only__ The date the Invoice Item ended, based on month.", "example": "2018-01-31T11:59:59", "format": "date-time", "readOnly": true, @@ -1485,14 +1620,14 @@ "x-linode-cli-display": 3 }, "total": { - "description": "The price of this Item after taxes in US Dollars.", + "description": "__Read-only__ The price of this Item after taxes in US Dollars.", "example": 21.45, "readOnly": true, "type": "number", "x-linode-cli-display": 6 }, "type": { - "description": "The type of service, ether `hourly` or `misc`.", + "description": "__Read-only__ The type of service, ether `hourly` or `misc`.", "enum": [ "hourly", "misc" @@ -1502,36 +1637,42 @@ "type": "string" }, "unit_price": { - "description": "The monthly service fee in US Dollars for this Item.", + "description": "__Read-only__ The monthly service fee in US Dollars for this Item.", "example": 5.05, "readOnly": true, "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/invoice-item.yaml" + } }, "type": "array" }, "page": { - "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { - "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "results": { - "description": "The total number of results.", + "description": "__Read-only__ The total number of results.", "example": 1, "readOnly": true, "type": "integer" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/added-get-invoice-items-200.yaml" + } }, "added-get-invoices-200": { "additionalProperties": false, @@ -1542,7 +1683,7 @@ "description": "Account Invoice object.", "properties": { "billing_source": { - "description": "`akamai`: This Invoice was generated according to the terms of an agreement between the customer and Akamai.\n\n`linode`: This Invoice was generated according to the default terms, prices, and discounts.", + "description": "__Filterable__, __Read-only__ `akamai`: This Invoice was generated according to the terms of an agreement between the customer and Akamai.\n\n`linode`: This Invoice was generated according to the default terms, prices, and discounts.", "enum": [ "akamai", "linode" @@ -1559,7 +1700,7 @@ "x-linode-filterable": true }, "date": { - "description": "When this Invoice was generated.", + "description": "__Filterable__, __Read-only__ When this Invoice was generated.", "example": "2018-01-01T00:01:01", "format": "date-time", "readOnly": true, @@ -1573,14 +1714,14 @@ "x-linode-filterable": true }, "id": { - "description": "The Invoice's unique ID.", + "description": "__Read-only__ The Invoice's unique ID.", "example": 123, "readOnly": true, "type": "integer", "x-linode-cli-display": 1 }, "label": { - "description": "The Invoice's display label.", + "description": "__Filterable__, __Read-only__ The Invoice's display label.", "example": "Invoice", "readOnly": true, "type": "string", @@ -1593,21 +1734,21 @@ "x-linode-filterable": true }, "subtotal": { - "description": "The amount of the Invoice before taxes in US Dollars.", + "description": "__Read-only__ The amount of the Invoice before taxes in US Dollars.", "example": 120.25, "readOnly": true, "type": "number", "x-linode-cli-display": 4 }, "tax": { - "description": "The amount of tax levied on the Invoice in US Dollars.", + "description": "__Read-only__ The amount of tax levied on the Invoice in US Dollars.", "example": 12.25, "readOnly": true, "type": "number", "x-linode-cli-display": 5 }, "tax_summary": { - "description": "The amount of tax broken down into subtotals by source.", + "description": "__Read-only__ The amount of tax broken down into subtotals by source.", "items": { "additionalProperties": false, "properties": { @@ -1628,7 +1769,7 @@ "type": "array" }, "total": { - "description": "The amount of the Invoice after taxes in US Dollars.", + "description": "__Filterable__, __Read-only__ The amount of the Invoice after taxes in US Dollars.", "example": 132.5, "readOnly": true, "type": "number", @@ -1641,30 +1782,36 @@ "x-linode-filterable": true } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/invoice.yaml" + } }, "type": "array" }, "page": { - "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { - "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "results": { - "description": "The total number of results.", + "description": "__Read-only__ The total number of results.", "example": 1, "readOnly": true, "type": "integer" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/added-get-invoices-200.yaml" + } }, "added-get-maintenance-200": { "additionalProperties": false, @@ -1707,7 +1854,7 @@ "type": "string" }, "status": { - "description": "The maintenance status.\n\nMaintenance progresses in the following sequence: pending, started, then completed.", + "description": "__Filterable__ The maintenance status.\n\nMaintenance progresses in the following sequence: pending, started, then completed.", "enum": [ "completed", "pending", @@ -1723,7 +1870,7 @@ "x-linode-filterable": true }, "type": { - "description": "The type of maintenance.", + "description": "__Filterable__ The type of maintenance.", "enum": [ "reboot", "cold_migration", @@ -1739,7 +1886,7 @@ "x-linode-filterable": true }, "when": { - "description": "When the maintenance will begin.\n\n[Filterable](https://techdocs.akamai.com/linode-api/reference/filtering-and-sorting) with the following parameters:\n\n- A single value in date-time string format (`%Y-%m-%dT%H:%M:%S`), which returns only matches to that value.\n\n- A dictionary containing pairs of inequality operator string keys (`+or`, `+gt`, `+gte`, `+lt`, `+lte`, or `+neq`) and single date-time string format values (`%Y-%m-%dT%H:%M:%S`). `+or` accepts an array of values that may consist of single date-time strings or dictionaries of inequality operator pairs.", + "description": "__Filterable__ When the maintenance will begin.\n\n[Filterable](https://techdocs.akamai.com/linode-api/reference/filtering-and-sorting) with the following parameters:\n\n- A single value in date-time string format (`%Y-%m-%dT%H:%M:%S`), which returns only matches to that value.\n\n- A dictionary containing pairs of inequality operator string keys (`+or`, `+gt`, `+gte`, `+lt`, `+lte`, or `+neq`) and single date-time string format values (`%Y-%m-%dT%H:%M:%S`). `+or` accepts an array of values that may consist of single date-time strings or dictionaries of inequality operator pairs.", "example": "2020-07-09T00:01:01", "format": "date-time", "type": "string", @@ -1751,30 +1898,36 @@ "x-linode-filterable": true } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/maintenance.yaml" + } }, "type": "array" }, "page": { - "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { - "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "results": { - "description": "The total number of results.", + "description": "__Read-only__ The total number of results.", "example": 1, "readOnly": true, "type": "integer" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/added-get-maintenance-200.yaml" + } }, "added-get-notifications-200": { "additionalProperties": false, @@ -1785,7 +1938,7 @@ "description": "An important, often time-sensitive item related to your account.", "properties": { "body": { - "description": "A full description of this notification, in markdown format. Not all notifications include a `body`.", + "description": "__Read-only__ A full description of this notification, in markdown format. Not all notifications include a `body`.", "example": null, "nullable": true, "readOnly": true, @@ -1793,7 +1946,7 @@ }, "entity": { "additionalProperties": false, - "description": "Detailed information about the notification.", + "description": "__Read-only__ Detailed information about the notification.", "properties": { "id": { "description": "The unique ID of the notification's entity, based on the entity type. Returns `null` for an `account` or `promotion` entity.", @@ -1834,21 +1987,21 @@ "type": "object" }, "label": { - "description": "A short description of this notification.", + "description": "__Read-only__ A short description of this notification.", "example": "You have an important ticket open!", "readOnly": true, "type": "string", "x-linode-cli-display": 1 }, "message": { - "description": "A human-readable description of the notification.", + "description": "__Read-only__ A human-readable description of the notification.", "example": "You have an important ticket open!", "readOnly": true, "type": "string", "x-linode-cli-display": 2 }, "severity": { - "description": "The severity of this notification. This field determines how prominently the notification is displayed and the color of the display text.", + "description": "__Read-only__ The severity of this notification. This field determines how prominently the notification is displayed and the color of the display text.", "enum": [ "minor", "major", @@ -1865,7 +2018,7 @@ "x-linode-cli-display": 3 }, "type": { - "description": "The type of notification.", + "description": "__Read-only__ The type of notification.", "enum": [ "migration_scheduled", "migration_imminent", @@ -1885,7 +2038,7 @@ "type": "string" }, "until": { - "description": "If this notification has a duration, this is when the event or action will complete. For example, if there's scheduled maintenance for one of our systems, `until` represents the end of the maintenance window.", + "description": "__Read-only__ If this notification has a duration, this is when the event or action will complete. For example, if there's scheduled maintenance for one of our systems, `until` represents the end of the maintenance window.", "example": null, "format": "date-time", "nullable": true, @@ -1898,7 +2051,7 @@ "x-linode-cli-display": 5 }, "when": { - "description": "If this notification is for an event in the future, this specifies when the action occurs. For example, if a compute instance needs to migrate in response to a security advisory, this field sets the approximate time the compute instance will be taken offline for migration.", + "description": "__Read-only__ If this notification is for an event in the future, this specifies when the action occurs. For example, if a compute instance needs to migrate in response to a security advisory, this field sets the approximate time the compute instance will be taken offline for migration.", "example": null, "format": "date-time", "nullable": true, @@ -1911,30 +2064,36 @@ "x-linode-cli-display": 4 } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/notification.yaml" + } }, "type": "array" }, "page": { - "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { - "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "results": { - "description": "The total number of results.", + "description": "__Read-only__ The total number of results.", "example": 1, "readOnly": true, "type": "integer" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/added-get-notifications-200.yaml" + } }, "added-get-payment-methods-200": { "additionalProperties": false, @@ -1945,36 +2104,33 @@ "description": "Payment Method Response Object.", "properties": { "created": { - "description": "When the Payment Method was added to the Account.", + "description": "__Read-only__ When the Payment Method was added to the Account.", "example": "2018-01-15T00:01:01", "format": "date-time", "readOnly": true, "type": "string" }, "data": { - "discriminator": { - "propertyName": "type" - }, "oneOf": [ { "additionalProperties": false, "description": "Credit card information.", "properties": { "card_type": { - "description": "The type of credit card.", + "description": "__Read-only__ The type of credit card.", "example": "Discover", "readOnly": true, "type": "string" }, "expiry": { - "description": "The expiration month and year of the credit card.", + "description": "__Read-only__ The expiration month and year of the credit card.", "example": "06/2022", "format": "MM/YYYY", "readOnly": true, "type": "string" }, "last_four": { - "description": "The last four digits of the credit card number.", + "description": "__Read-only__ The last four digits of the credit card number.", "example": "1234", "readOnly": true, "type": "string" @@ -1982,6 +2138,9 @@ }, "title": "Credit card", "type": "object", + "x-akamai": { + "file-path": "schemas/credit-card-data.yaml" + }, "x-linode-ref-name": "Credit Card" }, { @@ -1989,20 +2148,20 @@ "description": "Google Pay information.", "properties": { "card_type": { - "description": "The type of credit card.", + "description": "__Read-only__ The type of credit card.", "example": "Discover", "readOnly": true, "type": "string" }, "expiry": { - "description": "The expiration month and year of the credit card.", + "description": "__Read-only__ The expiration month and year of the credit card.", "example": "06/2022", "format": "MM/YYYY", "readOnly": true, "type": "string" }, "last_four": { - "description": "The last four digits of the credit card number.", + "description": "__Read-only__ The last four digits of the credit card number.", "example": "1234", "readOnly": true, "type": "string" @@ -2010,6 +2169,9 @@ }, "title": "Google Pay", "type": "object", + "x-akamai": { + "file-path": "schemas/google-pay-data.yaml" + }, "x-linode-ref-name": "Google Pay" }, { @@ -2017,13 +2179,13 @@ "description": "PayPal information.", "properties": { "email": { - "description": "The email address associated with your PayPal account.", + "description": "__Read-only__ The email address associated with your PayPal account.", "example": "example@linode.com", "readOnly": true, "type": "string" }, "paypal_id": { - "description": "PayPal Merchant ID associated with your PayPal account.", + "description": "__Read-only__ PayPal Merchant ID associated with your PayPal account.", "example": "ABC1234567890", "readOnly": true, "type": "string" @@ -2031,6 +2193,9 @@ }, "title": "Paypal", "type": "object", + "x-akamai": { + "file-path": "schemas/paypal-data.yaml" + }, "x-linode-ref-name": "Paypal" } ], @@ -2061,30 +2226,36 @@ "x-linode-cli-display": 2 } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/payment-method.yaml" + } }, "type": "array" }, "page": { - "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { - "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "results": { - "description": "The total number of results.", + "description": "__Read-only__ The total number of results.", "example": 1, "readOnly": true, "type": "integer" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/added-get-payment-methods-200.yaml" + } }, "added-get-payments-200": { "additionalProperties": false, @@ -2095,7 +2266,7 @@ "description": "Payment object response.", "properties": { "date": { - "description": "When the Payment was made.", + "description": "__Read-only__ When the Payment was made.", "example": "2018-01-15T00:01:01", "format": "date-time", "readOnly": true, @@ -2103,44 +2274,50 @@ "x-linode-cli-display": 2 }, "id": { - "description": "The unique ID of the Payment.", + "description": "__Read-only__ The unique ID of the Payment.", "example": 123, "readOnly": true, "type": "integer", "x-linode-cli-display": 1 }, "usd": { - "description": "The amount, in US dollars, of the Payment.", + "description": "__Read-only__ The amount, in US dollars, of the Payment.", "example": "120.50", "readOnly": true, "type": "integer", "x-linode-cli-display": 3 } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/payment.yaml" + } }, "type": "array" }, "page": { - "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { - "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "results": { - "description": "The total number of results.", + "description": "__Read-only__ The total number of results.", "example": 1, "readOnly": true, "type": "integer" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/added-get-payments-200.yaml" + } }, "added-get-service-transfers-200": { "additionalProperties": false, @@ -2183,7 +2360,7 @@ "x-linode-cli-display": 3 }, "is_sender": { - "description": "If the requesting account created this transfer.", + "description": "__Filterable__ If the requesting account created this transfer.", "example": true, "type": "boolean", "x-akamai": { @@ -2195,7 +2372,7 @@ "x-linode-filterable": true }, "status": { - "description": "The status of the transfer request.\n\n`accepted`: The transfer has been accepted by another user and is currently in progress.\nTransfers can take up to 3 hours to complete.\n\n`canceled`: The transfer has been canceled by the sender.\n\n`completed`: The transfer has completed successfully.\n\n`failed`: The transfer has failed after initiation.\n\n`pending`: The transfer is ready to be accepted.\n\n`stale`: The transfer has exceeded its expiration date. It can no longer be accepted or\ncanceled.", + "description": "__Filterable__ The status of the transfer request.\n\n`accepted`: The transfer has been accepted by another user and is currently in progress.\nTransfers can take up to 3 hours to complete.\n\n`canceled`: The transfer has been canceled by the sender.\n\n`completed`: The transfer has completed successfully.\n\n`failed`: The transfer has failed after initiation.\n\n`pending`: The transfer is ready to be accepted.\n\n`stale`: The transfer has exceeded its expiration date. It can no longer be accepted or\ncanceled.", "enum": [ "accepted", "canceled", @@ -2237,30 +2414,36 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/service-transfer.yaml" + } }, "type": "array" }, "page": { - "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { - "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "results": { - "description": "The total number of results.", + "description": "__Read-only__ The total number of results.", "example": 1, "readOnly": true, "type": "integer" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/added-get-service-transfers-200.yaml" + } }, "added-get-user-200": { "allOf": [ @@ -2277,18 +2460,18 @@ }, "last_login": { "additionalProperties": false, - "description": "Details on this user's last login attempt. Returned as `null` if this user hasn't attempted a login since it was created. You can run the [List user logins](https://techdocs.akamai.com/linode-api/reference/get-account-logins) operation for additional login information.", + "description": "__Read-only__ Details on this user's last login attempt. Returned as `null` if this user hasn't attempted a login since it was created. You can run the [List user logins](https://techdocs.akamai.com/linode-api/reference/get-account-logins) operation for additional login information.", "nullable": true, "properties": { "login_datetime": { - "description": "The date and time of this user's most recent login attempt.", + "description": "__Read-only__ The date and time of this user's most recent login attempt.", "example": "2018-01-01T01:01:01", "format": "date-time", "readOnly": true, "type": "string" }, "status": { - "description": "The result of this user's most recent login attempt.", + "description": "__Read-only__ The result of this user's most recent login attempt.", "enum": [ "successful", "failed" @@ -2302,7 +2485,7 @@ "type": "object" }, "password_created": { - "description": "When this user's current password was created. You initially create a password during the account sign-up process, and you can update it using the [Reset Password](https://login.linode.com/forgot/password) webpage. Returned as `null` if this user doesn't have a password set.", + "description": "__Read-only__ When this user's current password was created. You initially create a password during the account sign-up process, and you can update it using the [Reset Password](https://login.linode.com/forgot/password) webpage. Returned as `null` if this user doesn't have a password set.", "example": "2018-01-01T01:01:01", "format": "date-time", "nullable": true, @@ -2316,7 +2499,7 @@ "x-linode-cli-display": 3 }, "ssh_keys": { - "description": "A list of the labels for SSH keys added by this user. Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. These keys are deployed when this user is included in the `authorized_users` field of the following requests:\n\n- [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance)\n\n- [Rebuild a Linode](https://techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance)\n\n- [Create a disk](https://techdocs.akamai.com/linode-api/reference/post-add-linode-disk)", + "description": "__Read-only__ A list of the labels for SSH keys added by this user. Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. These keys are deployed when this user is included in the `authorized_users` field of the following requests:\n\n- [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance)\n\n- [Rebuild a Linode](https://techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance)\n\n- [Create a disk](https://techdocs.akamai.com/linode-api/reference/post-add-linode-disk)", "example": [ "home-pc", "laptop" @@ -2328,13 +2511,13 @@ "type": "array" }, "tfa_enabled": { - "description": "Whether this user has Two Factor Authentication (TFA) enabled. Run the [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA.", + "description": "__Read-only__ Whether this user has Two Factor Authentication (TFA) enabled. Run the [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA.", "example": true, "readOnly": true, "type": "boolean" }, "username": { - "description": "The name of this user. This user needs to use this value to log in. It may also display alongside actions this user performs, including events or public StackScripts.", + "description": "__Filterable__ The name of this user. This user needs to use this value to log in. It may also display alongside actions this user performs, including events or public StackScripts.", "example": "example_user", "maxLength": 32, "minLength": 3, @@ -2349,7 +2532,7 @@ "x-linode-filterable": true }, "verified_phone_number": { - "description": "The [verified](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) phone number for this user profile. Returned as `null` if the user doesn't have a verified phone number.", + "description": "__Read-only__ The [verified](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) phone number for this user profile. Returned as `null` if the user doesn't have a verified phone number.", "example": "+5555555555", "format": "phone", "nullable": true, @@ -2357,14 +2540,17 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/user.yaml" + } }, { "additionalProperties": false, "description": "The type of user on an account. Mostly applies to the use of the parent and child accounts for Akamai partners functionality.", "properties": { "user_type": { - "description": "If the user belongs to a [parent or child account](https://www.linode.com/docs/guides/parent-child-accounts/) relationship, this defines the user type in the respective account. Possible values include:\n\n- `parent`. This is a user in an Akamai partner account. Akamai partners have a contractural relationship with their end customers, to sell Akamai services. This user can either have full access (a parent account admin user) or limited access. Limited users don't have access to manage child accounts, but they can be granted this access by an admin user.\n\n- `child`. This is an Akamai partner's end customer user, in a child account. A child user can have either full or limited access. Full access lets the user manage other child users and the proxy user in a child account.\n\n- `proxy`. This is a user on a child account that gives parent account users access to that child account. A parent account user with the `child_account_access` grant can [Create a proxy user token](https://techdocs.akamai.com/linode-api/reference/post-child-account-token) from the parent account. The parent user can use this token to run API operations from the child account, as if they were a child user.\n\n- `default`. This applies to all regular, non-parent-child account users.", + "description": "__Read-only__ If the user belongs to a [parent or child account](https://www.linode.com/docs/guides/parent-child-accounts/) relationship, this defines the user type in the respective account. Possible values include:\n\n- `parent`. This is a user in an Akamai partner account. Akamai partners have a contractural relationship with their end customers, to sell Akamai services. This user can either have full access (a parent account admin user) or limited access. Limited users don't have access to manage child accounts, but they can be granted this access by an admin user.\n\n- `child`. This is an Akamai partner's end customer user, in a child account. A child user can have either full or limited access. Full access lets the user manage other child users and the proxy user in a child account.\n\n- `proxy`. This is a user on a child account that gives parent account users access to that child account. A parent account user with the `child_account_access` grant can [Create a proxy user token](https://techdocs.akamai.com/linode-api/reference/post-child-account-token) from the parent account. The parent user can use this token to run API operations from the child account, as if they were a child user.\n\n- `default`. This applies to all regular, non-parent-child account users.", "enum": [ "parent", "child", @@ -2376,9 +2562,15 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/user-type.yaml" + } } - ] + ], + "x-akamai": { + "file-path": "schemas/added-get-user-200.yaml" + } }, "added-get-users-200": { "additionalProperties": false, @@ -2399,18 +2591,18 @@ }, "last_login": { "additionalProperties": false, - "description": "Details on this user's last login attempt. Returned as `null` if this user hasn't attempted a login since it was created. You can run the [List user logins](https://techdocs.akamai.com/linode-api/reference/get-account-logins) operation for additional login information.", + "description": "__Read-only__ Details on this user's last login attempt. Returned as `null` if this user hasn't attempted a login since it was created. You can run the [List user logins](https://techdocs.akamai.com/linode-api/reference/get-account-logins) operation for additional login information.", "nullable": true, "properties": { "login_datetime": { - "description": "The date and time of this user's most recent login attempt.", + "description": "__Read-only__ The date and time of this user's most recent login attempt.", "example": "2018-01-01T01:01:01", "format": "date-time", "readOnly": true, "type": "string" }, "status": { - "description": "The result of this user's most recent login attempt.", + "description": "__Read-only__ The result of this user's most recent login attempt.", "enum": [ "successful", "failed" @@ -2424,7 +2616,7 @@ "type": "object" }, "password_created": { - "description": "When this user's current password was created. You initially create a password during the account sign-up process, and you can update it using the [Reset Password](https://login.linode.com/forgot/password) webpage. Returned as `null` if this user doesn't have a password set.", + "description": "__Read-only__ When this user's current password was created. You initially create a password during the account sign-up process, and you can update it using the [Reset Password](https://login.linode.com/forgot/password) webpage. Returned as `null` if this user doesn't have a password set.", "example": "2018-01-01T01:01:01", "format": "date-time", "nullable": true, @@ -2438,7 +2630,7 @@ "x-linode-cli-display": 3 }, "ssh_keys": { - "description": "A list of the labels for SSH keys added by this user. Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. These keys are deployed when this user is included in the `authorized_users` field of the following requests:\n\n- [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance)\n\n- [Rebuild a Linode](https://techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance)\n\n- [Create a disk](https://techdocs.akamai.com/linode-api/reference/post-add-linode-disk)", + "description": "__Read-only__ A list of the labels for SSH keys added by this user. Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. These keys are deployed when this user is included in the `authorized_users` field of the following requests:\n\n- [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance)\n\n- [Rebuild a Linode](https://techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance)\n\n- [Create a disk](https://techdocs.akamai.com/linode-api/reference/post-add-linode-disk)", "example": [ "home-pc", "laptop" @@ -2450,13 +2642,13 @@ "type": "array" }, "tfa_enabled": { - "description": "Whether this user has Two Factor Authentication (TFA) enabled. Run the [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA.", + "description": "__Read-only__ Whether this user has Two Factor Authentication (TFA) enabled. Run the [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA.", "example": true, "readOnly": true, "type": "boolean" }, "username": { - "description": "The name of this user. This user needs to use this value to log in. It may also display alongside actions this user performs, including events or public StackScripts.", + "description": "__Filterable__ The name of this user. This user needs to use this value to log in. It may also display alongside actions this user performs, including events or public StackScripts.", "example": "example_user", "maxLength": 32, "minLength": 3, @@ -2471,7 +2663,7 @@ "x-linode-filterable": true }, "verified_phone_number": { - "description": "The [verified](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) phone number for this user profile. Returned as `null` if the user doesn't have a verified phone number.", + "description": "__Read-only__ The [verified](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) phone number for this user profile. Returned as `null` if the user doesn't have a verified phone number.", "example": "+5555555555", "format": "phone", "nullable": true, @@ -2479,14 +2671,17 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/user.yaml" + } }, { "additionalProperties": false, "description": "The type of user on an account. Mostly applies to the use of the parent and child accounts for Akamai partners functionality.", "properties": { "user_type": { - "description": "If the user belongs to a [parent or child account](https://www.linode.com/docs/guides/parent-child-accounts/) relationship, this defines the user type in the respective account. Possible values include:\n\n- `parent`. This is a user in an Akamai partner account. Akamai partners have a contractural relationship with their end customers, to sell Akamai services. This user can either have full access (a parent account admin user) or limited access. Limited users don't have access to manage child accounts, but they can be granted this access by an admin user.\n\n- `child`. This is an Akamai partner's end customer user, in a child account. A child user can have either full or limited access. Full access lets the user manage other child users and the proxy user in a child account.\n\n- `proxy`. This is a user on a child account that gives parent account users access to that child account. A parent account user with the `child_account_access` grant can [Create a proxy user token](https://techdocs.akamai.com/linode-api/reference/post-child-account-token) from the parent account. The parent user can use this token to run API operations from the child account, as if they were a child user.\n\n- `default`. This applies to all regular, non-parent-child account users.", + "description": "__Read-only__ If the user belongs to a [parent or child account](https://www.linode.com/docs/guides/parent-child-accounts/) relationship, this defines the user type in the respective account. Possible values include:\n\n- `parent`. This is a user in an Akamai partner account. Akamai partners have a contractural relationship with their end customers, to sell Akamai services. This user can either have full access (a parent account admin user) or limited access. Limited users don't have access to manage child accounts, but they can be granted this access by an admin user.\n\n- `child`. This is an Akamai partner's end customer user, in a child account. A child user can have either full or limited access. Full access lets the user manage other child users and the proxy user in a child account.\n\n- `proxy`. This is a user on a child account that gives parent account users access to that child account. A parent account user with the `child_account_access` grant can [Create a proxy user token](https://techdocs.akamai.com/linode-api/reference/post-child-account-token) from the parent account. The parent user can use this token to run API operations from the child account, as if they were a child user.\n\n- `default`. This applies to all regular, non-parent-child account users.", "enum": [ "parent", "child", @@ -2498,32 +2693,38 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/user-type.yaml" + } } ] }, "type": "array" }, "page": { - "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { - "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "results": { - "description": "The total number of results.", + "description": "__Read-only__ The total number of results.", "example": 1, "readOnly": true, "type": "integer" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/added-get-users-200.yaml" + } }, "added-post-beta-program": { "additionalProperties": false, @@ -2539,7 +2740,10 @@ "required": [ "id" ], - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/added-post-beta-program.yaml" + } }, "added-post-cancel-account": { "additionalProperties": false, @@ -2550,7 +2754,10 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/added-post-cancel-account.yaml" + } }, "added-post-cancel-account-200": { "additionalProperties": false, @@ -2563,7 +2770,10 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/added-post-cancel-account-200.yaml" + } }, "added-post-cancel-account-409": { "additionalProperties": false, @@ -2583,7 +2793,10 @@ "type": "array" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/added-post-cancel-account-409.yaml" + } }, "added-post-cancel-account-504": { "additionalProperties": false, @@ -2603,7 +2816,10 @@ "type": "array" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/added-post-cancel-account-504.yaml" + } }, "added-post-client": { "allOf": [ @@ -2612,14 +2828,14 @@ "description": "A third-party application registered to Linode that users may log into with their Linode account through our authentication server at [login.linode.com](https://login.linode.com). Using an OAuth Client, a third-party developer may be given access to some, or all, of a User's account for the purposes of their application.", "properties": { "id": { - "description": "The OAuth Client ID. This is used to identify the client, and is a publicly known value (it is not a secret).", + "description": "__Read-only__ The OAuth Client ID. This is used to identify the client, and is a publicly known value (it is not a secret).", "example": "2737bf16b39ab5d7b4a1", "readOnly": true, "type": "string", "x-linode-cli-display": 1 }, "label": { - "description": "The name of this application. This will be presented to users when they are asked to grant it access to their Account.", + "description": "__Filterable__ The name of this application. This will be presented to users when they are asked to grant it access to their Account.", "example": "Test_Client_1", "maxLength": 512, "minLength": 1, @@ -2634,7 +2850,7 @@ }, "public": { "default": false, - "description": "If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the [OAuth spec](https://oauth.net/2/) for more details.", + "description": "__Filterable__ If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the [OAuth spec](https://oauth.net/2/) for more details.", "example": false, "type": "boolean", "x-akamai": { @@ -2653,13 +2869,13 @@ "x-linode-cli-display": 5 }, "secret": { - "description": "The OAuth Client secret, used in the OAuth exchange. This is returned as `` except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly.", + "description": "__Read-only__ The OAuth Client secret, used in the OAuth exchange. This is returned as `` except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly.", "example": "", "readOnly": true, "type": "string" }, "status": { - "description": "The status of this application. `active` by default.", + "description": "__Read-only__ The status of this application. `active` by default.", "enum": [ "active", "disabled", @@ -2675,7 +2891,7 @@ "x-linode-cli-display": 3 }, "thumbnail_url": { - "description": "The URL where this client's thumbnail may be viewed, or `null` if this client does not have a thumbnail set.", + "description": "__Read-only__ The URL where this client's thumbnail may be viewed, or `null` if this client does not have a thumbnail set.", "example": "https://api.linode.com/v4/account/clients/2737bf16b39ab5d7b4a1/thumbnail", "format": "url", "nullable": true, @@ -2683,13 +2899,19 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/oauth-client.yaml" + } } ], "required": [ "label", "redirect_uri" - ] + ], + "x-akamai": { + "file-path": "schemas/added-post-client.yaml" + } }, "added-post-entity-transfer": { "additionalProperties": false, @@ -2717,13 +2939,16 @@ "required": [ "entities" ], - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/added-post-entity-transfer.yaml" + } }, "added-post-pay-pal-payment-200": { "additionalProperties": false, "properties": { "checkout_token": { - "description": "The checkout token generated for this Payment.", + "description": "__Read-only__ The checkout token generated for this Payment.", "example": "EC-1A2B3C4D5E6F7G8H9", "readOnly": true, "type": "string" @@ -2734,7 +2959,10 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/added-post-pay-pal-payment-200.yaml" + } }, "added-post-payment": { "additionalProperties": false, @@ -2751,7 +2979,10 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/added-post-payment.yaml" + } }, "added-post-payment-method": { "additionalProperties": false, @@ -2798,7 +3029,10 @@ "expiry_year", "cvv" ], - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/credit-card.yaml" + } }, "is_default": { "description": "Whether this Payment Method is the default method for automatically processing service charges.", @@ -2820,7 +3054,10 @@ "data", "is_default" ], - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/added-post-payment-method.yaml" + } }, "added-post-promo-credit": { "additionalProperties": false, @@ -2835,7 +3072,10 @@ "required": [ "promo_code" ], - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/added-post-promo-credit.yaml" + } }, "added-post-service-transfer": { "additionalProperties": false, @@ -2863,7 +3103,10 @@ "required": [ "entities" ], - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/added-post-service-transfer.yaml" + } }, "added-post-user": { "allOf": [ @@ -2880,18 +3123,18 @@ }, "last_login": { "additionalProperties": false, - "description": "Details on this user's last login attempt. Returned as `null` if this user hasn't attempted a login since it was created. You can run the [List user logins](https://techdocs.akamai.com/linode-api/reference/get-account-logins) operation for additional login information.", + "description": "__Read-only__ Details on this user's last login attempt. Returned as `null` if this user hasn't attempted a login since it was created. You can run the [List user logins](https://techdocs.akamai.com/linode-api/reference/get-account-logins) operation for additional login information.", "nullable": true, "properties": { "login_datetime": { - "description": "The date and time of this user's most recent login attempt.", + "description": "__Read-only__ The date and time of this user's most recent login attempt.", "example": "2018-01-01T01:01:01", "format": "date-time", "readOnly": true, "type": "string" }, "status": { - "description": "The result of this user's most recent login attempt.", + "description": "__Read-only__ The result of this user's most recent login attempt.", "enum": [ "successful", "failed" @@ -2905,7 +3148,7 @@ "type": "object" }, "password_created": { - "description": "When this user's current password was created. You initially create a password during the account sign-up process, and you can update it using the [Reset Password](https://login.linode.com/forgot/password) webpage. Returned as `null` if this user doesn't have a password set.", + "description": "__Read-only__ When this user's current password was created. You initially create a password during the account sign-up process, and you can update it using the [Reset Password](https://login.linode.com/forgot/password) webpage. Returned as `null` if this user doesn't have a password set.", "example": "2018-01-01T01:01:01", "format": "date-time", "nullable": true, @@ -2919,7 +3162,7 @@ "x-linode-cli-display": 3 }, "ssh_keys": { - "description": "A list of the labels for SSH keys added by this user. Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. These keys are deployed when this user is included in the `authorized_users` field of the following requests:\n\n- [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance)\n\n- [Rebuild a Linode](https://techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance)\n\n- [Create a disk](https://techdocs.akamai.com/linode-api/reference/post-add-linode-disk)", + "description": "__Read-only__ A list of the labels for SSH keys added by this user. Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. These keys are deployed when this user is included in the `authorized_users` field of the following requests:\n\n- [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance)\n\n- [Rebuild a Linode](https://techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance)\n\n- [Create a disk](https://techdocs.akamai.com/linode-api/reference/post-add-linode-disk)", "example": [ "home-pc", "laptop" @@ -2931,13 +3174,13 @@ "type": "array" }, "tfa_enabled": { - "description": "Whether this user has Two Factor Authentication (TFA) enabled. Run the [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA.", + "description": "__Read-only__ Whether this user has Two Factor Authentication (TFA) enabled. Run the [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA.", "example": true, "readOnly": true, "type": "boolean" }, "username": { - "description": "The name of this user. This user needs to use this value to log in. It may also display alongside actions this user performs, including events or public StackScripts.", + "description": "__Filterable__ The name of this user. This user needs to use this value to log in. It may also display alongside actions this user performs, including events or public StackScripts.", "example": "example_user", "maxLength": 32, "minLength": 3, @@ -2952,7 +3195,7 @@ "x-linode-filterable": true }, "verified_phone_number": { - "description": "The [verified](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) phone number for this user profile. Returned as `null` if the user doesn't have a verified phone number.", + "description": "__Read-only__ The [verified](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) phone number for this user profile. Returned as `null` if the user doesn't have a verified phone number.", "example": "+5555555555", "format": "phone", "nullable": true, @@ -2960,13 +3203,19 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/user.yaml" + } } ], "required": [ "username", "email" - ] + ], + "x-akamai": { + "file-path": "schemas/added-post-user.yaml" + } }, "added-put-user-200": { "allOf": [ @@ -2983,18 +3232,18 @@ }, "last_login": { "additionalProperties": false, - "description": "Details on this user's last login attempt. Returned as `null` if this user hasn't attempted a login since it was created. You can run the [List user logins](https://techdocs.akamai.com/linode-api/reference/get-account-logins) operation for additional login information.", + "description": "__Read-only__ Details on this user's last login attempt. Returned as `null` if this user hasn't attempted a login since it was created. You can run the [List user logins](https://techdocs.akamai.com/linode-api/reference/get-account-logins) operation for additional login information.", "nullable": true, "properties": { "login_datetime": { - "description": "The date and time of this user's most recent login attempt.", + "description": "__Read-only__ The date and time of this user's most recent login attempt.", "example": "2018-01-01T01:01:01", "format": "date-time", "readOnly": true, "type": "string" }, "status": { - "description": "The result of this user's most recent login attempt.", + "description": "__Read-only__ The result of this user's most recent login attempt.", "enum": [ "successful", "failed" @@ -3008,7 +3257,7 @@ "type": "object" }, "password_created": { - "description": "When this user's current password was created. You initially create a password during the account sign-up process, and you can update it using the [Reset Password](https://login.linode.com/forgot/password) webpage. Returned as `null` if this user doesn't have a password set.", + "description": "__Read-only__ When this user's current password was created. You initially create a password during the account sign-up process, and you can update it using the [Reset Password](https://login.linode.com/forgot/password) webpage. Returned as `null` if this user doesn't have a password set.", "example": "2018-01-01T01:01:01", "format": "date-time", "nullable": true, @@ -3022,7 +3271,7 @@ "x-linode-cli-display": 3 }, "ssh_keys": { - "description": "A list of the labels for SSH keys added by this user. Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. These keys are deployed when this user is included in the `authorized_users` field of the following requests:\n\n- [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance)\n\n- [Rebuild a Linode](https://techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance)\n\n- [Create a disk](https://techdocs.akamai.com/linode-api/reference/post-add-linode-disk)", + "description": "__Read-only__ A list of the labels for SSH keys added by this user. Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. These keys are deployed when this user is included in the `authorized_users` field of the following requests:\n\n- [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance)\n\n- [Rebuild a Linode](https://techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance)\n\n- [Create a disk](https://techdocs.akamai.com/linode-api/reference/post-add-linode-disk)", "example": [ "home-pc", "laptop" @@ -3034,13 +3283,13 @@ "type": "array" }, "tfa_enabled": { - "description": "Whether this user has Two Factor Authentication (TFA) enabled. Run the [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA.", + "description": "__Read-only__ Whether this user has Two Factor Authentication (TFA) enabled. Run the [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA.", "example": true, "readOnly": true, "type": "boolean" }, "username": { - "description": "The name of this user. This user needs to use this value to log in. It may also display alongside actions this user performs, including events or public StackScripts.", + "description": "__Filterable__ The name of this user. This user needs to use this value to log in. It may also display alongside actions this user performs, including events or public StackScripts.", "example": "example_user", "maxLength": 32, "minLength": 3, @@ -3055,7 +3304,7 @@ "x-linode-filterable": true }, "verified_phone_number": { - "description": "The [verified](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) phone number for this user profile. Returned as `null` if the user doesn't have a verified phone number.", + "description": "__Read-only__ The [verified](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) phone number for this user profile. Returned as `null` if the user doesn't have a verified phone number.", "example": "+5555555555", "format": "phone", "nullable": true, @@ -3063,14 +3312,17 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/user.yaml" + } }, { "additionalProperties": false, "description": "The type of user on an account. Mostly applies to the use of the parent and child accounts for Akamai partners functionality.", "properties": { "user_type": { - "description": "If the user belongs to a [parent or child account](https://www.linode.com/docs/guides/parent-child-accounts/) relationship, this defines the user type in the respective account. Possible values include:\n\n- `parent`. This is a user in an Akamai partner account. Akamai partners have a contractural relationship with their end customers, to sell Akamai services. This user can either have full access (a parent account admin user) or limited access. Limited users don't have access to manage child accounts, but they can be granted this access by an admin user.\n\n- `child`. This is an Akamai partner's end customer user, in a child account. A child user can have either full or limited access. Full access lets the user manage other child users and the proxy user in a child account.\n\n- `proxy`. This is a user on a child account that gives parent account users access to that child account. A parent account user with the `child_account_access` grant can [Create a proxy user token](https://techdocs.akamai.com/linode-api/reference/post-child-account-token) from the parent account. The parent user can use this token to run API operations from the child account, as if they were a child user.\n\n- `default`. This applies to all regular, non-parent-child account users.", + "description": "__Read-only__ If the user belongs to a [parent or child account](https://www.linode.com/docs/guides/parent-child-accounts/) relationship, this defines the user type in the respective account. Possible values include:\n\n- `parent`. This is a user in an Akamai partner account. Akamai partners have a contractural relationship with their end customers, to sell Akamai services. This user can either have full access (a parent account admin user) or limited access. Limited users don't have access to manage child accounts, but they can be granted this access by an admin user.\n\n- `child`. This is an Akamai partner's end customer user, in a child account. A child user can have either full or limited access. Full access lets the user manage other child users and the proxy user in a child account.\n\n- `proxy`. This is a user on a child account that gives parent account users access to that child account. A parent account user with the `child_account_access` grant can [Create a proxy user token](https://techdocs.akamai.com/linode-api/reference/post-child-account-token) from the parent account. The parent user can use this token to run API operations from the child account, as if they were a child user.\n\n- `default`. This applies to all regular, non-parent-child account users.", "enum": [ "parent", "child", @@ -3082,9 +3334,15 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/user-type.yaml" + } } - ] + ], + "x-akamai": { + "file-path": "schemas/added-put-user-200.yaml" + } }, "agreements": { "additionalProperties": false, @@ -3110,14 +3368,17 @@ "type": "boolean" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/agreements.yaml" + } }, "beta-program-enrolled": { "additionalProperties": false, "description": "An object representing an enrolled Beta Program for the Account.", "properties": { "description": { - "description": "Additional details regarding the Beta Program.", + "description": "__Read-only__ Additional details regarding the Beta Program.", "example": "This is an open public beta for an example feature.", "nullable": true, "readOnly": true, @@ -3125,7 +3386,7 @@ "x-linode-cli-display": 3 }, "ended": { - "description": "The date-time that the Beta Program ended.\n\n`null` indicates that the Beta Program is ongoing.", + "description": "__Filterable__, __Read-only__ The date-time that the Beta Program ended.\n\n`null` indicates that the Beta Program is ongoing.", "example": null, "format": "date-time", "nullable": true, @@ -3140,7 +3401,7 @@ "x-linode-filterable": true }, "enrolled": { - "description": "The date-time of Account enrollment to the Beta Program.", + "description": "__Filterable__, __Read-only__ The date-time of Account enrollment to the Beta Program.", "example": "2023-09-11T00:00:00", "format": "date-time", "readOnly": true, @@ -3160,7 +3421,7 @@ "x-linode-cli-display": 1 }, "label": { - "description": "The name of the Beta Program.", + "description": "__Filterable__, __Read-only__ The name of the Beta Program.", "example": "Example Open Beta", "readOnly": true, "type": "string", @@ -3173,7 +3434,7 @@ "x-linode-filterable": true }, "started": { - "description": "The start date-time of the Beta Program.", + "description": "__Filterable__, __Read-only__ The start date-time of the Beta Program.", "example": "2023-07-11T00:00:00", "format": "date-time", "readOnly": true, @@ -3187,21 +3448,24 @@ "x-linode-filterable": true } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/beta-program-enrolled.yaml" + } }, "child-account": { "additionalProperties": false, "description": "Child account object.", "properties": { "active_since": { - "description": "The activation date and time for the child account.", + "description": "__Read-only__ The activation date and time for the child account.", "example": "2018-01-01T00:01:01", "format": "date-time", "readOnly": true, "type": "string" }, "address_1": { - "description": "First line of this child account's billing address.", + "description": "__Filterable__ First line of this child account's billing address.", "example": "123 Main Street", "maxLength": 64, "type": "string", @@ -3213,7 +3477,7 @@ "x-linode-filterable": true }, "address_2": { - "description": "Second line of this child account's billing address, if applicable.", + "description": "__Filterable__ Second line of this child account's billing address, if applicable.", "example": "Suite A", "maxLength": 64, "type": "string", @@ -3225,21 +3489,21 @@ "x-linode-filterable": true }, "balance": { - "description": "This child account's balance, in US dollars.", + "description": "__Read-only__ This child account's balance, in US dollars.", "example": 200, "readOnly": true, "type": "number", "x-linode-cli-display": 4 }, "balance_uninvoiced": { - "description": "This child account's current estimated invoice in US dollars. This is not your final invoice balance. Transfer charges are not included in the estimate.", + "description": "__Read-only__ This child account's current estimated invoice in US dollars. This is not your final invoice balance. Transfer charges are not included in the estimate.", "example": 145, "readOnly": true, "type": "number", "x-linode-cli-display": 4 }, "billing_source": { - "description": "The source of service charges for this account, as determined by its relationship with Akamai. The API returns a value of `external` to describe a child account in a parent-child account environment.", + "description": "__Read-only__ The source of service charges for this account, as determined by its relationship with Akamai. The API returns a value of `external` to describe a child account in a parent-child account environment.", "enum": [ "external" ], @@ -3248,7 +3512,7 @@ "type": "string" }, "capabilities": { - "description": "A list of the capabilities the child account supports.", + "description": "__Read-only__ A list of the capabilities the child account supports.", "example": [ "Linodes", "NodeBalancers", @@ -3262,7 +3526,7 @@ "type": "array" }, "city": { - "description": "The city for this child account's billing address.", + "description": "__Filterable__ The city for this child account's billing address.", "example": "San Diego", "maxLength": 24, "type": "string", @@ -3274,7 +3538,7 @@ "x-linode-filterable": true }, "company": { - "description": "The company name for the owner of this child account. It can't include any of these characters: `<` `>` `(` `)` `\"` `=`. You can't change this value yourself. We use it to create the proxy users that a parent account uses to access a child account. Talk to your account team if you need to change this value.", + "description": "__Filterable__ The company name for the owner of this child account. It can't include any of these characters: `<` `>` `(` `)` `\"` `=`. You can't change this value yourself. We use it to create the proxy users that a parent account uses to access a child account. Talk to your account team if you need to change this value.", "example": "Acme", "maxLength": 128, "type": "string", @@ -3286,7 +3550,7 @@ "x-linode-filterable": true }, "country": { - "description": "The two-letter ISO 3166 country code for this child account's billing address.", + "description": "__Filterable__ The two-letter ISO 3166 country code for this child account's billing address.", "example": "US", "type": "string", "x-akamai": { @@ -3298,7 +3562,7 @@ }, "credit_card": { "additionalProperties": false, - "description": "Information for the credit card you've assigned to this child account.", + "description": "__Read-only__ Information for the credit card you've assigned to this child account.", "properties": { "expiry": { "description": "The expiration month and year of the credit card.", @@ -3315,7 +3579,7 @@ "type": "object" }, "email": { - "description": "The email address of the owner of this child account.", + "description": "__Filterable__ The email address of the owner of this child account.", "example": "john.smith@linode.com", "maxLength": 128, "type": "string", @@ -3328,14 +3592,14 @@ "x-linode-filterable": true }, "euuid": { - "description": "An external, unique identifier that Akamai assigned to the child account.", + "description": "__Read-only__ An external, unique identifier that Akamai assigned to the child account.", "example": "A1BC2DEF-34GH-567I-J890KLMN12O34P56", "format": "uuid", "readOnly": true, "type": "string" }, "first_name": { - "description": "The first name of the owner of this child account. It can't include any of these characters: `<` `>` `(` `)` `\"` `=`.", + "description": "__Filterable__ The first name of the owner of this child account. It can't include any of these characters: `<` `>` `(` `)` `\"` `=`.", "example": "John", "maxLength": 50, "type": "string", @@ -3348,7 +3612,7 @@ "x-linode-filterable": true }, "last_name": { - "description": "The last name of the owner of this child account. It can't include any of these characters: `<` `>` `(` `)` `\"` `=`.", + "description": "__Filterable__ The last name of the owner of this child account. It can't include any of these characters: `<` `>` `(` `)` `\"` `=`.", "example": "Smith", "maxLength": 50, "type": "string", @@ -3361,7 +3625,7 @@ "x-linode-filterable": true }, "phone": { - "description": "The phone number for the owner of this child account.", + "description": "__Filterable__ The phone number for the owner of this child account.", "example": "858-555-1212", "maxLength": 32, "type": "string", @@ -3373,7 +3637,7 @@ "x-linode-filterable": true }, "state": { - "description": "The state or province for the billing address (`address_1` and `address_2, if applicable`). If in the United States (US) or Canada (CA), this is the two-letter ISO 3166 State or Province code.\n\n> \ud83d\udcd8\n>\n> If this is a US military address, use state abbreviations (AA, AE, AP).", + "description": "__Filterable__ The state or province for the billing address (`address_1` and `address_2, if applicable`). If in the United States (US) or Canada (CA), this is the two-letter ISO 3166 State or Province code.\n\n> \ud83d\udcd8\n>\n> If this is a US military address, use state abbreviations (AA, AE, AP).", "example": "CA", "maxLength": 24, "type": "string", @@ -3391,7 +3655,7 @@ "type": "string" }, "zip": { - "description": "The zip code of this Account's billing address. The following restrictions apply:\n\n- Can only contain ASCII letters, numbers, and hyphens (`-`).\n- Can't contain more than 9 letter or number characters.", + "description": "__Filterable__ The zip code of this Account's billing address. The following restrictions apply:\n\n- Can only contain ASCII letters, numbers, and hyphens (`-`).\n- Can't contain more than 9 letter or number characters.", "example": "92111-1234", "type": "string", "x-akamai": { @@ -3402,7 +3666,10 @@ "x-linode-filterable": true } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/child-account.yaml" + } }, "credit-card": { "additionalProperties": false, @@ -3445,37 +3712,43 @@ "expiry_year", "cvv" ], - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/credit-card.yaml" + } }, "credit-card-data": { "additionalProperties": false, "description": "Credit card information.", "properties": { "card_type": { - "description": "The type of credit card.", + "description": "__Read-only__ The type of credit card.", "example": "Discover", "readOnly": true, "type": "string" }, "expiry": { - "description": "The expiration month and year of the credit card.", + "description": "__Read-only__ The expiration month and year of the credit card.", "example": "06/2022", "format": "MM/YYYY", "readOnly": true, "type": "string" }, "last_four": { - "description": "The last four digits of the credit card number.", + "description": "__Read-only__ The last four digits of the credit card number.", "example": "1234", "readOnly": true, "type": "string" } }, "title": "Credit card", - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/credit-card-data.yaml" + } }, "description": { - "description": "Additional details regarding the Beta Program.", + "description": "__Read-only__ Additional details regarding the Beta Program.", "example": "This is an open public beta for an example feature.", "nullable": true, "readOnly": true, @@ -3483,7 +3756,7 @@ "x-linode-cli-display": 3 }, "ended": { - "description": "The date-time that the Beta Program ended.\n\n`null` indicates that the Beta Program is ongoing.", + "description": "__Filterable__, __Read-only__ The date-time that the Beta Program ended.\n\n`null` indicates that the Beta Program is ongoing.", "example": null, "format": "date-time", "nullable": true, @@ -3553,7 +3826,7 @@ "x-linode-cli-display": 3 }, "is_sender": { - "description": "If the requesting account created this transfer.", + "description": "__Filterable__ If the requesting account created this transfer.", "example": true, "type": "boolean", "x-akamai": { @@ -3565,7 +3838,7 @@ "x-linode-filterable": true }, "status": { - "description": "The status of the transfer request:\n\n`accepted`: The transfer has been accepted by another user and is currently in progress. Transfers can take up to 3 hours to complete.\n`canceled`: The transfer has been canceled by the sender.\n`completed`: The transfer has completed successfully.\n`failed`: The transfer has failed after initiation.\n`pending`: The transfer is ready to be accepted.\n`stale`: The transfer has exceeded its expiration date. It can no longer be accepted or canceled.", + "description": "__Filterable__ The status of the transfer request:\n\n`accepted`: The transfer has been accepted by another user and is currently in progress. Transfers can take up to 3 hours to complete.\n`canceled`: The transfer has been canceled by the sender.\n`completed`: The transfer has completed successfully.\n`failed`: The transfer has failed after initiation.\n`pending`: The transfer is ready to be accepted.\n`stale`: The transfer has exceeded its expiration date. It can no longer be accepted or canceled.", "enum": [ "accepted", "canceled", @@ -3607,7 +3880,10 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/entity-transfer.yaml" + } }, "error-object": { "additionalProperties": false, @@ -3624,14 +3900,17 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/error-object.yaml" + } }, "event": { "additionalProperties": false, "description": "A specific event object. An event is an action taken against an entity related to your account. For example, if you boot a Linode, the system creates an event. The events returned depend on your user grants.", "properties": { "action": { - "description": "The action that caused this event. New actions may be added in the future.", + "description": "__Read-only__ The action that caused this event. New actions may be added in the future.", "enum": [ "account_agreement_eu_model", "account_promo_apply", @@ -3824,7 +4103,7 @@ "x-linode-cli-display": 3 }, "created": { - "description": "When the system created this event.", + "description": "__Read-only__ When the system created this event.", "example": "2018-01-01T00:01:01", "format": "date-time", "readOnly": true, @@ -3832,7 +4111,7 @@ "x-linode-cli-display": 6 }, "duration": { - "description": "The number of seconds that it takes for the event to complete.", + "description": "__Read-only__ The number of seconds that it takes for the event to complete.", "example": 300.56, "readOnly": true, "type": "number", @@ -3840,7 +4119,7 @@ }, "entity": { "additionalProperties": false, - "description": "Detailed information about the entity that triggered this event.", + "description": "__Read-only__ Detailed information about the entity that triggered this event.", "properties": { "id": { "description": "The unique identifier assigned to the entity.", @@ -3854,7 +4133,7 @@ "x-linode-cli-display": 5 }, "type": { - "description": "The type of entity that is being referenced by the event.", + "description": "__Read-only__ The type of entity that is being referenced by the event.", "enum": [ "account", "backups", @@ -3894,7 +4173,7 @@ "type": "object" }, "id": { - "description": "The unique ID of this event.", + "description": "__Read-only__ The unique ID of this event.", "example": 123, "readOnly": true, "type": "integer", @@ -3908,28 +4187,28 @@ "x-linode-cli-display": 9 }, "percent_complete": { - "description": "A percentage estimating the amount of time remaining for an event. Returned as `null` for notification events.", + "description": "__Read-only__ A percentage estimating the amount of time remaining for an event. Returned as `null` for notification events.", "example": null, "nullable": true, "readOnly": true, "type": "integer" }, "rate": { - "description": "The rate of completion of the event. Only some events return a `rate`, such as the `migration` and `resize` events.", + "description": "__Read-only__ The rate of completion of the event. Only some events return a `rate`, such as the `migration` and `resize` events.", "example": null, "nullable": true, "readOnly": true, "type": "string" }, "read": { - "description": "If a user on your account has [marked an event as read](https://techdocs.akamai.com/linode-api/reference/post-event-read).", + "description": "__Read-only__ If a user on your account has [marked an event as read](https://techdocs.akamai.com/linode-api/reference/post-event-read).", "example": true, "readOnly": true, "type": "boolean" }, "secondary_entity": { "additionalProperties": false, - "description": "Detailed information about the event's secondary entity, if applicable.", + "description": "__Read-only__ Detailed information about the event's secondary entity, if applicable.", "properties": { "id": { "description": "The identifier for the secondary entity object.", @@ -3942,7 +4221,7 @@ "type": "string" }, "type": { - "description": "The type of secondary entity object that's being referenced by the event.", + "description": "__Read-only__ The type of secondary entity object that's being referenced by the event.", "example": "linode", "readOnly": true, "type": "string" @@ -3957,13 +4236,13 @@ "type": "object" }, "seen": { - "description": "If a user on your account has [marked an event as seen](https://techdocs.akamai.com/linode-api/reference/post-event-seen).", + "description": "__Read-only__ If a user on your account has [marked an event as seen](https://techdocs.akamai.com/linode-api/reference/post-event-seen).", "example": true, "readOnly": true, "type": "boolean" }, "status": { - "description": "The current status of this event.", + "description": "__Read-only__ The current status of this event.", "enum": [ "failed", "finished", @@ -3982,14 +4261,14 @@ "x-linode-cli-display": 8 }, "time_remaining": { - "description": "The estimated time remaining until the event completes. This is only returned for some in-progress migration events. Otherwise, `percent_complete` indicates how long until completion.", + "description": "__Read-only__ The estimated time remaining until the event completes. This is only returned for some in-progress migration events. Otherwise, `percent_complete` indicates how long until completion.", "example": null, "nullable": true, "readOnly": true, "type": "string" }, "username": { - "description": "The name of the user whose action caused the event.", + "description": "__Read-only__ The name of the user whose action caused the event.", "example": "exampleUser", "nullable": true, "readOnly": true, @@ -3997,7 +4276,10 @@ "x-linode-cli-display": 2 } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/event.yaml" + } }, "events": { "additionalProperties": false, @@ -4007,7 +4289,7 @@ "additionalProperties": false, "properties": { "action": { - "description": "The action that caused this event. New actions may be added in the future.", + "description": "__Filterable__ The action that caused this event. New actions may be added in the future.", "enum": [ "account_agreement_eu_model", "account_promo_apply", @@ -4205,7 +4487,7 @@ "x-linode-filterable": true }, "created": { - "description": "When the system created this event.", + "description": "__Filterable__ When the system created this event.", "example": "2018-01-01T00:01:01", "format": "date-time", "type": "string", @@ -4228,7 +4510,7 @@ "description": "Detailed information about the entity that triggered this event.", "properties": { "id": { - "description": "The unique identifier assigned to the entity.\n\n> \ud83d\udcd8\n>\n> Consider these points when filtering by `id`:\n>\n> - The `disks` and `backups` entities use the `id` of their parent Linode when filtering for events.\n>\n> - The `account` and `profile` entities don't have an `id`. To filter these entities, use the `type` object instead.\n>\n> - The `tag` entity uses the tag's name as its `id`. Set this value to the tag's name to filter.", + "description": "__Filterable__ The unique identifier assigned to the entity.\n\n> \ud83d\udcd8\n>\n> Consider these points when filtering by `id`:\n>\n> - The `disks` and `backups` entities use the `id` of their parent Linode when filtering for events.\n>\n> - The `account` and `profile` entities don't have an `id`. To filter these entities, use the `type` object instead.\n>\n> - The `tag` entity uses the tag's name as its `id`. Set this value to the tag's name to filter.", "example": 11111, "type": "integer", "x-akamai": { @@ -4245,7 +4527,7 @@ "x-linode-cli-display": 5 }, "type": { - "description": "The type of entity that is being referenced by the event.", + "description": "__Filterable__ The type of entity that is being referenced by the event.", "enum": [ "account", "backups", @@ -4289,7 +4571,7 @@ "type": "object" }, "id": { - "description": "The unique ID of this event.", + "description": "__Filterable__ The unique ID of this event.", "example": 123, "type": "integer", "x-akamai": { @@ -4320,7 +4602,7 @@ "type": "string" }, "read": { - "description": "If a user on your account has [marked an event as read](https://techdocs.akamai.com/linode-api/reference/post-event-read).", + "description": "__Filterable__ If a user on your account has [marked an event as read](https://techdocs.akamai.com/linode-api/reference/post-event-read).", "example": true, "type": "boolean", "x-akamai": { @@ -4414,34 +4696,40 @@ "type": "integer" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/events.yaml" + } }, "google-pay-data": { "additionalProperties": false, "description": "Google Pay information.", "properties": { "card_type": { - "description": "The type of credit card.", + "description": "__Read-only__ The type of credit card.", "example": "Discover", "readOnly": true, "type": "string" }, "expiry": { - "description": "The expiration month and year of the credit card.", + "description": "__Read-only__ The expiration month and year of the credit card.", "example": "06/2022", "format": "MM/YYYY", "readOnly": true, "type": "string" }, "last_four": { - "description": "The last four digits of the credit card number.", + "description": "__Read-only__ The last four digits of the credit card number.", "example": "1234", "readOnly": true, "type": "string" } }, "title": "Google Pay", - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/google-pay-data.yaml" + } }, "grant": { "additionalProperties": false, @@ -4453,7 +4741,7 @@ "type": "integer" }, "label": { - "description": "The name of the entity this grant applies to. This is only for display purposes.", + "description": "__Read-only__ The name of the entity this grant applies to. This is only for display purposes.", "example": "example-entity", "readOnly": true, "type": "string" @@ -4469,7 +4757,10 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/grant.yaml" + } }, "grants-response": { "additionalProperties": false, @@ -4486,7 +4777,7 @@ "type": "integer" }, "label": { - "description": "The name of the entity this grant applies to. This is only for display purposes.", + "description": "__Read-only__ The name of the entity this grant applies to. This is only for display purposes.", "example": "example-entity", "readOnly": true, "type": "string" @@ -4502,7 +4793,10 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/grant.yaml" + } }, "type": "array" }, @@ -4518,7 +4812,7 @@ "type": "integer" }, "label": { - "description": "The name of the entity this grant applies to. This is only for display purposes.", + "description": "__Read-only__ The name of the entity this grant applies to. This is only for display purposes.", "example": "example-entity", "readOnly": true, "type": "string" @@ -4534,7 +4828,10 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/grant.yaml" + } }, "type": "array" }, @@ -4550,7 +4847,7 @@ "type": "integer" }, "label": { - "description": "The name of the entity this grant applies to. This is only for display purposes.", + "description": "__Read-only__ The name of the entity this grant applies to. This is only for display purposes.", "example": "example-entity", "readOnly": true, "type": "string" @@ -4566,7 +4863,10 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/grant.yaml" + } }, "type": "array" }, @@ -4665,7 +4965,7 @@ "type": "integer" }, "label": { - "description": "The name of the entity this grant applies to. This is only for display purposes.", + "description": "__Read-only__ The name of the entity this grant applies to. This is only for display purposes.", "example": "example-entity", "readOnly": true, "type": "string" @@ -4681,7 +4981,10 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/grant.yaml" + } }, "type": "array" }, @@ -4697,7 +5000,7 @@ "type": "integer" }, "label": { - "description": "The name of the entity this grant applies to. This is only for display purposes.", + "description": "__Read-only__ The name of the entity this grant applies to. This is only for display purposes.", "example": "example-entity", "readOnly": true, "type": "string" @@ -4713,7 +5016,10 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/grant.yaml" + } }, "type": "array" }, @@ -4729,7 +5035,7 @@ "type": "integer" }, "label": { - "description": "The name of the entity this grant applies to. This is only for display purposes.", + "description": "__Read-only__ The name of the entity this grant applies to. This is only for display purposes.", "example": "example-entity", "readOnly": true, "type": "string" @@ -4745,7 +5051,10 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/grant.yaml" + } }, "type": "array" }, @@ -4761,7 +5070,7 @@ "type": "integer" }, "label": { - "description": "The name of the entity this grant applies to. This is only for display purposes.", + "description": "__Read-only__ The name of the entity this grant applies to. This is only for display purposes.", "example": "example-entity", "readOnly": true, "type": "string" @@ -4777,7 +5086,10 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/grant.yaml" + } }, "type": "array" }, @@ -4793,7 +5105,7 @@ "type": "integer" }, "label": { - "description": "The name of the entity this grant applies to. This is only for display purposes.", + "description": "__Read-only__ The name of the entity this grant applies to. This is only for display purposes.", "example": "example-entity", "readOnly": true, "type": "string" @@ -4809,7 +5121,10 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/grant.yaml" + } }, "type": "array" }, @@ -4825,7 +5140,7 @@ "type": "integer" }, "label": { - "description": "The name of the entity this grant applies to. This is only for display purposes.", + "description": "__Read-only__ The name of the entity this grant applies to. This is only for display purposes.", "example": "example-entity", "readOnly": true, "type": "string" @@ -4841,7 +5156,10 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/grant.yaml" + } }, "type": "array" }, @@ -4857,7 +5175,7 @@ "type": "integer" }, "label": { - "description": "The name of the entity this grant applies to. This is only for display purposes.", + "description": "__Read-only__ The name of the entity this grant applies to. This is only for display purposes.", "example": "example-entity", "readOnly": true, "type": "string" @@ -4873,12 +5191,18 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/grant.yaml" + } }, "type": "array" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/grants-response.yaml" + } }, "id": { "description": "The unique identifier of the Beta Program.", @@ -4891,7 +5215,7 @@ "description": "Account Invoice object.", "properties": { "billing_source": { - "description": "`akamai`: This Invoice was generated according to the terms of an agreement between the customer and Akamai.\n\n`linode`: This Invoice was generated according to the default terms, prices, and discounts.", + "description": "__Filterable__, __Read-only__ `akamai`: This Invoice was generated according to the terms of an agreement between the customer and Akamai.\n\n`linode`: This Invoice was generated according to the default terms, prices, and discounts.", "enum": [ "akamai", "linode" @@ -4908,7 +5232,7 @@ "x-linode-filterable": true }, "date": { - "description": "When this Invoice was generated.", + "description": "__Filterable__, __Read-only__ When this Invoice was generated.", "example": "2018-01-01T00:01:01", "format": "date-time", "readOnly": true, @@ -4922,14 +5246,14 @@ "x-linode-filterable": true }, "id": { - "description": "The Invoice's unique ID.", + "description": "__Read-only__ The Invoice's unique ID.", "example": 123, "readOnly": true, "type": "integer", "x-linode-cli-display": 1 }, "label": { - "description": "The Invoice's display label.", + "description": "__Filterable__, __Read-only__ The Invoice's display label.", "example": "Invoice", "readOnly": true, "type": "string", @@ -4942,21 +5266,21 @@ "x-linode-filterable": true }, "subtotal": { - "description": "The amount of the Invoice before taxes in US Dollars.", + "description": "__Read-only__ The amount of the Invoice before taxes in US Dollars.", "example": 120.25, "readOnly": true, "type": "number", "x-linode-cli-display": 4 }, "tax": { - "description": "The amount of tax levied on the Invoice in US Dollars.", + "description": "__Read-only__ The amount of tax levied on the Invoice in US Dollars.", "example": 12.25, "readOnly": true, "type": "number", "x-linode-cli-display": 5 }, "tax_summary": { - "description": "The amount of tax broken down into subtotals by source.", + "description": "__Read-only__ The amount of tax broken down into subtotals by source.", "items": { "additionalProperties": false, "properties": { @@ -4977,7 +5301,7 @@ "type": "array" }, "total": { - "description": "The amount of the Invoice after taxes in US Dollars.", + "description": "__Filterable__, __Read-only__ The amount of the Invoice after taxes in US Dollars.", "example": 132.5, "readOnly": true, "type": "number", @@ -4990,21 +5314,24 @@ "x-linode-filterable": true } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/invoice.yaml" + } }, "invoice-item": { "additionalProperties": false, "description": "An InvoiceItem object.", "properties": { "amount": { - "description": "The price, in US dollars, of the Invoice Item. Equal to the unit price multiplied by quantity.", + "description": "__Read-only__ The price, in US dollars, of the Invoice Item. Equal to the unit price multiplied by quantity.", "example": 20.2, "readOnly": true, "type": "number", "x-linode-cli-display": 4 }, "from": { - "description": "The date the Invoice Item started, based on month.", + "description": "__Read-only__ The date the Invoice Item started, based on month.", "example": "2018-01-01T00:01:01", "format": "date-time", "readOnly": true, @@ -5012,20 +5339,20 @@ "x-linode-cli-display": 2 }, "label": { - "description": "The Invoice Item's display label.", + "description": "__Read-only__ The Invoice Item's display label.", "example": "Linode 123", "readOnly": true, "type": "string", "x-linode-cli-display": 1 }, "quantity": { - "description": "The quantity of this Item for the specified Invoice.", + "description": "__Read-only__ The quantity of this Item for the specified Invoice.", "example": 4, "readOnly": true, "type": "integer" }, "region": { - "description": "The ID of the applicable Region associated with this Invoice Item.\n\n`null` if there is no applicable Region.", + "description": "__Read-only__ The ID of the applicable Region associated with this Invoice Item.\n\n`null` if there is no applicable Region.", "example": "us-west", "nullable": true, "readOnly": true, @@ -5033,14 +5360,14 @@ "x-linode-cli-display": 7 }, "tax": { - "description": "The amount of tax levied on this Item in US Dollars.", + "description": "__Read-only__ The amount of tax levied on this Item in US Dollars.", "example": 1.25, "readOnly": true, "type": "number", "x-linode-cli-display": 5 }, "to": { - "description": "The date the Invoice Item ended, based on month.", + "description": "__Read-only__ The date the Invoice Item ended, based on month.", "example": "2018-01-31T11:59:59", "format": "date-time", "readOnly": true, @@ -5048,14 +5375,14 @@ "x-linode-cli-display": 3 }, "total": { - "description": "The price of this Item after taxes in US Dollars.", + "description": "__Read-only__ The price of this Item after taxes in US Dollars.", "example": 21.45, "readOnly": true, "type": "number", "x-linode-cli-display": 6 }, "type": { - "description": "The type of service, ether `hourly` or `misc`.", + "description": "__Read-only__ The type of service, ether `hourly` or `misc`.", "enum": [ "hourly", "misc" @@ -5065,13 +5392,16 @@ "type": "string" }, "unit_price": { - "description": "The monthly service fee in US Dollars for this Item.", + "description": "__Read-only__ The monthly service fee in US Dollars for this Item.", "example": 5.05, "readOnly": true, "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/invoice-item.yaml" + } }, "is_default": { "description": "Whether this Payment Method is the default method for automatically processing service charges.", @@ -5080,7 +5410,7 @@ "x-linode-cli-display": 3 }, "label": { - "description": "The name of the Beta Program.", + "description": "__Filterable__, __Read-only__ The name of the Beta Program.", "example": "Example Open Beta", "readOnly": true, "type": "string", @@ -5097,7 +5427,7 @@ "description": "An object representing a previous successful login for a User.", "properties": { "datetime": { - "description": "When the login was initiated.", + "description": "__Read-only__ When the login was initiated.", "example": "2018-01-01T00:01:01", "format": "date-time", "readOnly": true, @@ -5105,14 +5435,14 @@ "x-linode-cli-display": 2 }, "id": { - "description": "The unique ID of this login object.", + "description": "__Read-only__ The unique ID of this login object.", "example": 1234, "readOnly": true, "type": "integer", "x-linode-cli-display": 1 }, "ip": { - "description": "The remote IP address that requested the login.", + "description": "__Read-only__ The remote IP address that requested the login.", "example": "192.0.2.0", "format": "ip", "readOnly": true, @@ -5120,14 +5450,14 @@ "x-linode-cli-display": 3 }, "restricted": { - "description": "True if the User that attempted the login was a restricted User, false otherwise.", + "description": "__Read-only__ True if the User that attempted the login was a restricted User, false otherwise.", "example": true, "readOnly": true, "type": "boolean", "x-linode-cli-display": 6 }, "status": { - "description": "Whether the login attempt succeeded or failed.", + "description": "__Read-only__ Whether the login attempt succeeded or failed.", "enum": [ "successful", "failed" @@ -5138,14 +5468,17 @@ "x-linode-cli-display": 5 }, "username": { - "description": "The username of the User that attempted the login.", + "description": "__Read-only__ The username of the User that attempted the login.", "example": "example_user", "readOnly": true, "type": "string", "x-linode-cli-display": 4 } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/login.yaml" + } }, "maintenance": { "additionalProperties": false, @@ -5184,7 +5517,7 @@ "type": "string" }, "status": { - "description": "The maintenance status.\n\nMaintenance progresses in the following sequence: pending, started, then completed.", + "description": "__Filterable__ The maintenance status.\n\nMaintenance progresses in the following sequence: pending, started, then completed.", "enum": [ "completed", "pending", @@ -5200,7 +5533,7 @@ "x-linode-filterable": true }, "type": { - "description": "The type of maintenance.", + "description": "__Filterable__ The type of maintenance.", "enum": [ "reboot", "cold_migration", @@ -5216,7 +5549,7 @@ "x-linode-filterable": true }, "when": { - "description": "When the maintenance will begin.\n\n[Filterable](https://techdocs.akamai.com/linode-api/reference/filtering-and-sorting) with the following parameters:\n\n- A single value in date-time string format (`%Y-%m-%dT%H:%M:%S`), which returns only matches to that value.\n\n- A dictionary containing pairs of inequality operator string keys (`+or`, `+gt`, `+gte`, `+lt`, `+lte`, or `+neq`) and single date-time string format values (`%Y-%m-%dT%H:%M:%S`). `+or` accepts an array of values that may consist of single date-time strings or dictionaries of inequality operator pairs.", + "description": "__Filterable__ When the maintenance will begin.\n\n[Filterable](https://techdocs.akamai.com/linode-api/reference/filtering-and-sorting) with the following parameters:\n\n- A single value in date-time string format (`%Y-%m-%dT%H:%M:%S`), which returns only matches to that value.\n\n- A dictionary containing pairs of inequality operator string keys (`+or`, `+gt`, `+gte`, `+lt`, `+lte`, or `+neq`) and single date-time string format values (`%Y-%m-%dT%H:%M:%S`). `+or` accepts an array of values that may consist of single date-time strings or dictionaries of inequality operator pairs.", "example": "2020-07-09T00:01:01", "format": "date-time", "type": "string", @@ -5228,14 +5561,17 @@ "x-linode-filterable": true } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/maintenance.yaml" + } }, "notification": { "additionalProperties": false, "description": "An important, often time-sensitive item related to your account.", "properties": { "body": { - "description": "A full description of this notification, in markdown format. Not all notifications include a `body`.", + "description": "__Read-only__ A full description of this notification, in markdown format. Not all notifications include a `body`.", "example": null, "nullable": true, "readOnly": true, @@ -5243,7 +5579,7 @@ }, "entity": { "additionalProperties": false, - "description": "Detailed information about the notification.", + "description": "__Read-only__ Detailed information about the notification.", "properties": { "id": { "description": "The unique ID of the notification's entity, based on the entity type. Returns `null` for an `account` or `promotion` entity.", @@ -5284,21 +5620,21 @@ "type": "object" }, "label": { - "description": "A short description of this notification.", + "description": "__Read-only__ A short description of this notification.", "example": "You have an important ticket open!", "readOnly": true, "type": "string", "x-linode-cli-display": 1 }, "message": { - "description": "A human-readable description of the notification.", + "description": "__Read-only__ A human-readable description of the notification.", "example": "You have an important ticket open!", "readOnly": true, "type": "string", "x-linode-cli-display": 2 }, "severity": { - "description": "The severity of this notification. This field determines how prominently the notification is displayed and the color of the display text.", + "description": "__Read-only__ The severity of this notification. This field determines how prominently the notification is displayed and the color of the display text.", "enum": [ "minor", "major", @@ -5315,7 +5651,7 @@ "x-linode-cli-display": 3 }, "type": { - "description": "The type of notification.", + "description": "__Read-only__ The type of notification.", "enum": [ "migration_scheduled", "migration_imminent", @@ -5335,7 +5671,7 @@ "type": "string" }, "until": { - "description": "If this notification has a duration, this is when the event or action will complete. For example, if there's scheduled maintenance for one of our systems, `until` represents the end of the maintenance window.", + "description": "__Read-only__ If this notification has a duration, this is when the event or action will complete. For example, if there's scheduled maintenance for one of our systems, `until` represents the end of the maintenance window.", "example": null, "format": "date-time", "nullable": true, @@ -5348,7 +5684,7 @@ "x-linode-cli-display": 5 }, "when": { - "description": "If this notification is for an event in the future, this specifies when the action occurs. For example, if a compute instance needs to migrate in response to a security advisory, this field sets the approximate time the compute instance will be taken offline for migration.", + "description": "__Read-only__ If this notification is for an event in the future, this specifies when the action occurs. For example, if a compute instance needs to migrate in response to a security advisory, this field sets the approximate time the compute instance will be taken offline for migration.", "example": null, "format": "date-time", "nullable": true, @@ -5361,21 +5697,24 @@ "x-linode-cli-display": 4 } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/notification.yaml" + } }, "oauth-client": { "additionalProperties": false, "description": "A third-party application registered to Linode that users may log into with their Linode account through our authentication server at [login.linode.com](https://login.linode.com). Using an OAuth Client, a third-party developer may be given access to some, or all, of a User's account for the purposes of their application.", "properties": { "id": { - "description": "The OAuth Client ID. This is used to identify the client, and is a publicly known value (it is not a secret).", + "description": "__Read-only__ The OAuth Client ID. This is used to identify the client, and is a publicly known value (it is not a secret).", "example": "2737bf16b39ab5d7b4a1", "readOnly": true, "type": "string", "x-linode-cli-display": 1 }, "label": { - "description": "The name of this application. This will be presented to users when they are asked to grant it access to their Account.", + "description": "__Filterable__ The name of this application. This will be presented to users when they are asked to grant it access to their Account.", "example": "Test_Client_1", "maxLength": 512, "minLength": 1, @@ -5390,7 +5729,7 @@ }, "public": { "default": false, - "description": "If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the [OAuth spec](https://oauth.net/2/) for more details.", + "description": "__Filterable__ If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the [OAuth spec](https://oauth.net/2/) for more details.", "example": false, "type": "boolean", "x-akamai": { @@ -5409,13 +5748,13 @@ "x-linode-cli-display": 5 }, "secret": { - "description": "The OAuth Client secret, used in the OAuth exchange. This is returned as `` except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly.", + "description": "__Read-only__ The OAuth Client secret, used in the OAuth exchange. This is returned as `` except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly.", "example": "", "readOnly": true, "type": "string" }, "status": { - "description": "The status of this application. `active` by default.", + "description": "__Read-only__ The status of this application. `active` by default.", "enum": [ "active", "disabled", @@ -5431,7 +5770,7 @@ "x-linode-cli-display": 3 }, "thumbnail_url": { - "description": "The URL where this client's thumbnail may be viewed, or `null` if this client does not have a thumbnail set.", + "description": "__Read-only__ The URL where this client's thumbnail may be viewed, or `null` if this client does not have a thumbnail set.", "example": "https://api.linode.com/v4/account/clients/2737bf16b39ab5d7b4a1/thumbnail", "format": "url", "nullable": true, @@ -5439,16 +5778,19 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/oauth-client.yaml" + } }, "page": { - "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { - "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" @@ -5458,32 +5800,35 @@ "description": "An envelope for paginated response. When accessing a collection through a GET endpoint, the results are wrapped in this envelope which includes metadata about those results. Results are presented within a `data` array. See [Pagination](https://techdocs.akamai.com/linode-api/reference/pagination) for more information.", "properties": { "page": { - "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { - "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "results": { - "description": "The total number of results.", + "description": "__Read-only__ The total number of results.", "example": 1, "readOnly": true, "type": "integer" } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/pagination-envelope.yaml" + } }, "payment": { "additionalProperties": false, "description": "Payment object response.", "properties": { "date": { - "description": "When the Payment was made.", + "description": "__Read-only__ When the Payment was made.", "example": "2018-01-15T00:01:01", "format": "date-time", "readOnly": true, @@ -5491,57 +5836,57 @@ "x-linode-cli-display": 2 }, "id": { - "description": "The unique ID of the Payment.", + "description": "__Read-only__ The unique ID of the Payment.", "example": 123, "readOnly": true, "type": "integer", "x-linode-cli-display": 1 }, "usd": { - "description": "The amount, in US dollars, of the Payment.", + "description": "__Read-only__ The amount, in US dollars, of the Payment.", "example": "120.50", "readOnly": true, "type": "integer", "x-linode-cli-display": 3 } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/payment.yaml" + } }, "payment-method": { "additionalProperties": false, "description": "Payment Method Response Object.", "properties": { "created": { - "description": "When the Payment Method was added to the Account.", + "description": "__Read-only__ When the Payment Method was added to the Account.", "example": "2018-01-15T00:01:01", "format": "date-time", "readOnly": true, "type": "string" }, "data": { - "discriminator": { - "propertyName": "type" - }, "oneOf": [ { "additionalProperties": false, "description": "Credit card information.", "properties": { "card_type": { - "description": "The type of credit card.", + "description": "__Read-only__ The type of credit card.", "example": "Discover", "readOnly": true, "type": "string" }, "expiry": { - "description": "The expiration month and year of the credit card.", + "description": "__Read-only__ The expiration month and year of the credit card.", "example": "06/2022", "format": "MM/YYYY", "readOnly": true, "type": "string" }, "last_four": { - "description": "The last four digits of the credit card number.", + "description": "__Read-only__ The last four digits of the credit card number.", "example": "1234", "readOnly": true, "type": "string" @@ -5549,6 +5894,9 @@ }, "title": "Credit card", "type": "object", + "x-akamai": { + "file-path": "schemas/credit-card-data.yaml" + }, "x-linode-ref-name": "Credit Card" }, { @@ -5556,20 +5904,20 @@ "description": "Google Pay information.", "properties": { "card_type": { - "description": "The type of credit card.", + "description": "__Read-only__ The type of credit card.", "example": "Discover", "readOnly": true, "type": "string" }, "expiry": { - "description": "The expiration month and year of the credit card.", + "description": "__Read-only__ The expiration month and year of the credit card.", "example": "06/2022", "format": "MM/YYYY", "readOnly": true, "type": "string" }, "last_four": { - "description": "The last four digits of the credit card number.", + "description": "__Read-only__ The last four digits of the credit card number.", "example": "1234", "readOnly": true, "type": "string" @@ -5577,6 +5925,9 @@ }, "title": "Google Pay", "type": "object", + "x-akamai": { + "file-path": "schemas/google-pay-data.yaml" + }, "x-linode-ref-name": "Google Pay" }, { @@ -5584,13 +5935,13 @@ "description": "PayPal information.", "properties": { "email": { - "description": "The email address associated with your PayPal account.", + "description": "__Read-only__ The email address associated with your PayPal account.", "example": "example@linode.com", "readOnly": true, "type": "string" }, "paypal_id": { - "description": "PayPal Merchant ID associated with your PayPal account.", + "description": "__Read-only__ PayPal Merchant ID associated with your PayPal account.", "example": "ABC1234567890", "readOnly": true, "type": "string" @@ -5598,6 +5949,9 @@ }, "title": "Paypal", "type": "object", + "x-akamai": { + "file-path": "schemas/paypal-data.yaml" + }, "x-linode-ref-name": "Paypal" } ], @@ -5628,7 +5982,10 @@ "x-linode-cli-display": 2 } }, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/payment-method.yaml" + } }, "paypal": { "additionalProperties": false, @@ -5655,27 +6012,33 @@ "redirect_url", "usd" ], - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/paypal.yaml" + } }, "paypal-data": { "additionalProperties": false, "description": "PayPal information.", "properties": { "email": { - "description": "The email address associated with your PayPal account.", + "description": "__Read-only__ The email address associated with your PayPal account.", "example": "example@linode.com", "readOnly": true, "type": "string" }, "paypal_id": { - "description": "PayPal Merchant ID associated with your PayPal account.", + "description": "__Read-only__ PayPal Merchant ID associated with your PayPal account.", "example": "ABC1234567890", "readOnly": true, "type": "string" } }, "title": "Paypal", - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/paypal-data.yaml" + } }, "paypal-execute": { "additionalProperties": false, @@ -5696,11 +6059,14 @@ "payer_id", "payment_id" ], - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/paypal-execute.yaml" + } }, "promotion": { "additionalProperties": false, - "description": "Promotions generally offer a set amount of credit that can be used toward your Linode services, and the promotion expires after a specified date. As well, a monthly cap on the promotional offer is set.\n\nSimply put, a promotion offers a certain amount of credit month, until either the expiration date is passed, or until the total promotional credit is used, whichever comes first.", + "description": "__Read-only__ Promotions generally offer a set amount of credit that can be used toward your Linode services, and the promotion expires after a specified date. As well, a monthly cap on the promotional offer is set.\n\nSimply put, a promotion offers a certain amount of credit month, until either the expiration date is passed, or until the total promotional credit is used, whichever comes first.", "properties": { "credit_monthly_cap": { "description": "The amount available to spend per month.", @@ -5766,7 +6132,10 @@ } }, "readOnly": true, - "type": "object" + "type": "object", + "x-akamai": { + "file-path": "schemas/promotion.yaml" + } }, "properties-entities": { "additionalProperties": false, @@ -5792,7 +6161,7 @@ "description": "The token generated manually for a child account so its proxy user can access the API and CLI without going through an OAuth login.", "properties": { "created": { - "description": "The date and time this token was created.", + "description": "__Filterable__, __Read-only__ The date and time this token was created.", "example": "2024-05-01T00:01:01", "format": "date-time", "readOnly": true, @@ -5806,7 +6175,7 @@ "x-linode-filterable": true }, "expiry": { - "description": "When this token expires. This is default set to 15 minutes from the time of creation. Proxy user tokens can't be renewed. After this time, Akamai revokes the token and you need to generate a new one.", + "description": "__Read-only__ When this token expires. This is default set to 15 minutes from the time of creation. Proxy user tokens can't be renewed. After this time, Akamai revokes the token and you need to generate a new one.", "example": "2024-05-01T00:16:01", "format": "date-time", "readOnly": true, @@ -5814,14 +6183,14 @@ "x-linode-cli-display": 6 }, "id": { - "description": "The proxy user token's unique ID, which can be used to revoke it.", + "description": "__Read-only__ The proxy user token's unique ID, which can be used to revoke it.", "example": 918, "readOnly": true, "type": "integer", "x-linode-cli-display": 1 }, "label": { - "description": "The name of the token. The API automatically sets this to `__