From 80e2b8e03eb436fef27fb2bc5c0ae6eea7efdc83 Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Fri, 12 Sep 2025 16:16:53 +1000 Subject: [PATCH] doc updates --- package-lock.json | 8 +- package.json | 2 +- .../docs/services/account/account/index.md | 3 +- .../docs/services/account/actions/index.md | 6 +- website/docs/services/apps/alerts/index.md | 3 +- website/docs/services/apps/apps/index.md | 20 +- .../apps/daily_bandwidth_metrics/index.md | 5 +- .../services/apps/deployment_logs/index.md | 12 +- .../services/apps/deployment_url/index.md | 6 +- .../docs/services/apps/deployments/index.md | 9 +- website/docs/services/apps/health/index.md | 3 +- .../services/apps/instance_sizes/index.md | 6 +- website/docs/services/apps/instances/index.md | 3 +- website/docs/services/apps/regions/index.md | 3 +- website/docs/services/apps/rollbacks/index.md | 9 +- .../docs/services/billing/balances/index.md | 3 +- .../services/billing/billing_history/index.md | 3 +- .../services/billing/invoice_summary/index.md | 3 +- .../docs/services/billing/invoices/index.md | 12 +- .../services/compute/cdn_endpoints/index.md | 14 +- .../services/compute/certificates/index.md | 35 ++- .../services/compute/domain_records/index.md | 74 ++++- .../docs/services/compute/domains/index.md | 9 +- .../services/compute/droplet_actions/index.md | 28 +- .../droplet_autoscale_pool_history/index.md | 3 +- .../droplet_autoscale_pool_members/index.md | 3 +- .../compute/droplet_autoscale_pools/index.md | 18 +- .../compute/droplet_backup_policies/index.md | 6 +- .../services/compute/droplet_backups/index.md | 3 +- .../services/compute/droplet_kernels/index.md | 3 +- .../compute/droplet_neighbor_ids/index.md | 3 +- .../compute/droplet_snapshots/index.md | 3 +- .../index.md | 3 +- .../docs/services/compute/droplets/index.md | 128 ++++++++- .../droplets_associated_resources/index.md | 15 +- .../compute/droplets_firewalls/index.md | 5 +- .../compute/droplets_neighbors/index.md | 3 +- .../services/compute/firewall_rules/index.md | 7 +- .../services/compute/firewall_tags/index.md | 5 +- .../docs/services/compute/firewalls/index.md | 29 +- .../services/compute/image_actions/index.md | 15 +- website/docs/services/compute/images/index.md | 15 +- .../services/compute/load_balancers/index.md | 253 ++++++++++++++++-- .../docs/services/compute/regions/index.md | 3 +- .../compute/reserved_ip_actions/index.md | 15 +- .../services/compute/reserved_ips/index.md | 20 +- .../services/compute/reserved_ipv6/index.md | 20 +- website/docs/services/compute/sizes/index.md | 3 +- .../docs/services/compute/snapshots/index.md | 9 +- .../docs/services/compute/ssh_keys/index.md | 13 +- website/docs/services/compute/tags/index.md | 19 +- .../services/compute/volume_actions/index.md | 18 +- .../compute/volume_snapshots/index.md | 11 +- .../docs/services/compute/volumes/index.md | 85 +++++- .../compute/vpc_nat_gateways/index.md | 19 +- .../active_garbage_collection/index.md | 3 +- .../docker_credentials/index.md | 6 +- .../garbage_collections/index.md | 18 +- .../container_registry/options/index.md | 4 +- .../container_registry/registries/index.md | 24 +- .../container_registry/repositories/index.md | 12 +- .../repository_manifests/index.md | 12 +- .../repository_tags/index.md | 12 +- .../container_registry/subscriptions/index.md | 7 +- .../databases/autoscale_config/index.md | 3 +- .../docs/services/databases/backups/index.md | 3 +- website/docs/services/databases/ca/index.md | 3 +- .../databases/cluster_config/index.md | 3 +- .../cluster_metrics_credentials/index.md | 7 +- .../docs/services/databases/clusters/index.md | 38 +-- .../databases/connection_pools/index.md | 17 +- website/docs/services/databases/dbs/index.md | 11 +- .../services/databases/events_logs/index.md | 3 +- .../databases/eviction_policies/index.md | 3 +- .../databases/firewall_rules/index.md | 7 +- .../databases/kafka_schema_config/index.md | 3 +- .../kafka_schema_subject_config/index.md | 3 +- .../databases/kafka_schema_version/index.md | 3 +- .../services/databases/kafka_schemas/index.md | 15 +- .../services/databases/kafka_topics/index.md | 11 +- .../services/databases/log_sinks/index.md | 15 +- .../databases/online_migrations/index.md | 9 +- .../databases/opensearch_indexes/index.md | 6 +- .../docs/services/databases/options/index.md | 3 +- .../docs/services/databases/replicas/index.md | 14 +- .../docs/services/databases/sql_mode/index.md | 3 +- .../docs/services/databases/users/index.md | 14 +- .../services/genai/agent_api_keys/index.md | 9 +- .../docs/services/genai/agent_routes/index.md | 3 +- .../docs/services/genai/agent_usage/index.md | 3 +- .../services/genai/agent_versions/index.md | 6 +- website/docs/services/genai/agents/index.md | 33 ++- .../genai/agents_by_anthropic_key/index.md | 3 +- .../genai/agents_by_openai_key/index.md | 3 +- .../genai/anthropic_api_keys/index.md | 9 +- .../genai/datacenter_regions/index.md | 3 +- .../genai/evaluation_datasets/index.md | 3 +- .../genai/evaluation_metrics/index.md | 3 +- .../evaluation_run_prompt_results/index.md | 3 +- .../genai/evaluation_run_results/index.md | 3 +- .../services/genai/evaluation_runs/index.md | 3 +- .../genai/evaluation_test_cases/index.md | 12 +- .../genai/indexing_job_data_sources/index.md | 3 +- .../services/genai/indexing_jobs/index.md | 6 +- .../knowledge_base_data_sources/index.md | 9 +- .../services/genai/knowledge_bases/index.md | 18 +- .../services/genai/model_api_keys/index.md | 9 +- website/docs/services/genai/models/index.md | 3 +- website/docs/services/genai/oauth2/index.md | 6 +- .../services/genai/openai_api_keys/index.md | 9 +- .../docs/services/genai/workspaces/index.md | 9 +- .../kubernetes/associated_resources/index.md | 9 +- .../kubernetes/available_upgrades/index.md | 3 +- .../services/kubernetes/cluster_user/index.md | 3 +- .../services/kubernetes/clusters/index.md | 29 +- .../services/kubernetes/credentials/index.md | 3 +- .../services/kubernetes/lint_checks/index.md | 6 +- .../services/kubernetes/node_pools/index.md | 18 +- .../docs/services/kubernetes/nodes/index.md | 3 +- .../docs/services/kubernetes/options/index.md | 3 +- .../kubernetes/status_messages/index.md | 3 +- .../monitoring/alert_policies/index.md | 27 +- .../docs/services/monitoring/alerts/index.md | 17 +- .../app_cpu_percentage_metrics/index.md | 3 +- .../app_memory_percentage_metrics/index.md | 3 +- .../app_restart_count_metrics/index.md | 3 +- .../services/monitoring/check_states/index.md | 3 +- .../docs/services/monitoring/checks/index.md | 19 +- .../services/monitoring/destinations/index.md | 17 +- .../index.md | 3 +- .../index.md | 3 +- .../index.md | 3 +- .../index.md | 3 +- .../index.md | 3 +- .../index.md | 3 +- .../droplet_bandwidth_metrics/index.md | 3 +- .../monitoring/droplet_cpu_metrics/index.md | 3 +- .../droplet_filesystem_free_metrics/index.md | 3 +- .../droplet_filesystem_size_metrics/index.md | 3 +- .../droplet_load15_metrics/index.md | 3 +- .../monitoring/droplet_load1_metrics/index.md | 3 +- .../monitoring/droplet_load5_metrics/index.md | 3 +- .../droplet_memory_available_metrics/index.md | 3 +- .../droplet_memory_cached_metrics/index.md | 3 +- .../droplet_memory_free_metrics/index.md | 3 +- .../droplet_memory_total_metrics/index.md | 3 +- .../lb_droplets_connections/index.md | 3 +- .../monitoring/lb_droplets_downtime/index.md | 3 +- .../lb_droplets_health_checks/index.md | 3 +- .../index.md | 3 +- .../index.md | 3 +- .../index.md | 3 +- .../index.md | 3 +- .../lb_droplets_http_responses/index.md | 3 +- .../index.md | 3 +- .../index.md | 3 +- .../index.md | 3 +- .../lb_droplets_queue_size/index.md | 3 +- .../lb_frontend_connections_current/index.md | 3 +- .../lb_frontend_connections_limit/index.md | 3 +- .../lb_frontend_cpu_utilization/index.md | 3 +- .../index.md | 3 +- .../index.md | 3 +- .../index.md | 3 +- .../lb_frontend_http_responses/index.md | 3 +- .../index.md | 3 +- .../index.md | 3 +- .../index.md | 3 +- .../index.md | 3 +- .../index.md | 3 +- .../index.md | 3 +- .../index.md | 3 +- .../index.md | 3 +- .../docs/services/monitoring/sinks/index.md | 9 +- .../network/byoip_prefix_resources/index.md | 3 +- .../services/network/byoip_prefixes/index.md | 15 +- .../network/floating_ip_actions/index.md | 15 +- .../services/network/floating_ips/index.md | 20 +- .../partner_attachment_service_keys/index.md | 3 +- .../network/partner_attachments/index.md | 28 +- .../partner_attachments_bgp_auth_key/index.md | 3 +- .../index.md | 3 +- .../services/oneclick/applications/index.md | 7 +- .../projects/default_resources/index.md | 5 +- .../docs/services/projects/defaults/index.md | 5 +- .../docs/services/projects/projects/index.md | 13 +- .../docs/services/projects/resources/index.md | 5 +- .../services/serverless/namespaces/index.md | 13 +- .../services/serverless/triggers/index.md | 19 +- website/docs/services/spaces/keys/index.md | 9 +- website/docs/services/vpcs/members/index.md | 5 +- website/docs/services/vpcs/peerings/index.md | 9 +- .../docs/services/vpcs/vpc_peerings/index.md | 17 +- website/docs/services/vpcs/vpcs/index.md | 21 +- 194 files changed, 1469 insertions(+), 562 deletions(-) diff --git a/package-lock.json b/package-lock.json index 8507af5..4e12ea2 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,7 +9,7 @@ "version": "0.1.0", "dependencies": { "@stackql/pgwire-lite": "^1.0.1", - "@stackql/provider-utils": "^0.4.3" + "@stackql/provider-utils": "^0.4.8" }, "engines": { "node": ">=14.16.0" @@ -92,9 +92,9 @@ } }, "node_modules/@stackql/provider-utils": { - "version": "0.4.3", - "resolved": "https://registry.npmjs.org/@stackql/provider-utils/-/provider-utils-0.4.3.tgz", - "integrity": "sha512-AQkL0ZIwuuT2sWsFE7IbrSWy+sVEkC2H7DJkjyrEzLOcVlP6xGtY8DY7MMNKrlNp4Fqk+EkVhMsbQAukqgX5HQ==", + "version": "0.4.8", + "resolved": "https://registry.npmjs.org/@stackql/provider-utils/-/provider-utils-0.4.8.tgz", + "integrity": "sha512-AptmqlQsCLb4g7H+LYxbOlxTqcSXwP2EA/XeJQ1V9UMZexs9L5sfWYT935Zi0Im7soHSiDZJXnN3CtyQsIlBUA==", "license": "MIT", "dependencies": { "@apidevtools/swagger-parser": "^10.1.1", diff --git a/package.json b/package.json index 97e9621..af5294a 100644 --- a/package.json +++ b/package.json @@ -15,7 +15,7 @@ }, "dependencies": { "@stackql/pgwire-lite": "^1.0.1", - "@stackql/provider-utils": "^0.4.4" + "@stackql/provider-utils": "^0.4.8" }, "keywords": [ "stackql", diff --git a/website/docs/services/account/account/index.md b/website/docs/services/account/account/index.md index 6a819ee..8f48e4f 100644 --- a/website/docs/services/account/account/index.md +++ b/website/docs/services/account/account/index.md @@ -164,7 +164,8 @@ status, status_message, team, uuid -FROM digitalocean.account.account; +FROM digitalocean.account.account +; ``` diff --git a/website/docs/services/account/actions/index.md b/website/docs/services/account/actions/index.md index 53a23a9..c67510e 100644 --- a/website/docs/services/account/actions/index.md +++ b/website/docs/services/account/actions/index.md @@ -250,7 +250,8 @@ started_at, status, type FROM digitalocean.account.actions -WHERE action_id = '{{ action_id }}' -- required; +WHERE action_id = '{{ action_id }}' -- required +; ``` @@ -270,7 +271,8 @@ status, type FROM digitalocean.account.actions WHERE per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` diff --git a/website/docs/services/apps/alerts/index.md b/website/docs/services/apps/alerts/index.md index 239eac6..6dbf5eb 100644 --- a/website/docs/services/apps/alerts/index.md +++ b/website/docs/services/apps/alerts/index.md @@ -158,7 +158,8 @@ progress, slack_webhooks, spec FROM digitalocean.apps.alerts -WHERE app_id = '{{ app_id }}' -- required; +WHERE app_id = '{{ app_id }}' -- required +; ``` diff --git a/website/docs/services/apps/apps/index.md b/website/docs/services/apps/apps/index.md index 7750d7b..8c84e49 100644 --- a/website/docs/services/apps/apps/index.md +++ b/website/docs/services/apps/apps/index.md @@ -444,7 +444,8 @@ updated_at, vpc FROM digitalocean.apps.apps WHERE id = '{{ id }}' -- required -AND name = '{{ name }}'; +AND name = '{{ name }}' +; ``` @@ -476,7 +477,8 @@ vpc FROM digitalocean.apps.apps WHERE page = '{{ page }}' AND per_page = '{{ per_page }}' -AND with_projects = '{{ with_projects }}'; +AND with_projects = '{{ with_projects }}' +; ``` @@ -503,7 +505,7 @@ Accept, Content-Type ) SELECT -'{{ spec }}' --required, +'{{ spec }}' /* required */, '{{ project_id }}', '{{ Accept }}', '{{ Content-Type }}' @@ -581,7 +583,8 @@ Delete an existing app. Once deleted, all active deployments will be permanently ```sql DELETE FROM digitalocean.apps.apps -WHERE id = '{{ id }}' --required; +WHERE id = '{{ id }}' --required +; ``` @@ -607,7 +610,8 @@ EXEC digitalocean.apps.apps.apps_restart @@json= '{ "components": "{{ components }}" -}'; +}' +; ``` @@ -620,7 +624,8 @@ EXEC digitalocean.apps.apps.apps_validate_app_spec '{ "spec": "{{ spec }}", "app_id": "{{ app_id }}" -}'; +}' +; ``` @@ -635,7 +640,8 @@ EXEC digitalocean.apps.apps.apps_assign_alert_destinations '{ "emails": "{{ emails }}", "slack_webhooks": "{{ slack_webhooks }}" -}'; +}' +; ``` diff --git a/website/docs/services/apps/daily_bandwidth_metrics/index.md b/website/docs/services/apps/daily_bandwidth_metrics/index.md index e7854b6..4ce56ab 100644 --- a/website/docs/services/apps/daily_bandwidth_metrics/index.md +++ b/website/docs/services/apps/daily_bandwidth_metrics/index.md @@ -141,7 +141,8 @@ app_bandwidth_usage, date FROM digitalocean.apps.daily_bandwidth_metrics WHERE app_id = '{{ app_id }}' -- required -AND date = '{{ date }}'; +AND date = '{{ date }}' +; ``` @@ -166,7 +167,7 @@ data__app_ids, data__date ) SELECT -'{{ app_ids }}' --required, +'{{ app_ids }}' /* required */, '{{ date }}' RETURNING app_bandwidth_usage, diff --git a/website/docs/services/apps/deployment_logs/index.md b/website/docs/services/apps/deployment_logs/index.md index 01be5f5..c0c5b3c 100644 --- a/website/docs/services/apps/deployment_logs/index.md +++ b/website/docs/services/apps/deployment_logs/index.md @@ -263,7 +263,8 @@ AND deployment_id = '{{ deployment_id }}' -- required AND component_name = '{{ component_name }}' -- required AND type = '{{ type }}' -- required AND follow = '{{ follow }}' -AND pod_connection_timeout = '{{ pod_connection_timeout }}'; +AND pod_connection_timeout = '{{ pod_connection_timeout }}' +; ``` @@ -279,7 +280,8 @@ WHERE app_id = '{{ app_id }}' -- required AND component_name = '{{ component_name }}' -- required AND type = '{{ type }}' -- required AND follow = '{{ follow }}' -AND pod_connection_timeout = '{{ pod_connection_timeout }}'; +AND pod_connection_timeout = '{{ pod_connection_timeout }}' +; ``` @@ -295,7 +297,8 @@ WHERE app_id = '{{ app_id }}' -- required AND deployment_id = '{{ deployment_id }}' -- required AND type = '{{ type }}' -- required AND follow = '{{ follow }}' -AND pod_connection_timeout = '{{ pod_connection_timeout }}'; +AND pod_connection_timeout = '{{ pod_connection_timeout }}' +; ``` @@ -310,7 +313,8 @@ FROM digitalocean.apps.deployment_logs WHERE app_id = '{{ app_id }}' -- required AND type = '{{ type }}' -- required AND follow = '{{ follow }}' -AND pod_connection_timeout = '{{ pod_connection_timeout }}'; +AND pod_connection_timeout = '{{ pod_connection_timeout }}' +; ``` diff --git a/website/docs/services/apps/deployment_url/index.md b/website/docs/services/apps/deployment_url/index.md index ebfb57c..704c891 100644 --- a/website/docs/services/apps/deployment_url/index.md +++ b/website/docs/services/apps/deployment_url/index.md @@ -170,7 +170,8 @@ FROM digitalocean.apps.deployment_url WHERE app_id = '{{ app_id }}' -- required AND deployment_id = '{{ deployment_id }}' -- required AND component_name = '{{ component_name }}' -- required -AND instance_name = '{{ instance_name }}'; +AND instance_name = '{{ instance_name }}' +; ``` @@ -183,7 +184,8 @@ url FROM digitalocean.apps.deployment_url WHERE app_id = '{{ app_id }}' -- required AND component_name = '{{ component_name }}' -- required -AND instance_name = '{{ instance_name }}'; +AND instance_name = '{{ instance_name }}' +; ``` diff --git a/website/docs/services/apps/deployments/index.md b/website/docs/services/apps/deployments/index.md index 239b439..3dc19ef 100644 --- a/website/docs/services/apps/deployments/index.md +++ b/website/docs/services/apps/deployments/index.md @@ -341,7 +341,8 @@ updated_at, workers FROM digitalocean.apps.deployments WHERE app_id = '{{ app_id }}' -- required -AND deployment_id = '{{ deployment_id }}' -- required; +AND deployment_id = '{{ deployment_id }}' -- required +; ``` @@ -369,7 +370,8 @@ FROM digitalocean.apps.deployments WHERE app_id = '{{ app_id }}' -- required AND page = '{{ page }}' AND per_page = '{{ per_page }}' -AND deployment_types = '{{ deployment_types }}'; +AND deployment_types = '{{ deployment_types }}' +; ``` @@ -432,7 +434,8 @@ Immediately cancel an in-progress deployment. ```sql EXEC digitalocean.apps.deployments.apps_cancel_deployment @app_id='{{ app_id }}' --required, -@deployment_id='{{ deployment_id }}' --required; +@deployment_id='{{ deployment_id }}' --required +; ``` diff --git a/website/docs/services/apps/health/index.md b/website/docs/services/apps/health/index.md index 0fee2e5..c19f275 100644 --- a/website/docs/services/apps/health/index.md +++ b/website/docs/services/apps/health/index.md @@ -128,7 +128,8 @@ SELECT components, functions_components FROM digitalocean.apps.health -WHERE app_id = '{{ app_id }}' -- required; +WHERE app_id = '{{ app_id }}' -- required +; ``` diff --git a/website/docs/services/apps/instance_sizes/index.md b/website/docs/services/apps/instance_sizes/index.md index e381b1b..7483f58 100644 --- a/website/docs/services/apps/instance_sizes/index.md +++ b/website/docs/services/apps/instance_sizes/index.md @@ -235,7 +235,8 @@ tier_upgrade_to, usd_per_month, usd_per_second FROM digitalocean.apps.instance_sizes -WHERE slug = '{{ slug }}' -- required; +WHERE slug = '{{ slug }}' -- required +; ``` @@ -246,7 +247,8 @@ List all instance sizes for `service`, `worker`, and `job` components. SELECT discount_percent, instance_sizes -FROM digitalocean.apps.instance_sizes; +FROM digitalocean.apps.instance_sizes +; ``` diff --git a/website/docs/services/apps/instances/index.md b/website/docs/services/apps/instances/index.md index 17a8045..dea52cb 100644 --- a/website/docs/services/apps/instances/index.md +++ b/website/docs/services/apps/instances/index.md @@ -140,7 +140,8 @@ instance_name, component_type, instance_alias FROM digitalocean.apps.instances -WHERE app_id = '{{ app_id }}' -- required; +WHERE app_id = '{{ app_id }}' -- required +; ``` diff --git a/website/docs/services/apps/regions/index.md b/website/docs/services/apps/regions/index.md index 442e859..b2540a8 100644 --- a/website/docs/services/apps/regions/index.md +++ b/website/docs/services/apps/regions/index.md @@ -158,7 +158,8 @@ flag, label, reason, slug -FROM digitalocean.apps.regions; +FROM digitalocean.apps.regions +; ``` diff --git a/website/docs/services/apps/rollbacks/index.md b/website/docs/services/apps/rollbacks/index.md index 11777c2..5fde65a 100644 --- a/website/docs/services/apps/rollbacks/index.md +++ b/website/docs/services/apps/rollbacks/index.md @@ -174,7 +174,8 @@ EXEC digitalocean.apps.rollbacks.apps_validate_rollback '{ "deployment_id": "{{ deployment_id }}", "skip_pin": {{ skip_pin }} -}'; +}' +; ``` @@ -183,7 +184,8 @@ Commit an app rollback. This action permanently applies the rollback and unpins ```sql EXEC digitalocean.apps.rollbacks.apps_commit_rollback -@app_id='{{ app_id }}' --required; +@app_id='{{ app_id }}' --required +; ``` @@ -192,7 +194,8 @@ Revert an app rollback. This action reverts the active rollback by creating a ne ```sql EXEC digitalocean.apps.rollbacks.apps_revert_rollback -@app_id='{{ app_id }}' --required; +@app_id='{{ app_id }}' --required +; ``` diff --git a/website/docs/services/billing/balances/index.md b/website/docs/services/billing/balances/index.md index 30e4cc3..93ac074 100644 --- a/website/docs/services/billing/balances/index.md +++ b/website/docs/services/billing/balances/index.md @@ -134,7 +134,8 @@ account_balance, generated_at, month_to_date_balance, month_to_date_usage -FROM digitalocean.billing.balances; +FROM digitalocean.billing.balances +; ``` diff --git a/website/docs/services/billing/billing_history/index.md b/website/docs/services/billing/billing_history/index.md index 44593de..ba8afab 100644 --- a/website/docs/services/billing/billing_history/index.md +++ b/website/docs/services/billing/billing_history/index.md @@ -146,7 +146,8 @@ date, description, invoice_uuid, type -FROM digitalocean.billing.billing_history; +FROM digitalocean.billing.billing_history +; ``` diff --git a/website/docs/services/billing/invoice_summary/index.md b/website/docs/services/billing/invoice_summary/index.md index 0b600ea..8c768ee 100644 --- a/website/docs/services/billing/invoice_summary/index.md +++ b/website/docs/services/billing/invoice_summary/index.md @@ -188,7 +188,8 @@ user_billing_address, user_company, user_email FROM digitalocean.billing.invoice_summary -WHERE invoice_uuid = '{{ invoice_uuid }}' -- required; +WHERE invoice_uuid = '{{ invoice_uuid }}' -- required +; ``` diff --git a/website/docs/services/billing/invoices/index.md b/website/docs/services/billing/invoices/index.md index be169b7..0430d55 100644 --- a/website/docs/services/billing/invoices/index.md +++ b/website/docs/services/billing/invoices/index.md @@ -253,7 +253,8 @@ start_time FROM digitalocean.billing.invoices WHERE invoice_uuid = '{{ invoice_uuid }}' -- required AND per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` @@ -268,7 +269,8 @@ links, meta FROM digitalocean.billing.invoices WHERE per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` @@ -289,7 +291,8 @@ To retrieve a CSV for an invoice, send a GET request to `/v2/customers/my/invoic ```sql EXEC digitalocean.billing.invoices.invoices_get_csv_by_uuid -@invoice_uuid='{{ invoice_uuid }}' --required; +@invoice_uuid='{{ invoice_uuid }}' --required +; ``` @@ -298,7 +301,8 @@ To retrieve a PDF for an invoice, send a GET request to `/v2/customers/my/invoic ```sql EXEC digitalocean.billing.invoices.invoices_get_pdf_by_uuid -@invoice_uuid='{{ invoice_uuid }}' --required; +@invoice_uuid='{{ invoice_uuid }}' --required +; ``` diff --git a/website/docs/services/compute/cdn_endpoints/index.md b/website/docs/services/compute/cdn_endpoints/index.md index 8d3e686..8ddcd65 100644 --- a/website/docs/services/compute/cdn_endpoints/index.md +++ b/website/docs/services/compute/cdn_endpoints/index.md @@ -256,7 +256,8 @@ endpoint, origin, ttl FROM digitalocean.compute.cdn_endpoints -WHERE cdn_id = '{{ cdn_id }}' -- required; +WHERE cdn_id = '{{ cdn_id }}' -- required +; ``` @@ -274,7 +275,8 @@ origin, ttl FROM digitalocean.compute.cdn_endpoints WHERE per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` @@ -301,7 +303,7 @@ data__certificate_id, data__custom_domain ) SELECT -'{{ origin }}' --required, +'{{ origin }}' /* required */, {{ ttl }}, '{{ certificate_id }}', '{{ custom_domain }}' @@ -384,7 +386,8 @@ To delete a specific CDN endpoint, send a DELETE request to
`/v2/cdn/endpoi ```sql DELETE FROM digitalocean.compute.cdn_endpoints -WHERE cdn_id = '{{ cdn_id }}' --required; +WHERE cdn_id = '{{ cdn_id }}' --required +; ``` @@ -408,7 +411,8 @@ EXEC digitalocean.compute.cdn_endpoints.cdn_purge_cache @@json= '{ "files": "{{ files }}" -}'; +}' +; ``` diff --git a/website/docs/services/compute/certificates/index.md b/website/docs/services/compute/certificates/index.md index a1c0c3c..ab37908 100644 --- a/website/docs/services/compute/certificates/index.md +++ b/website/docs/services/compute/certificates/index.md @@ -184,7 +184,7 @@ The following methods are available for this resource: - + data__name To upload new SSL certificate which you have previously generated, send a POST
request to `/v2/certificates`.

When uploading a user-generated certificate, the `private_key`,
`leaf_certificate`, and optionally the `certificate_chain` attributes should
be provided. The type must be set to `custom`.

When using Let's Encrypt to create a certificate, the `dns_names` attribute
must be provided, and the type must be set to `lets_encrypt`.
@@ -258,7 +258,8 @@ sha1_fingerprint, state, type FROM digitalocean.compute.certificates -WHERE certificate_id = '{{ certificate_id }}' -- required; +WHERE certificate_id = '{{ certificate_id }}' -- required +; ``` @@ -278,7 +279,8 @@ type FROM digitalocean.compute.certificates WHERE per_page = '{{ per_page }}' AND page = '{{ page }}' -AND name = '{{ name }}'; +AND name = '{{ name }}' +; ``` @@ -299,10 +301,14 @@ To upload new SSL certificate which you have previously generated, send a POST + A unique human-readable name referring to a certificate. + + - name: type + value: string + description: > + A string representing the type of the certificate. The value will be `custom` for a user-uploaded certificate or `lets_encrypt` for one automatically generated with Let's Encrypt. + + valid_values: ['custom', 'lets_encrypt'] + - name: dns_names + value: array + description: > + An array of fully qualified domain names (FQDNs) for which the certificate was issued. A certificate covering all subdomains can be issued using a wildcard (e.g. `*.example.com`). + ``` @@ -333,7 +355,8 @@ To delete a specific certificate, send a DELETE request to
`/v2/certificate ```sql DELETE FROM digitalocean.compute.certificates -WHERE certificate_id = '{{ certificate_id }}' --required; +WHERE certificate_id = '{{ certificate_id }}' --required +; ``` diff --git a/website/docs/services/compute/domain_records/index.md b/website/docs/services/compute/domain_records/index.md index c49a35f..9ca1b96 100644 --- a/website/docs/services/compute/domain_records/index.md +++ b/website/docs/services/compute/domain_records/index.md @@ -204,7 +204,7 @@ The following methods are available for this resource: - domain_name + domain_name, data__type To create a new record to a domain, send a POST request to
`/v2/domains/$DOMAIN_NAME/records`.

The request must include all of the required fields for the domain record type
being added.

See the [attribute table]https://docs.digitalocean.com/products/networking/dns/how-to/manage-records/ for details regarding record
types and their respective required attributes.
@@ -305,7 +305,8 @@ type, weight FROM digitalocean.compute.domain_records WHERE domain_name = '{{ domain_name }}' -- required -AND domain_record_id = '{{ domain_record_id }}' -- required; +AND domain_record_id = '{{ domain_record_id }}' -- required +; ``` @@ -329,7 +330,8 @@ WHERE domain_name = '{{ domain_name }}' -- required AND name = '{{ name }}' AND type = '{{ type }}' AND per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` @@ -350,9 +352,27 @@ To create a new record to a domain, send a POST request to
`/v2/domains/$DO ```sql INSERT INTO digitalocean.compute.domain_records ( +data__type, +data__name, +data__data, +data__priority, +data__port, +data__ttl, +data__weight, +data__flags, +data__tag, domain_name ) SELECT +'{{ type }}' /* required */, +'{{ name }}', +'{{ data }}', +{{ priority }}, +{{ port }}, +{{ ttl }}, +{{ weight }}, +{{ flags }}, +'{{ tag }}', '{{ domain_name }}' RETURNING domain_record @@ -368,6 +388,51 @@ domain_record - name: domain_name value: string description: Required parameter for the domain_records resource. + - name: type + value: string + description: > + The type of the DNS record. For example: A, CNAME, TXT, ... + + - name: name + value: string + description: > + The host name, alias, or service being defined by the record. + + - name: data + value: string + description: > + Variable data depending on record type. For example, the "data" value for an A record would be the IPv4 address to which the domain will be mapped. For a CAA record, it would contain the domain name of the CA being granted permission to issue certificates. + + - name: priority + value: integer + description: > + The priority for SRV and MX records. + + - name: port + value: integer + description: > + The port for SRV records. + + - name: ttl + value: integer + description: > + This value is the time to live for the record, in seconds. This defines the time frame that clients can cache queried information before a refresh should be requested. + + - name: weight + value: integer + description: > + The weight for SRV records. + + - name: flags + value: integer + description: > + An unsigned integer between 0-255 used for CAA records. + + - name: tag + value: string + description: > + The parameter tag for CAA records. Valid values are "issue", "issuewild", or "iodef" + ``` @@ -458,7 +523,8 @@ To delete a record for a domain, send a DELETE request to
`/v2/domains/$DOM ```sql DELETE FROM digitalocean.compute.domain_records WHERE domain_name = '{{ domain_name }}' --required -AND domain_record_id = '{{ domain_record_id }}' --required; +AND domain_record_id = '{{ domain_record_id }}' --required +; ``` diff --git a/website/docs/services/compute/domains/index.md b/website/docs/services/compute/domains/index.md index fe6eb1f..e6c27ad 100644 --- a/website/docs/services/compute/domains/index.md +++ b/website/docs/services/compute/domains/index.md @@ -209,7 +209,8 @@ ip_address, ttl, zone_file FROM digitalocean.compute.domains -WHERE domain_name = '{{ domain_name }}' -- required; +WHERE domain_name = '{{ domain_name }}' -- required +; ``` @@ -224,7 +225,8 @@ ttl, zone_file FROM digitalocean.compute.domains WHERE per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` @@ -291,7 +293,8 @@ To delete a domain, send a DELETE request to `/v2/domains/$DOMAIN_NAME`.
```sql DELETE FROM digitalocean.compute.domains -WHERE domain_name = '{{ domain_name }}' --required; +WHERE domain_name = '{{ domain_name }}' --required +; ``` diff --git a/website/docs/services/compute/droplet_actions/index.md b/website/docs/services/compute/droplet_actions/index.md index 6c3892c..964d5c0 100644 --- a/website/docs/services/compute/droplet_actions/index.md +++ b/website/docs/services/compute/droplet_actions/index.md @@ -194,14 +194,14 @@ The following methods are available for this resource: - droplet_id + droplet_id, type - To initiate an action on a Droplet send a POST request to
`/v2/droplets/$DROPLET_ID/actions`. In the JSON body to the request,
set the `type` attribute to on of the supported action types:

| Action | Details | Additionally Required Permission |
| ---------------------------------------- | ----------- | ----------- |
| <nobr>`enable_backups`</nobr> | Enables backups for a Droplet | |
| <nobr>`disable_backups`</nobr> | Disables backups for a Droplet | |
| <nobr>`change_backup_policy`</nobr> | Update the backup policy for a Droplet | |
| <nobr>`reboot`</nobr> | Reboots a Droplet. A `reboot` action is an attempt to reboot the Droplet in a graceful way, similar to using the `reboot` command from the console. | |
| <nobr>`power_cycle`</nobr> | Power cycles a Droplet. A `powercycle` action is similar to pushing the reset button on a physical machine, it's similar to booting from scratch. | |
| <nobr>`shutdown`</nobr> | Shutsdown a Droplet. A shutdown action is an attempt to shutdown the Droplet in a graceful way, similar to using the `shutdown` command from the console. Since a `shutdown` command can fail, this action guarantees that the command is issued, not that it succeeds. The preferred way to turn off a Droplet is to attempt a shutdown, with a reasonable timeout, followed by a `power_off` action to ensure the Droplet is off. | |
| <nobr>`power_off`</nobr> | Powers off a Droplet. A `power_off` event is a hard shutdown and should only be used if the `shutdown` action is not successful. It is similar to cutting the power on a server and could lead to complications. | |
| <nobr>`power_on`</nobr> | Powers on a Droplet. | |
| <nobr>`restore`</nobr> | Restore a Droplet using a backup image. The image ID that is passed in must be a backup of the current Droplet instance. The operation will leave any embedded SSH keys intact. | droplet:admin |
| <nobr>`password_reset`</nobr> | Resets the root password for a Droplet. A new password will be provided via email. It must be changed after first use. | droplet:admin |
| <nobr>`resize`</nobr> | Resizes a Droplet. Set the `size` attribute to a size slug. If a permanent resize with disk changes included is desired, set the `disk` attribute to `true`. | droplet:create |
| <nobr>`rebuild`</nobr> | Rebuilds a Droplet from a new base image. Set the `image` attribute to an image ID or slug. | droplet:admin |
| <nobr>`rename`</nobr> | Renames a Droplet. | |
| <nobr>`change_kernel`</nobr> | Changes a Droplet's kernel. Only applies to Droplets with externally managed kernels. All Droplets created after March 2017 use internal kernels by default. | |
| <nobr>`enable_ipv6`</nobr> | Enables IPv6 for a Droplet. Once enabled for a Droplet, IPv6 can not be disabled. When enabling IPv6 on an existing Droplet, [additional OS-level configuration](https://docs.digitalocean.com/products/networking/ipv6/how-to/enable/#on-existing-droplets) is required. | |
| <nobr>`snapshot`</nobr> | Takes a snapshot of a Droplet. | image:create |
+ To initiate an action on a Droplet send a POST request to
`/v2/droplets/$DROPLET_ID/actions`. In the JSON body to the request,
set the `type` attribute to on of the supported action types:

| Action | Details | Additionally Required Permission |
| ---------------------------------------- | ----------- | ----------- |
| `enable_backups` | Enables backups for a Droplet | |
| `disable_backups` | Disables backups for a Droplet | |
| `change_backup_policy` | Update the backup policy for a Droplet | |
| `reboot` | Reboots a Droplet. A `reboot` action is an attempt to reboot the Droplet in a graceful way, similar to using the `reboot` command from the console. | |
| `power_cycle` | Power cycles a Droplet. A `powercycle` action is similar to pushing the reset button on a physical machine, it's similar to booting from scratch. | |
| `shutdown` | Shutsdown a Droplet. A shutdown action is an attempt to shutdown the Droplet in a graceful way, similar to using the `shutdown` command from the console. Since a `shutdown` command can fail, this action guarantees that the command is issued, not that it succeeds. The preferred way to turn off a Droplet is to attempt a shutdown, with a reasonable timeout, followed by a `power_off` action to ensure the Droplet is off. | |
| `power_off` | Powers off a Droplet. A `power_off` event is a hard shutdown and should only be used if the `shutdown` action is not successful. It is similar to cutting the power on a server and could lead to complications. | |
| `power_on` | Powers on a Droplet. | |
| `restore` | Restore a Droplet using a backup image. The image ID that is passed in must be a backup of the current Droplet instance. The operation will leave any embedded SSH keys intact. | droplet:admin |
| `password_reset` | Resets the root password for a Droplet. A new password will be provided via email. It must be changed after first use. | droplet:admin |
| `resize` | Resizes a Droplet. Set the `size` attribute to a size slug. If a permanent resize with disk changes included is desired, set the `disk` attribute to `true`. | droplet:create |
| `rebuild` | Rebuilds a Droplet from a new base image. Set the `image` attribute to an image ID or slug. | droplet:admin |
| `rename` | Renames a Droplet. | |
| `change_kernel` | Changes a Droplet's kernel. Only applies to Droplets with externally managed kernels. All Droplets created after March 2017 use internal kernels by default. | |
| `enable_ipv6` | Enables IPv6 for a Droplet. Once enabled for a Droplet, IPv6 can not be disabled. When enabling IPv6 on an existing Droplet, [additional OS-level configuration](https://docs.digitalocean.com/products/networking/ipv6/how-to/enable/#on-existing-droplets) is required. | |
| `snapshot` | Takes a snapshot of a Droplet. | image:create |
- + type tag_name Some actions can be performed in bulk on tagged Droplets. The actions can be
initiated by sending a POST to `/v2/droplets/actions?tag_name=$TAG_NAME` with
the action arguments.

Only a sub-set of action types are supported:

- `power_cycle`
- `power_on`
- `power_off`
- `shutdown`
- `enable_ipv6`
- `enable_backups`
- `disable_backups`
- `snapshot` (also requires `image:create` permission)
@@ -275,7 +275,8 @@ status, type FROM digitalocean.compute.droplet_actions WHERE droplet_id = '{{ droplet_id }}' -- required -AND action_id = '{{ action_id }}' -- required; +AND action_id = '{{ action_id }}' -- required +; ``` @@ -296,7 +297,8 @@ type FROM digitalocean.compute.droplet_actions WHERE droplet_id = '{{ droplet_id }}' -- required AND per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` @@ -313,11 +315,16 @@ AND page = '{{ page }}'; > -To initiate an action on a Droplet send a POST request to
`/v2/droplets/$DROPLET_ID/actions`. In the JSON body to the request,
set the `type` attribute to on of the supported action types:

| Action | Details | Additionally Required Permission |
| ---------------------------------------- | ----------- | ----------- |
| <nobr>`enable_backups`</nobr> | Enables backups for a Droplet | |
| <nobr>`disable_backups`</nobr> | Disables backups for a Droplet | |
| <nobr>`change_backup_policy`</nobr> | Update the backup policy for a Droplet | |
| <nobr>`reboot`</nobr> | Reboots a Droplet. A `reboot` action is an attempt to reboot the Droplet in a graceful way, similar to using the `reboot` command from the console. | |
| <nobr>`power_cycle`</nobr> | Power cycles a Droplet. A `powercycle` action is similar to pushing the reset button on a physical machine, it's similar to booting from scratch. | |
| <nobr>`shutdown`</nobr> | Shutsdown a Droplet. A shutdown action is an attempt to shutdown the Droplet in a graceful way, similar to using the `shutdown` command from the console. Since a `shutdown` command can fail, this action guarantees that the command is issued, not that it succeeds. The preferred way to turn off a Droplet is to attempt a shutdown, with a reasonable timeout, followed by a `power_off` action to ensure the Droplet is off. | |
| <nobr>`power_off`</nobr> | Powers off a Droplet. A `power_off` event is a hard shutdown and should only be used if the `shutdown` action is not successful. It is similar to cutting the power on a server and could lead to complications. | |
| <nobr>`power_on`</nobr> | Powers on a Droplet. | |
| <nobr>`restore`</nobr> | Restore a Droplet using a backup image. The image ID that is passed in must be a backup of the current Droplet instance. The operation will leave any embedded SSH keys intact. | droplet:admin |
| <nobr>`password_reset`</nobr> | Resets the root password for a Droplet. A new password will be provided via email. It must be changed after first use. | droplet:admin |
| <nobr>`resize`</nobr> | Resizes a Droplet. Set the `size` attribute to a size slug. If a permanent resize with disk changes included is desired, set the `disk` attribute to `true`. | droplet:create |
| <nobr>`rebuild`</nobr> | Rebuilds a Droplet from a new base image. Set the `image` attribute to an image ID or slug. | droplet:admin |
| <nobr>`rename`</nobr> | Renames a Droplet. | |
| <nobr>`change_kernel`</nobr> | Changes a Droplet's kernel. Only applies to Droplets with externally managed kernels. All Droplets created after March 2017 use internal kernels by default. | |
| <nobr>`enable_ipv6`</nobr> | Enables IPv6 for a Droplet. Once enabled for a Droplet, IPv6 can not be disabled. When enabling IPv6 on an existing Droplet, [additional OS-level configuration](https://docs.digitalocean.com/products/networking/ipv6/how-to/enable/#on-existing-droplets) is required. | |
| <nobr>`snapshot`</nobr> | Takes a snapshot of a Droplet. | image:create |
+To initiate an action on a Droplet send a POST request to
`/v2/droplets/$DROPLET_ID/actions`. In the JSON body to the request,
set the `type` attribute to on of the supported action types:

| Action | Details | Additionally Required Permission |
| ---------------------------------------- | ----------- | ----------- |
| `enable_backups` | Enables backups for a Droplet | |
| `disable_backups` | Disables backups for a Droplet | |
| `change_backup_policy` | Update the backup policy for a Droplet | |
| `reboot` | Reboots a Droplet. A `reboot` action is an attempt to reboot the Droplet in a graceful way, similar to using the `reboot` command from the console. | |
| `power_cycle` | Power cycles a Droplet. A `powercycle` action is similar to pushing the reset button on a physical machine, it's similar to booting from scratch. | |
| `shutdown` | Shutsdown a Droplet. A shutdown action is an attempt to shutdown the Droplet in a graceful way, similar to using the `shutdown` command from the console. Since a `shutdown` command can fail, this action guarantees that the command is issued, not that it succeeds. The preferred way to turn off a Droplet is to attempt a shutdown, with a reasonable timeout, followed by a `power_off` action to ensure the Droplet is off. | |
| `power_off` | Powers off a Droplet. A `power_off` event is a hard shutdown and should only be used if the `shutdown` action is not successful. It is similar to cutting the power on a server and could lead to complications. | |
| `power_on` | Powers on a Droplet. | |
| `restore` | Restore a Droplet using a backup image. The image ID that is passed in must be a backup of the current Droplet instance. The operation will leave any embedded SSH keys intact. | droplet:admin |
| `password_reset` | Resets the root password for a Droplet. A new password will be provided via email. It must be changed after first use. | droplet:admin |
| `resize` | Resizes a Droplet. Set the `size` attribute to a size slug. If a permanent resize with disk changes included is desired, set the `disk` attribute to `true`. | droplet:create |
| `rebuild` | Rebuilds a Droplet from a new base image. Set the `image` attribute to an image ID or slug. | droplet:admin |
| `rename` | Renames a Droplet. | |
| `change_kernel` | Changes a Droplet's kernel. Only applies to Droplets with externally managed kernels. All Droplets created after March 2017 use internal kernels by default. | |
| `enable_ipv6` | Enables IPv6 for a Droplet. Once enabled for a Droplet, IPv6 can not be disabled. When enabling IPv6 on an existing Droplet, [additional OS-level configuration](https://docs.digitalocean.com/products/networking/ipv6/how-to/enable/#on-existing-droplets) is required. | |
| `snapshot` | Takes a snapshot of a Droplet. | image:create |
```sql EXEC digitalocean.compute.droplet_actions.droplet_actions_post -@droplet_id='{{ droplet_id }}' --required; +@droplet_id='{{ droplet_id }}' --required +@@json= +'{ +"type": "{{ type }}" +}' +; ``` @@ -326,7 +333,12 @@ Some actions can be performed in bulk on tagged Droplets. The actions can be
diff --git a/website/docs/services/compute/droplet_autoscale_pool_history/index.md b/website/docs/services/compute/droplet_autoscale_pool_history/index.md index 193ef17..7b69399 100644 --- a/website/docs/services/compute/droplet_autoscale_pool_history/index.md +++ b/website/docs/services/compute/droplet_autoscale_pool_history/index.md @@ -170,7 +170,8 @@ updated_at FROM digitalocean.compute.droplet_autoscale_pool_history WHERE autoscale_pool_id = '{{ autoscale_pool_id }}' -- required AND per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` diff --git a/website/docs/services/compute/droplet_autoscale_pool_members/index.md b/website/docs/services/compute/droplet_autoscale_pool_members/index.md index 0700b83..473e37e 100644 --- a/website/docs/services/compute/droplet_autoscale_pool_members/index.md +++ b/website/docs/services/compute/droplet_autoscale_pool_members/index.md @@ -164,7 +164,8 @@ updated_at FROM digitalocean.compute.droplet_autoscale_pool_members WHERE autoscale_pool_id = '{{ autoscale_pool_id }}' -- required AND per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` diff --git a/website/docs/services/compute/droplet_autoscale_pools/index.md b/website/docs/services/compute/droplet_autoscale_pools/index.md index 129bc26..afe4b4b 100644 --- a/website/docs/services/compute/droplet_autoscale_pools/index.md +++ b/website/docs/services/compute/droplet_autoscale_pools/index.md @@ -288,7 +288,8 @@ droplet_template, status, updated_at FROM digitalocean.compute.droplet_autoscale_pools -WHERE autoscale_pool_id = '{{ autoscale_pool_id }}' -- required; +WHERE autoscale_pool_id = '{{ autoscale_pool_id }}' -- required +; ``` @@ -309,7 +310,8 @@ updated_at FROM digitalocean.compute.droplet_autoscale_pools WHERE per_page = '{{ per_page }}' AND page = '{{ page }}' -AND name = '{{ name }}'; +AND name = '{{ name }}' +; ``` @@ -335,9 +337,9 @@ data__config, data__droplet_template ) SELECT -'{{ name }}' --required, -'{{ config }}' --required, -'{{ droplet_template }}' --required +'{{ name }}' /* required */, +'{{ config }}' /* required */, +'{{ droplet_template }}' /* required */ RETURNING autoscale_pool ; @@ -410,7 +412,8 @@ To destroy an autoscale pool, send a DELETE request to the `/v2/droplets/autosca ```sql DELETE FROM digitalocean.compute.droplet_autoscale_pools -WHERE autoscale_pool_id = '{{ autoscale_pool_id }}' --required; +WHERE autoscale_pool_id = '{{ autoscale_pool_id }}' --required +; ``` @@ -431,7 +434,8 @@ To destroy an autoscale pool and its associated resources (Droplets),
send ```sql EXEC digitalocean.compute.droplet_autoscale_pools.autoscalepools_delete_dangerous @autoscale_pool_id='{{ autoscale_pool_id }}' --required, -@X-Dangerous='{{ X-Dangerous }}' --required; +@X-Dangerous='{{ X-Dangerous }}' --required +; ``` diff --git a/website/docs/services/compute/droplet_backup_policies/index.md b/website/docs/services/compute/droplet_backup_policies/index.md index 38f4604..710dd53 100644 --- a/website/docs/services/compute/droplet_backup_policies/index.md +++ b/website/docs/services/compute/droplet_backup_policies/index.md @@ -175,7 +175,8 @@ backup_enabled, backup_policy, next_backup_window FROM digitalocean.compute.droplet_backup_policies -WHERE droplet_id = '{{ droplet_id }}' -- required; +WHERE droplet_id = '{{ droplet_id }}' -- required +; ``` @@ -187,7 +188,8 @@ SELECT * FROM digitalocean.compute.droplet_backup_policies WHERE per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` diff --git a/website/docs/services/compute/droplet_backups/index.md b/website/docs/services/compute/droplet_backups/index.md index 4b1c7f2..54b5f55 100644 --- a/website/docs/services/compute/droplet_backups/index.md +++ b/website/docs/services/compute/droplet_backups/index.md @@ -170,7 +170,8 @@ type FROM digitalocean.compute.droplet_backups WHERE droplet_id = '{{ droplet_id }}' -- required AND per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` diff --git a/website/docs/services/compute/droplet_kernels/index.md b/website/docs/services/compute/droplet_kernels/index.md index 77f413f..afe2733 100644 --- a/website/docs/services/compute/droplet_kernels/index.md +++ b/website/docs/services/compute/droplet_kernels/index.md @@ -146,7 +146,8 @@ version FROM digitalocean.compute.droplet_kernels WHERE droplet_id = '{{ droplet_id }}' -- required AND per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` diff --git a/website/docs/services/compute/droplet_neighbor_ids/index.md b/website/docs/services/compute/droplet_neighbor_ids/index.md index 8b35561..efb1739 100644 --- a/website/docs/services/compute/droplet_neighbor_ids/index.md +++ b/website/docs/services/compute/droplet_neighbor_ids/index.md @@ -111,7 +111,8 @@ To retrieve a list of all Droplets that are co-located on the same physical
diff --git a/website/docs/services/compute/droplet_snapshots/index.md b/website/docs/services/compute/droplet_snapshots/index.md index 19e78bb..4b1aa57 100644 --- a/website/docs/services/compute/droplet_snapshots/index.md +++ b/website/docs/services/compute/droplet_snapshots/index.md @@ -170,7 +170,8 @@ type FROM digitalocean.compute.droplet_snapshots WHERE droplet_id = '{{ droplet_id }}' -- required AND per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` diff --git a/website/docs/services/compute/droplet_supported_backup_policies/index.md b/website/docs/services/compute/droplet_supported_backup_policies/index.md index 9531a67..ca7bd56 100644 --- a/website/docs/services/compute/droplet_supported_backup_policies/index.md +++ b/website/docs/services/compute/droplet_supported_backup_policies/index.md @@ -140,7 +140,8 @@ possible_days, possible_window_starts, retention_period_days, window_length_hours -FROM digitalocean.compute.droplet_supported_backup_policies; +FROM digitalocean.compute.droplet_supported_backup_policies +; ``` diff --git a/website/docs/services/compute/droplets/index.md b/website/docs/services/compute/droplets/index.md index d55a0a2..4160d4d 100644 --- a/website/docs/services/compute/droplets/index.md +++ b/website/docs/services/compute/droplets/index.md @@ -334,7 +334,7 @@ The following methods are available for this resource: - + data__name To create a new Droplet, send a POST request to `/v2/droplets` setting the
required attributes.

A Droplet will be created using the provided information. The response body
will contain a JSON object with a key called `droplet`. The value will be an
object containing the standard attributes for your new Droplet. The response
code, 202 Accepted, does not indicate the success or failure of the operation,
just that the request has been accepted for processing. The `actions` returned
as part of the response's `links` object can be used to check the status
of the Droplet create event.

### Create Multiple Droplets

Creating multiple Droplets is very similar to creating a single Droplet.
Instead of sending `name` as a string, send `names` as an array of strings. A
Droplet will be created for each name you send using the associated
information. Up to ten Droplets may be created this way at a time.

Rather than returning a single Droplet, the response body will contain a JSON
array with a key called `droplets`. This will be set to an array of JSON
objects, each of which will contain the standard Droplet attributes. The
response code, 202 Accepted, does not indicate the success or failure of any
operation, just that the request has been accepted for processing. The array
of `actions` returned as part of the response's `links` object can be used to
check the status of each individual Droplet create event.
@@ -445,7 +445,8 @@ vcpus, volume_ids, vpc_uuid FROM digitalocean.compute.droplets -WHERE droplet_id = '{{ droplet_id }}' -- required; +WHERE droplet_id = '{{ droplet_id }}' -- required +; ``` @@ -482,7 +483,8 @@ WHERE per_page = '{{ per_page }}' AND page = '{{ page }}' AND tag_name = '{{ tag_name }}' AND name = '{{ name }}' -AND type = '{{ type }}'; +AND type = '{{ type }}' +; ``` @@ -503,10 +505,38 @@ To create a new Droplet, send a POST request to `/v2/droplets` setting the
```sql INSERT INTO digitalocean.compute.droplets ( - +data__name, +data__region, +data__size, +data__image, +data__ssh_keys, +data__backups, +data__backup_policy, +data__ipv6, +data__monitoring, +data__tags, +data__user_data, +data__private_networking, +data__volumes, +data__vpc_uuid, +data__with_droplet_agent ) SELECT - +'{{ name }}' /* required */, +'{{ region }}', +'{{ size }}', +'{{ image }}', +'{{ ssh_keys }}', +{{ backups }}, +'{{ backup_policy }}', +{{ ipv6 }}, +{{ monitoring }}, +'{{ tags }}', +'{{ user_data }}', +{{ private_networking }}, +'{{ volumes }}', +'{{ vpc_uuid }}', +{{ with_droplet_agent }} ; ``` @@ -516,6 +546,88 @@ SELECT # Description fields are for documentation purposes - name: droplets props: + - name: name + value: string + description: > + The human-readable string you wish to use when displaying the Droplet name. The name, if set to a domain name managed in the DigitalOcean DNS management system, will configure a PTR record for the Droplet. The name set during creation will also determine the hostname for the Droplet in its internal configuration. + + - name: region + value: string + description: > + The slug identifier for the region that you wish to deploy the Droplet in. If the specific datacenter is not not important, a slug prefix (e.g. `nyc`) can be used to deploy the Droplet in any of the that region's locations (`nyc1`, `nyc2`, or `nyc3`). If the region is omitted from the create request completely, the Droplet may deploy in any region. + + - name: size + value: string + description: > + The slug identifier for the size that you wish to select for this Droplet. + + - name: image + value: string + description: > + The image ID of a public or private image or the slug identifier for a public image. This image will be the base image for your Droplet.
Requires `image:read` scope. + + - name: ssh_keys + value: array + description: > + An array containing the IDs or fingerprints of the SSH keys that you wish to embed in the Droplet's root account upon creation. You must add the keys to your team before they can be embedded on a Droplet.
Requires `ssh_key:read` scope. + + default: + - name: backups + value: boolean + description: > + A boolean indicating whether automated backups should be enabled for the Droplet. + + default: false + - name: backup_policy + value: object + description: > + An object specifying the backup policy for the Droplet. If omitted and `backups` is `true`, the backup plan will default to daily. + + - name: ipv6 + value: boolean + description: > + A boolean indicating whether to enable IPv6 on the Droplet. + + default: false + - name: monitoring + value: boolean + description: > + A boolean indicating whether to install the DigitalOcean agent for monitoring. + + default: false + - name: tags + value: array + description: > + A flat array of tag names as strings to apply to the Droplet after it is created. Tag names can either be existing or new tags.
Requires `tag:create` scope. + + default: + - name: user_data + value: string + description: > + A string containing 'user data' which may be used to configure the Droplet on first boot, often a 'cloud-config' file or Bash script. It must be plain text and may not exceed 64 KiB in size. + + - name: private_networking + value: boolean + description: > + This parameter has been deprecated. Use `vpc_uuid` instead to specify a VPC network for the Droplet. If no `vpc_uuid` is provided, the Droplet will be placed in your account's default VPC for the region. + + default: false + - name: volumes + value: array + description: > + An array of IDs for block storage volumes that will be attached to the Droplet once created. The volumes must not already be attached to an existing Droplet.
Requires `block_storage:read` scpoe. + + default: + - name: vpc_uuid + value: string + description: > + A string specifying the UUID of the VPC to which the Droplet will be assigned. If excluded, the Droplet will be assigned to your account's default VPC for the region.
Requires `vpc:read` scope. + + - name: with_droplet_agent + value: boolean + description: > + A boolean indicating whether to install the DigitalOcean agent used for providing access to the Droplet web console in the control panel. By default, the agent is installed on new Droplets but installation errors (i.e. OS not supported) are ignored. To prevent it from being installed, set to `false`. To make installation errors fatal, explicitly set it to `true`. + ``` @@ -536,7 +648,8 @@ To delete a Droplet, send a DELETE request to `/v2/droplets/$DROPLET_ID`.
< ```sql DELETE FROM digitalocean.compute.droplets -WHERE droplet_id = '{{ droplet_id }}' --required; +WHERE droplet_id = '{{ droplet_id }}' --required +; ``` @@ -545,7 +658,8 @@ To delete **all** Droplets assigned to a specific tag, include the `tag_name`
diff --git a/website/docs/services/compute/droplets_associated_resources/index.md b/website/docs/services/compute/droplets_associated_resources/index.md index 76220d8..c3fdd43 100644 --- a/website/docs/services/compute/droplets_associated_resources/index.md +++ b/website/docs/services/compute/droplets_associated_resources/index.md @@ -179,7 +179,8 @@ snapshots, volume_snapshots, volumes FROM digitalocean.compute.droplets_associated_resources -WHERE droplet_id = '{{ droplet_id }}' -- required; +WHERE droplet_id = '{{ droplet_id }}' -- required +; ``` @@ -210,7 +211,8 @@ EXEC digitalocean.compute.droplets_associated_resources.droplets_destroy_with_as "snapshots": "{{ snapshots }}", "volumes": "{{ volumes }}", "volume_snapshots": "{{ volume_snapshots }}" -}'; +}' +; ``` @@ -220,7 +222,8 @@ To destroy a Droplet along with all of its associated resources, send a DELETE @@ -229,7 +232,8 @@ To check on the status of a request to destroy a Droplet with its associated
@@ -238,7 +242,8 @@ If the status of a request to destroy a Droplet with its associated resources
diff --git a/website/docs/services/compute/droplets_firewalls/index.md b/website/docs/services/compute/droplets_firewalls/index.md index 94b1c44..e885678 100644 --- a/website/docs/services/compute/droplets_firewalls/index.md +++ b/website/docs/services/compute/droplets_firewalls/index.md @@ -58,7 +58,7 @@ A JSON object that has a key called `firewalls`. string - A human-readable name for a firewall. The name must begin with an alphanumeric character. Subsequent characters must either be alphanumeric characters, a period (.), or a dash (-). (pattern: ^[a-zA-Z0-9][a-zA-Z0-9\.-]+$, example: firewall) + A human-readable name for a firewall. The name must begin with an alphanumeric character. Subsequent characters must either be alphanumeric characters, a period (.), or a dash (-). (pattern: ^[a-zA-Z0-9][a-zA-Z0-9\.-]+$, example: firewall) @@ -182,7 +182,8 @@ tags FROM digitalocean.compute.droplets_firewalls WHERE droplet_id = '{{ droplet_id }}' -- required AND per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` diff --git a/website/docs/services/compute/droplets_neighbors/index.md b/website/docs/services/compute/droplets_neighbors/index.md index b30c48c..aa5c1b1 100644 --- a/website/docs/services/compute/droplets_neighbors/index.md +++ b/website/docs/services/compute/droplets_neighbors/index.md @@ -254,7 +254,8 @@ vcpus, volume_ids, vpc_uuid FROM digitalocean.compute.droplets_neighbors -WHERE droplet_id = '{{ droplet_id }}' -- required; +WHERE droplet_id = '{{ droplet_id }}' -- required +; ``` diff --git a/website/docs/services/compute/firewall_rules/index.md b/website/docs/services/compute/firewall_rules/index.md index 1f041b3..3ecdf57 100644 --- a/website/docs/services/compute/firewall_rules/index.md +++ b/website/docs/services/compute/firewall_rules/index.md @@ -52,7 +52,7 @@ The following methods are available for this resource: - firewall_id + firewall_id, data__inbound_rules To add additional access rules to a firewall, send a POST request to
`/v2/firewalls/$FIREWALL_ID/rules`. The body of the request may include an
inbound_rules and/or outbound_rules attribute containing an array of rules to
be added.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
@@ -107,7 +107,7 @@ data__outbound_rules, firewall_id ) SELECT -'{{ inbound_rules }}', +'{{ inbound_rules }}' /* required */, '{{ outbound_rules }}', '{{ firewall_id }}' ; @@ -145,7 +145,8 @@ To remove access rules from a firewall, send a DELETE request to
`/v2/firew ```sql DELETE FROM digitalocean.compute.firewall_rules -WHERE firewall_id = '{{ firewall_id }}' --required; +WHERE firewall_id = '{{ firewall_id }}' --required +; ``` diff --git a/website/docs/services/compute/firewall_tags/index.md b/website/docs/services/compute/firewall_tags/index.md index 19b7ba5..6723d95 100644 --- a/website/docs/services/compute/firewall_tags/index.md +++ b/website/docs/services/compute/firewall_tags/index.md @@ -106,7 +106,7 @@ data__tags, firewall_id ) SELECT -'{{ tags }}' --required, +'{{ tags }}' /* required */, '{{ firewall_id }}' ; ``` @@ -144,7 +144,8 @@ To remove a tag representing a group of Droplets from a firewall, send a
DE ```sql DELETE FROM digitalocean.compute.firewall_tags -WHERE firewall_id = '{{ firewall_id }}' --required; +WHERE firewall_id = '{{ firewall_id }}' --required +; ``` diff --git a/website/docs/services/compute/firewalls/index.md b/website/docs/services/compute/firewalls/index.md index eca0470..11aae22 100644 --- a/website/docs/services/compute/firewalls/index.md +++ b/website/docs/services/compute/firewalls/index.md @@ -59,7 +59,7 @@ The response will be a JSON object with a firewall key. This will be set to an o string - A human-readable name for a firewall. The name must begin with an alphanumeric character. Subsequent characters must either be alphanumeric characters, a period (.), or a dash (-). (pattern: ^[a-zA-Z0-9][a-zA-Z0-9\.-]+$, example: firewall) + A human-readable name for a firewall. The name must begin with an alphanumeric character. Subsequent characters must either be alphanumeric characters, a period (.), or a dash (-). (pattern: ^[a-zA-Z0-9][a-zA-Z0-9\.-]+$, example: firewall) @@ -120,7 +120,7 @@ To list all of the firewalls available on your account, send a GET request to `/ string - A human-readable name for a firewall. The name must begin with an alphanumeric character. Subsequent characters must either be alphanumeric characters, a period (.), or a dash (-). (pattern: ^[a-zA-Z0-9][a-zA-Z0-9\.-]+$, example: firewall) + A human-readable name for a firewall. The name must begin with an alphanumeric character. Subsequent characters must either be alphanumeric characters, a period (.), or a dash (-). (pattern: ^[a-zA-Z0-9][a-zA-Z0-9\.-]+$, example: firewall) @@ -194,14 +194,14 @@ The following methods are available for this resource: - data__name + data__inbound_rules To create a new firewall, send a POST request to `/v2/firewalls`. The request
must contain at least one inbound or outbound access rule.
- firewall_id, data__name + firewall_id, data__inbound_rules To update the configuration of an existing firewall, send a PUT request to
`/v2/firewalls/$FIREWALL_ID`. The request should contain a full representation
of the firewall including existing attributes. **Note that any attributes that
are not provided will be reset to their default values.**


You must have read access (e.g. `droplet:read`) to all resources attached
to the firewall to successfully update the firewall.
@@ -285,7 +285,8 @@ pending_changes, status, tags FROM digitalocean.compute.firewalls -WHERE firewall_id = '{{ firewall_id }}' -- required; +WHERE firewall_id = '{{ firewall_id }}' -- required +; ``` @@ -305,7 +306,8 @@ status, tags FROM digitalocean.compute.firewalls WHERE per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` @@ -333,10 +335,10 @@ data__inbound_rules, data__outbound_rules ) SELECT -'{{ name }}' --required, +'{{ name }}', '{{ droplet_ids }}', '{{ tags }}', -'{{ inbound_rules }}', +'{{ inbound_rules }}' /* required */, '{{ outbound_rules }}' RETURNING firewall @@ -395,7 +397,7 @@ data__inbound_rules = '{{ inbound_rules }}', data__outbound_rules = '{{ outbound_rules }}' WHERE firewall_id = '{{ firewall_id }}' --required -AND data__name = '{{ name }}' --required +AND data__inbound_rules = '{{ inbound_rules }}' --required RETURNING firewall; ``` @@ -417,7 +419,8 @@ To delete a firewall send a DELETE request to `/v2/firewalls/$FIREWALL_ID`.
@@ -442,7 +445,8 @@ EXEC digitalocean.compute.firewalls.firewalls_assign_droplets @@json= '{ "droplet_ids": "{{ droplet_ids }}" -}'; +}' +; ``` @@ -455,7 +459,8 @@ EXEC digitalocean.compute.firewalls.firewalls_delete_droplets @@json= '{ "droplet_ids": "{{ droplet_ids }}" -}'; +}' +; ``` diff --git a/website/docs/services/compute/image_actions/index.md b/website/docs/services/compute/image_actions/index.md index 633c028..8f12139 100644 --- a/website/docs/services/compute/image_actions/index.md +++ b/website/docs/services/compute/image_actions/index.md @@ -194,7 +194,7 @@ The following methods are available for this resource: - image_id + image_id, type The following actions are available on an Image.

## Convert an Image to a Snapshot

To convert an image, for example, a backup to a snapshot, send a POST request
to `/v2/images/$IMAGE_ID/actions`. Set the `type` attribute to `convert`.

## Transfer an Image

To transfer an image to another region, send a POST request to
`/v2/images/$IMAGE_ID/actions`. Set the `type` attribute to `transfer` and set
`region` attribute to the slug identifier of the region you wish to transfer
to.
@@ -253,7 +253,8 @@ status, type FROM digitalocean.compute.image_actions WHERE image_id = '{{ image_id }}' -- required -AND action_id = '{{ action_id }}' -- required; +AND action_id = '{{ action_id }}' -- required +; ``` @@ -272,7 +273,8 @@ started_at, status, type FROM digitalocean.compute.image_actions -WHERE image_id = '{{ image_id }}' -- required; +WHERE image_id = '{{ image_id }}' -- required +; ``` @@ -292,7 +294,12 @@ The following actions are available on an Image.

## Convert an Image ```sql EXEC digitalocean.compute.image_actions.image_actions_post -@image_id='{{ image_id }}' --required; +@image_id='{{ image_id }}' --required +@@json= +'{ +"type": "{{ type }}" +}' +; ``` diff --git a/website/docs/services/compute/images/index.md b/website/docs/services/compute/images/index.md index 30477bd..1f333c3 100644 --- a/website/docs/services/compute/images/index.md +++ b/website/docs/services/compute/images/index.md @@ -341,7 +341,8 @@ status, tags, type FROM digitalocean.compute.images -WHERE image_id = '{{ image_id }}' -- required; +WHERE image_id = '{{ image_id }}' -- required +; ``` @@ -369,7 +370,8 @@ WHERE type = '{{ type }}' AND private = '{{ private }}' AND tag_name = '{{ tag_name }}' AND per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` @@ -398,11 +400,11 @@ data__region, data__tags ) SELECT -'{{ name }}' --required, +'{{ name }}' /* required */, '{{ distribution }}', '{{ description }}', -'{{ url }}' --required, -'{{ region }}' --required, +'{{ url }}' /* required */, +'{{ region }}' /* required */, '{{ tags }}' RETURNING image @@ -493,7 +495,8 @@ To delete a snapshot or custom image, send a `DELETE` request to `/v2/images/$IM ```sql DELETE FROM digitalocean.compute.images -WHERE image_id = '{{ image_id }}' --required; +WHERE image_id = '{{ image_id }}' --required +; ``` diff --git a/website/docs/services/compute/load_balancers/index.md b/website/docs/services/compute/load_balancers/index.md index f342765..a4eb210 100644 --- a/website/docs/services/compute/load_balancers/index.md +++ b/website/docs/services/compute/load_balancers/index.md @@ -129,7 +129,7 @@ The response will be a JSON object with a key called `load_balancer`. The
v string - An attribute containing the public-facing IP address of the load balancer. (pattern: ^$|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$, example: 104.131.186.241) + An attribute containing the public-facing IP address of the load balancer. (pattern: ^$|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$, example: 104.131.186.241) @@ -295,7 +295,7 @@ A JSON object with a key of `load_balancers`. This will be set to an array of ob string - An attribute containing the public-facing IP address of the load balancer. (pattern: ^$|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$, example: 104.131.186.241) + An attribute containing the public-facing IP address of the load balancer. (pattern: ^$|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$, example: 104.131.186.241) @@ -404,14 +404,14 @@ The following methods are available for this resource: - + data__droplet_ids, data__region To create a new load balancer instance, send a POST request to
`/v2/load_balancers`.

You can specify the Droplets that will sit behind the load balancer using one
of two methods:

* Set `droplet_ids` to a list of specific Droplet IDs.
* Set `tag` to the name of a tag. All Droplets with this tag applied will be
assigned to the load balancer. Additional Droplets will be automatically
assigned as they are tagged.

These methods are mutually exclusive.
- lb_id + lb_id, data__droplet_ids, data__region To update a load balancer's settings, send a PUT request to
`/v2/load_balancers/$LOAD_BALANCER_ID`. The request should contain a full
representation of the load balancer including existing attributes. It may
contain _one of_ the `droplets_ids` or `tag` attributes as they are mutually
exclusive. **Note that any attribute that is not provided will be reset to its
default value.**
@@ -537,7 +537,8 @@ tls_cipher_policy, type, vpc_uuid FROM digitalocean.compute.load_balancers -WHERE lb_id = '{{ lb_id }}' -- required; +WHERE lb_id = '{{ lb_id }}' -- required +; ``` @@ -578,7 +579,8 @@ type, vpc_uuid FROM digitalocean.compute.load_balancers WHERE per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` @@ -599,10 +601,56 @@ To create a new load balancer instance, send a POST request to
`/v2/load_ba ```sql INSERT INTO digitalocean.compute.load_balancers ( - +data__droplet_ids, +data__region, +data__name, +data__project_id, +data__size_unit, +data__size, +data__algorithm, +data__forwarding_rules, +data__health_check, +data__sticky_sessions, +data__redirect_http_to_https, +data__enable_proxy_protocol, +data__enable_backend_keepalive, +data__http_idle_timeout_seconds, +data__vpc_uuid, +data__disable_lets_encrypt_dns_records, +data__firewall, +data__network, +data__network_stack, +data__type, +data__domains, +data__glb_settings, +data__target_load_balancer_ids, +data__tls_cipher_policy ) SELECT - +'{{ droplet_ids }}' /* required */, +'{{ region }}' /* required */, +'{{ name }}', +'{{ project_id }}', +{{ size_unit }}, +'{{ size }}', +'{{ algorithm }}', +'{{ forwarding_rules }}', +'{{ health_check }}', +'{{ sticky_sessions }}', +{{ redirect_http_to_https }}, +{{ enable_proxy_protocol }}, +{{ enable_backend_keepalive }}, +{{ http_idle_timeout_seconds }}, +'{{ vpc_uuid }}', +{{ disable_lets_encrypt_dns_records }}, +'{{ firewall }}', +'{{ network }}', +'{{ network_stack }}', +'{{ type }}', +'{{ domains }}', +'{{ glb_settings }}', +'{{ target_load_balancer_ids }}', +'{{ tls_cipher_policy }}' RETURNING load_balancer ; @@ -614,6 +662,150 @@ load_balancer # Description fields are for documentation purposes - name: load_balancers props: + - name: droplet_ids + value: array + description: > + An array containing the IDs of the Droplets assigned to the load balancer. + + - name: region + value: string + description: > + The slug identifier for the region where the resource will initially be available. + + valid_values: ['ams1', 'ams2', 'ams3', 'blr1', 'fra1', 'lon1', 'nyc1', 'nyc2', 'nyc3', 'sfo1', 'sfo2', 'sfo3', 'sgp1', 'tor1', 'syd1'] + - name: name + value: string + description: > + A human-readable name for a load balancer instance. + + - name: project_id + value: string + description: > + The ID of the project that the load balancer is associated with. If no ID is provided at creation, the load balancer associates with the user's default project. If an invalid project ID is provided, the load balancer will not be created. + + - name: size_unit + value: integer + description: > + How many nodes the load balancer contains. Each additional node increases the load balancer's ability to manage more connections. Load balancers can be scaled up or down, and you can change the number of nodes after creation up to once per hour. This field is currently not available in the AMS2, NYC2, or SFO1 regions. Use the `size` field to scale load balancers that reside in these regions. + + default: 1 + - name: size + value: string + description: > + This field has been replaced by the `size_unit` field for all regions except in AMS2, NYC2, and SFO1. Each available load balancer size now equates to the load balancer having a set number of nodes. +* `lb-small` = 1 node +* `lb-medium` = 3 nodes +* `lb-large` = 6 nodes + +You can resize load balancers after creation up to once per hour. You cannot resize a load balancer within the first hour of its creation. + + valid_values: ['lb-small', 'lb-medium', 'lb-large'] + default: lb-small + - name: algorithm + value: string + description: > + This field has been deprecated. You can no longer specify an algorithm for load balancers. + + valid_values: ['round_robin', 'least_connections'] + default: round_robin + - name: forwarding_rules + value: array + description: > + An array of objects specifying the forwarding rules for a load balancer. + + - name: health_check + value: object + description: > + An object specifying health check settings for the load balancer. + + - name: sticky_sessions + value: object + description: > + An object specifying sticky sessions settings for the load balancer. + + - name: redirect_http_to_https + value: boolean + description: > + A boolean value indicating whether HTTP requests to the load balancer on port 80 will be redirected to HTTPS on port 443. + + default: false + - name: enable_proxy_protocol + value: boolean + description: > + A boolean value indicating whether PROXY Protocol is in use. + + default: false + - name: enable_backend_keepalive + value: boolean + description: > + A boolean value indicating whether HTTP keepalive connections are maintained to target Droplets. + + default: false + - name: http_idle_timeout_seconds + value: integer + description: > + An integer value which configures the idle timeout for HTTP requests to the target droplets. + + default: 60 + - name: vpc_uuid + value: string + description: > + A string specifying the UUID of the VPC to which the load balancer is assigned. + + - name: disable_lets_encrypt_dns_records + value: boolean + description: > + A boolean value indicating whether to disable automatic DNS record creation for Let's Encrypt certificates that are added to the load balancer. + + default: false + - name: firewall + value: object + description: > + An object specifying allow and deny rules to control traffic to the load balancer. + + - name: network + value: string + description: > + A string indicating whether the load balancer should be external or internal. Internal load balancers have no public IPs and are only accessible to resources on the same VPC network. This property cannot be updated after creating the load balancer. + + valid_values: ['EXTERNAL', 'INTERNAL'] + default: EXTERNAL + - name: network_stack + value: string + description: > + A string indicating whether the load balancer will support IPv4 or both IPv4 and IPv6 networking. This property cannot be updated after creating the load balancer. + + valid_values: ['IPV4', 'DUALSTACK'] + default: IPV4 + - name: type + value: string + description: > + A string indicating whether the load balancer should be a standard regional HTTP load balancer, a regional network load balancer that routes traffic at the TCP/UDP transport layer, or a global load balancer. + + valid_values: ['REGIONAL', 'REGIONAL_NETWORK', 'GLOBAL'] + default: REGIONAL + - name: domains + value: array + description: > + An array of objects specifying the domain configurations for a Global load balancer. + + - name: glb_settings + value: object + description: > + An object specifying forwarding configurations for a Global load balancer. + + - name: target_load_balancer_ids + value: array + description: > + An array containing the UUIDs of the Regional load balancers to be used as target backends for a Global load balancer. + + - name: tls_cipher_policy + value: string + description: > + A string indicating the policy for the TLS cipher suites used by the load balancer. The possible values are `DEFAULT` or `STRONG`. The default value is `DEFAULT`. + + valid_values: ['DEFAULT', 'STRONG'] + default: DEFAULT ``` @@ -634,9 +826,34 @@ To update a load balancer's settings, send a PUT request to
`/v2/load_balan ```sql REPLACE digitalocean.compute.load_balancers SET --- No updatable properties +data__droplet_ids = '{{ droplet_ids }}', +data__region = '{{ region }}', +data__name = '{{ name }}', +data__project_id = '{{ project_id }}', +data__size_unit = {{ size_unit }}, +data__size = '{{ size }}', +data__algorithm = '{{ algorithm }}', +data__forwarding_rules = '{{ forwarding_rules }}', +data__health_check = '{{ health_check }}', +data__sticky_sessions = '{{ sticky_sessions }}', +data__redirect_http_to_https = {{ redirect_http_to_https }}, +data__enable_proxy_protocol = {{ enable_proxy_protocol }}, +data__enable_backend_keepalive = {{ enable_backend_keepalive }}, +data__http_idle_timeout_seconds = {{ http_idle_timeout_seconds }}, +data__vpc_uuid = '{{ vpc_uuid }}', +data__disable_lets_encrypt_dns_records = {{ disable_lets_encrypt_dns_records }}, +data__firewall = '{{ firewall }}', +data__network = '{{ network }}', +data__network_stack = '{{ network_stack }}', +data__type = '{{ type }}', +data__domains = '{{ domains }}', +data__glb_settings = '{{ glb_settings }}', +data__target_load_balancer_ids = '{{ target_load_balancer_ids }}', +data__tls_cipher_policy = '{{ tls_cipher_policy }}' WHERE lb_id = '{{ lb_id }}' --required +AND data__droplet_ids = '{{ droplet_ids }}' --required +AND data__region = '{{ region }}' --required RETURNING load_balancer; ``` @@ -658,7 +875,8 @@ To delete a load balancer instance, disassociating any Droplets assigned to it @@ -682,7 +900,8 @@ To delete a Global load balancer CDN cache, send a DELETE request to
`/v2/l ```sql EXEC digitalocean.compute.load_balancers.load_balancers_delete_cache -@lb_id='{{ lb_id }}' --required; +@lb_id='{{ lb_id }}' --required +; ``` @@ -695,7 +914,8 @@ EXEC digitalocean.compute.load_balancers.load_balancers_add_droplets @@json= '{ "droplet_ids": "{{ droplet_ids }}" -}'; +}' +; ``` @@ -708,7 +928,8 @@ EXEC digitalocean.compute.load_balancers.load_balancers_remove_droplets @@json= '{ "droplet_ids": "{{ droplet_ids }}" -}'; +}' +; ``` @@ -721,7 +942,8 @@ EXEC digitalocean.compute.load_balancers.load_balancers_add_forwarding_rules @@json= '{ "forwarding_rules": "{{ forwarding_rules }}" -}'; +}' +; ``` @@ -734,7 +956,8 @@ EXEC digitalocean.compute.load_balancers.load_balancers_remove_forwarding_rules @@json= '{ "forwarding_rules": "{{ forwarding_rules }}" -}'; +}' +; ``` diff --git a/website/docs/services/compute/regions/index.md b/website/docs/services/compute/regions/index.md index 5315ae0..ad5afe0 100644 --- a/website/docs/services/compute/regions/index.md +++ b/website/docs/services/compute/regions/index.md @@ -152,7 +152,8 @@ sizes, slug FROM digitalocean.compute.regions WHERE per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` diff --git a/website/docs/services/compute/reserved_ip_actions/index.md b/website/docs/services/compute/reserved_ip_actions/index.md index da893de..ebba748 100644 --- a/website/docs/services/compute/reserved_ip_actions/index.md +++ b/website/docs/services/compute/reserved_ip_actions/index.md @@ -154,7 +154,7 @@ The following methods are available for this resource: - reserved_ip + reserved_ip, type To initiate an action on a reserved IP send a POST request to
`/v2/reserved_ips/$RESERVED_IP/actions`. In the JSON body to the request,
set the `type` attribute to on of the supported action types:

| Action | Details
|------------|--------
| `assign` | Assigns a reserved IP to a Droplet
| `unassign` | Unassign a reserved IP from a Droplet
@@ -205,7 +205,8 @@ SELECT action FROM digitalocean.compute.reserved_ip_actions WHERE reserved_ip = '{{ reserved_ip }}' -- required -AND action_id = '{{ action_id }}' -- required; +AND action_id = '{{ action_id }}' -- required +; ``` @@ -224,7 +225,8 @@ started_at, status, type FROM digitalocean.compute.reserved_ip_actions -WHERE reserved_ip = '{{ reserved_ip }}' -- required; +WHERE reserved_ip = '{{ reserved_ip }}' -- required +; ``` @@ -244,7 +246,12 @@ To initiate an action on a reserved IP send a POST request to
`/v2/reserved ```sql EXEC digitalocean.compute.reserved_ip_actions.reserved_ips_actions_post -@reserved_ip='{{ reserved_ip }}' --required; +@reserved_ip='{{ reserved_ip }}' --required +@@json= +'{ +"type": "{{ type }}" +}' +; ``` diff --git a/website/docs/services/compute/reserved_ips/index.md b/website/docs/services/compute/reserved_ips/index.md index e83700f..d332ab8 100644 --- a/website/docs/services/compute/reserved_ips/index.md +++ b/website/docs/services/compute/reserved_ips/index.md @@ -154,7 +154,7 @@ The following methods are available for this resource: - + data__droplet_id On creation, a reserved IP must be either assigned to a Droplet or reserved to a region.
* To create a new reserved IP assigned to a Droplet, send a POST
request to `/v2/reserved_ips` with the `droplet_id` attribute.

* To create a new reserved IP reserved to a region, send a POST request to
`/v2/reserved_ips` with the `region` attribute.

**Note**: In addition to the standard rate limiting, only 12 reserved IPs may be created per 60 seconds. @@ -220,7 +220,8 @@ ip, locked, region FROM digitalocean.compute.reserved_ips -WHERE reserved_ip = '{{ reserved_ip }}' -- required; +WHERE reserved_ip = '{{ reserved_ip }}' -- required +; ``` @@ -236,7 +237,8 @@ locked, region FROM digitalocean.compute.reserved_ips WHERE per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` @@ -257,10 +259,10 @@ On creation, a reserved IP must be either assigned to a Droplet or reserved to a ```sql INSERT INTO digitalocean.compute.reserved_ips ( - +data__droplet_id ) SELECT - +{{ droplet_id }} /* required */ RETURNING links, reserved_ip @@ -273,6 +275,11 @@ reserved_ip # Description fields are for documentation purposes - name: reserved_ips props: + - name: droplet_id + value: integer + description: > + The ID of the Droplet that the reserved IP will be assigned to. + ``` @@ -292,7 +299,8 @@ To delete a reserved IP and remove it from your account, send a DELETE request diff --git a/website/docs/services/compute/reserved_ipv6/index.md b/website/docs/services/compute/reserved_ipv6/index.md index 34c5107..e13a2a6 100644 --- a/website/docs/services/compute/reserved_ipv6/index.md +++ b/website/docs/services/compute/reserved_ipv6/index.md @@ -153,7 +153,7 @@ The following methods are available for this resource: - reserved_ipv6 + reserved_ipv6, type To initiate an action on a reserved IPv6 send a POST request to
`/v2/reserved_ipv6/$RESERVED_IPV6/actions`. In the JSON body to the request,
set the `type` attribute to on of the supported action types:

| Action | Details
|------------|--------
| `assign` | Assigns a reserved IPv6 to a Droplet
| `unassign` | Unassign a reserved IPv6 from a Droplet
@@ -211,7 +211,8 @@ ip, region_slug, reserved_at FROM digitalocean.compute.reserved_ipv6 -WHERE reserved_ipv6 = '{{ reserved_ipv6 }}' -- required; +WHERE reserved_ipv6 = '{{ reserved_ipv6 }}' -- required +; ``` @@ -225,7 +226,8 @@ meta, reserved_ipv6s FROM digitalocean.compute.reserved_ipv6 WHERE per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` @@ -249,7 +251,7 @@ INSERT INTO digitalocean.compute.reserved_ipv6 ( data__region_slug ) SELECT -'{{ region_slug }}' --required +'{{ region_slug }}' /* required */ RETURNING reserved_ipv6 ; @@ -285,7 +287,8 @@ To delete a reserved IP and remove it from your account, send a DELETE request @@ -305,7 +308,12 @@ To initiate an action on a reserved IPv6 send a POST request to
`/v2/reserv ```sql EXEC digitalocean.compute.reserved_ipv6.reserved_ipv6_actions_post -@reserved_ipv6='{{ reserved_ipv6 }}' --required; +@reserved_ipv6='{{ reserved_ipv6 }}' --required +@@json= +'{ +"type": "{{ type }}" +}' +; ``` diff --git a/website/docs/services/compute/sizes/index.md b/website/docs/services/compute/sizes/index.md index a23ab00..c044e1d 100644 --- a/website/docs/services/compute/sizes/index.md +++ b/website/docs/services/compute/sizes/index.md @@ -194,7 +194,8 @@ transfer, vcpus FROM digitalocean.compute.sizes WHERE per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` diff --git a/website/docs/services/compute/snapshots/index.md b/website/docs/services/compute/snapshots/index.md index f057da7..d0a5dac 100644 --- a/website/docs/services/compute/snapshots/index.md +++ b/website/docs/services/compute/snapshots/index.md @@ -262,7 +262,8 @@ resource_type, size_gigabytes, tags FROM digitalocean.compute.snapshots -WHERE snapshot_id = '{{ snapshot_id }}' -- required; +WHERE snapshot_id = '{{ snapshot_id }}' -- required +; ``` @@ -283,7 +284,8 @@ tags FROM digitalocean.compute.snapshots WHERE per_page = '{{ per_page }}' AND page = '{{ page }}' -AND resource_type = '{{ resource_type }}'; +AND resource_type = '{{ resource_type }}' +; ``` @@ -303,7 +305,8 @@ Both Droplet and volume snapshots are managed through the `/v2/snapshots/`
```sql DELETE FROM digitalocean.compute.snapshots -WHERE snapshot_id = '{{ snapshot_id }}' --required; +WHERE snapshot_id = '{{ snapshot_id }}' --required +; ``` diff --git a/website/docs/services/compute/ssh_keys/index.md b/website/docs/services/compute/ssh_keys/index.md index d3550fb..103c91c 100644 --- a/website/docs/services/compute/ssh_keys/index.md +++ b/website/docs/services/compute/ssh_keys/index.md @@ -216,7 +216,8 @@ name, fingerprint, public_key FROM digitalocean.compute.ssh_keys -WHERE ssh_key_identifier = '{{ ssh_key_identifier }}' -- required; +WHERE ssh_key_identifier = '{{ ssh_key_identifier }}' -- required +; ``` @@ -231,7 +232,8 @@ fingerprint, public_key FROM digitalocean.compute.ssh_keys WHERE per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` @@ -256,8 +258,8 @@ data__public_key, data__name ) SELECT -'{{ public_key }}' --required, -'{{ name }}' --required +'{{ public_key }}' /* required */, +'{{ name }}' /* required */ RETURNING ssh_key ; @@ -323,7 +325,8 @@ To destroy a public SSH key that you have in your account, send a DELETE request ```sql DELETE FROM digitalocean.compute.ssh_keys -WHERE ssh_key_identifier = '{{ ssh_key_identifier }}' --required; +WHERE ssh_key_identifier = '{{ ssh_key_identifier }}' --required +; ``` diff --git a/website/docs/services/compute/tags/index.md b/website/docs/services/compute/tags/index.md index 20bb90e..e5e78cf 100644 --- a/website/docs/services/compute/tags/index.md +++ b/website/docs/services/compute/tags/index.md @@ -54,7 +54,7 @@ The response will be a JSON object with a key called `tag`.
The value of t string - The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag. **Note:** Tag names are case stable, which means the capitalization you use when you first create a tag is canonical. When working with tags in the API, you must use the tag's canonical capitalization. For example, if you create a tag named "PROD", the URL to add that tag to a resource would be `https://api.digitalocean.com/v2/tags/PROD/resources` (not `/v2/tags/prod/resources`). Tagged resources in the control panel will always display the canonical capitalization. For example, if you create a tag named "PROD", you can tag resources in the control panel by entering "prod". The tag will still display with its canonical capitalization, "PROD". (pattern: ^[a-zA-Z0-9_\-\:]+$, example: extra-awesome) + The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag. **Note:** Tag names are case stable, which means the capitalization you use when you first create a tag is canonical. When working with tags in the API, you must use the tag's canonical capitalization. For example, if you create a tag named "PROD", the URL to add that tag to a resource would be `https://api.digitalocean.com/v2/tags/PROD/resources` (not `/v2/tags/prod/resources`). Tagged resources in the control panel will always display the canonical capitalization. For example, if you create a tag named "PROD", you can tag resources in the control panel by entering "prod". The tag will still display with its canonical capitalization, "PROD". (pattern: ^[a-zA-Z0-9_\-\:]+$, example: extra-awesome) @@ -80,7 +80,7 @@ To list all of your tags, you can send a `GET` request to `/v2/tags`. string - The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag. **Note:** Tag names are case stable, which means the capitalization you use when you first create a tag is canonical. When working with tags in the API, you must use the tag's canonical capitalization. For example, if you create a tag named "PROD", the URL to add that tag to a resource would be `https://api.digitalocean.com/v2/tags/PROD/resources` (not `/v2/tags/prod/resources`). Tagged resources in the control panel will always display the canonical capitalization. For example, if you create a tag named "PROD", you can tag resources in the control panel by entering "prod". The tag will still display with its canonical capitalization, "PROD". (pattern: ^[a-zA-Z0-9_\-\:]+$, example: extra-awesome) + The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag. **Note:** Tag names are case stable, which means the capitalization you use when you first create a tag is canonical. When working with tags in the API, you must use the tag's canonical capitalization. For example, if you create a tag named "PROD", the URL to add that tag to a resource would be `https://api.digitalocean.com/v2/tags/PROD/resources` (not `/v2/tags/prod/resources`). Tagged resources in the control panel will always display the canonical capitalization. For example, if you create a tag named "PROD", you can tag resources in the control panel by entering "prod". The tag will still display with its canonical capitalization, "PROD". (pattern: ^[a-zA-Z0-9_\-\:]+$, example: extra-awesome) @@ -201,7 +201,8 @@ SELECT name, resources FROM digitalocean.compute.tags -WHERE tag_id = '{{ tag_id }}' -- required; +WHERE tag_id = '{{ tag_id }}' -- required +; ``` @@ -214,7 +215,8 @@ name, resources FROM digitalocean.compute.tags WHERE per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` @@ -281,7 +283,8 @@ A tag can be deleted by sending a `DELETE` request to `/v2/tags/$TAG_NAME`. Dele ```sql DELETE FROM digitalocean.compute.tags -WHERE tag_id = '{{ tag_id }}' --required; +WHERE tag_id = '{{ tag_id }}' --required +; ``` @@ -306,7 +309,8 @@ EXEC digitalocean.compute.tags.tags_assign_resources @@json= '{ "resources": "{{ resources }}" -}'; +}' +; ``` @@ -319,7 +323,8 @@ EXEC digitalocean.compute.tags.tags_unassign_resources @@json= '{ "resources": "{{ resources }}" -}'; +}' +; ``` diff --git a/website/docs/services/compute/volume_actions/index.md b/website/docs/services/compute/volume_actions/index.md index 2e80721..7d31fdc 100644 --- a/website/docs/services/compute/volume_actions/index.md +++ b/website/docs/services/compute/volume_actions/index.md @@ -194,7 +194,7 @@ The following methods are available for this resource: - volume_id + volume_id, type per_page, page To initiate an action on a block storage volume by Id, send a POST request to
`~/v2/volumes/$VOLUME_ID/actions`. The body should contain the appropriate
attributes for the respective action.

## Attach a Block Storage Volume to a Droplet

| Attribute | Details |
| ---------- | ------------------------------------------------------------------- |
| type | This must be `attach` |
| droplet_id | Set to the Droplet's ID |
| region | Set to the slug representing the region where the volume is located |

Each volume may only be attached to a single Droplet. However, up to fifteen
volumes may be attached to a Droplet at a time. Pre-formatted volumes will be
automatically mounted to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS
Droplets created on or after April 26, 2018 when attached. On older Droplets,
[additional configuration](https://docs.digitalocean.com/products/volumes/how-to/mount/)
is required.

## Remove a Block Storage Volume from a Droplet

| Attribute | Details |
| ---------- | ------------------------------------------------------------------- |
| type | This must be `detach` |
| droplet_id | Set to the Droplet's ID |
| region | Set to the slug representing the region where the volume is located |

## Resize a Volume

| Attribute | Details |
| -------------- | ------------------------------------------------------------------- |
| type | This must be `resize` |
| size_gigabytes | The new size of the block storage volume in GiB (1024^3) |
| region | Set to the slug representing the region where the volume is located |

Volumes may only be resized upwards. The maximum size for a volume is 16TiB.
@@ -265,7 +265,8 @@ FROM digitalocean.compute.volume_actions WHERE volume_id = '{{ volume_id }}' -- required AND action_id = '{{ action_id }}' -- required AND per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` @@ -286,7 +287,8 @@ type FROM digitalocean.compute.volume_actions WHERE volume_id = '{{ volume_id }}' -- required AND per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` @@ -308,7 +310,15 @@ To initiate an action on a block storage volume by Id, send a POST request to
diff --git a/website/docs/services/compute/volume_snapshots/index.md b/website/docs/services/compute/volume_snapshots/index.md index 330cf4c..8f2cb3a 100644 --- a/website/docs/services/compute/volume_snapshots/index.md +++ b/website/docs/services/compute/volume_snapshots/index.md @@ -269,7 +269,8 @@ resource_type, size_gigabytes, tags FROM digitalocean.compute.volume_snapshots -WHERE snapshot_id = '{{ snapshot_id }}' -- required; +WHERE snapshot_id = '{{ snapshot_id }}' -- required +; ``` @@ -290,7 +291,8 @@ tags FROM digitalocean.compute.volume_snapshots WHERE volume_id = '{{ volume_id }}' -- required AND per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` @@ -316,7 +318,7 @@ data__tags, volume_id ) SELECT -'{{ name }}' --required, +'{{ name }}' /* required */, '{{ tags }}', '{{ volume_id }}' RETURNING @@ -362,7 +364,8 @@ To delete a volume snapshot, send a DELETE request to
`/v2/volumes/snapshot ```sql DELETE FROM digitalocean.compute.volume_snapshots -WHERE snapshot_id = '{{ snapshot_id }}' --required; +WHERE snapshot_id = '{{ snapshot_id }}' --required +; ``` diff --git a/website/docs/services/compute/volumes/index.md b/website/docs/services/compute/volumes/index.md index 69f6f4d..c1f1b2d 100644 --- a/website/docs/services/compute/volumes/index.md +++ b/website/docs/services/compute/volumes/index.md @@ -204,7 +204,7 @@ The following methods are available for this resource: - + data__name, data__size_gigabytes, data__region To create a new volume, send a POST request to `/v2/volumes`. Optionally, a `filesystem_type` attribute may be provided in order to automatically format the volume's filesystem. Pre-formatted volumes are automatically mounted when attached to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS Droplets created on or after April 26, 2018. Attaching pre-formatted volumes to Droplets without support for auto-mounting is not recommended. @@ -225,7 +225,7 @@ The following methods are available for this resource: - + type per_page, page To initiate an action on a block storage volume by Name, send a POST request to
`~/v2/volumes/actions`. The body should contain the appropriate
attributes for the respective action.

## Attach a Block Storage Volume to a Droplet

| Attribute | Details |
| ----------- | ------------------------------------------------------------------- |
| type | This must be `attach` |
| volume_name | The name of the block storage volume |
| droplet_id | Set to the Droplet's ID |
| region | Set to the slug representing the region where the volume is located |

Each volume may only be attached to a single Droplet. However, up to fifteen
volumes may be attached to a Droplet at a time. Pre-formatted volumes will be
automatically mounted to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS
Droplets created on or after April 26, 2018 when attached. On older Droplets,
[additional configuration](https://docs.digitalocean.com/products/volumes/how-to/mount/)
is required.

## Remove a Block Storage Volume from a Droplet

| Attribute | Details |
| ----------- | ------------------------------------------------------------------- |
| type | This must be `detach` |
| volume_name | The name of the block storage volume |
| droplet_id | Set to the Droplet's ID |
| region | Set to the slug representing the region where the volume is located |
@@ -299,7 +299,8 @@ region, size_gigabytes, tags FROM digitalocean.compute.volumes -WHERE volume_id = '{{ volume_id }}' -- required; +WHERE volume_id = '{{ volume_id }}' -- required +; ``` @@ -322,7 +323,8 @@ FROM digitalocean.compute.volumes WHERE name = '{{ name }}' AND region = '{{ region }}' AND per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` @@ -343,10 +345,24 @@ To create a new volume, send a POST request to `/v2/volumes`. Optionally, a `fil ```sql INSERT INTO digitalocean.compute.volumes ( - +data__name, +data__description, +data__size_gigabytes, +data__tags, +data__snapshot_id, +data__filesystem_type, +data__region, +data__filesystem_label ) SELECT - +'{{ name }}' /* required */, +'{{ description }}', +{{ size_gigabytes }} /* required */, +'{{ tags }}', +'{{ snapshot_id }}', +'{{ filesystem_type }}', +'{{ region }}' /* required */, +'{{ filesystem_label }}' RETURNING volume ; @@ -358,6 +374,47 @@ volume # Description fields are for documentation purposes - name: volumes props: + - name: name + value: string + description: > + A human-readable name for the block storage volume. Must be lowercase and be composed only of numbers, letters and "-", up to a limit of 64 characters. The name must begin with a letter. + + - name: description + value: string + description: > + An optional free-form text field to describe a block storage volume. + + - name: size_gigabytes + value: integer + description: > + The size of the block storage volume in GiB (1024^3). This field does not apply when creating a volume from a snapshot. + + - name: tags + value: array + description: > + A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags.

Requires `tag:create` scope. + + - name: snapshot_id + value: string + description: > + The unique identifier for the volume snapshot from which to create the volume. + + - name: filesystem_type + value: string + description: > + The name of the filesystem type to be used on the volume. When provided, the volume will automatically be formatted to the specified filesystem type. Currently, the available options are `ext4` and `xfs`. Pre-formatted volumes are automatically mounted when attached to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS Droplets created on or after April 26, 2018. Attaching pre-formatted volumes to other Droplets is not recommended. + + - name: region + value: string + description: > + The slug identifier for the region where the resource will initially be available. + + valid_values: ['ams1', 'ams2', 'ams3', 'blr1', 'fra1', 'lon1', 'nyc1', 'nyc2', 'nyc3', 'sfo1', 'sfo2', 'sfo3', 'sgp1', 'tor1', 'syd1'] + - name: filesystem_label + value: string + description: > + The label applied to the filesystem. Labels for ext4 type filesystems may contain 16 characters while labels for xfs type filesystems are limited to 12 characters. May only be used in conjunction with filesystem_type. + ``` @@ -378,7 +435,8 @@ To delete a block storage volume, destroying all data and removing it from your ```sql DELETE FROM digitalocean.compute.volumes -WHERE volume_id = '{{ volume_id }}' --required; +WHERE volume_id = '{{ volume_id }}' --required +; ``` @@ -388,7 +446,8 @@ Block storage volumes may also be deleted by name by sending a DELETE request wi ```sql DELETE FROM digitalocean.compute.volumes WHERE name = '{{ name }}' -AND region = '{{ region }}'; +AND region = '{{ region }}' +; ``` @@ -409,7 +468,15 @@ To initiate an action on a block storage volume by Name, send a POST request to< ```sql EXEC digitalocean.compute.volumes.volume_actions_post @per_page='{{ per_page }}', -@page='{{ page }}'; +@page='{{ page }}' +@@json= +'{ +"type": "{{ type }}", +"region": "{{ region }}", +"droplet_id": {{ droplet_id }}, +"tags": "{{ tags }}" +}' +; ``` diff --git a/website/docs/services/compute/vpc_nat_gateways/index.md b/website/docs/services/compute/vpc_nat_gateways/index.md index c6607f8..35fcf6d 100644 --- a/website/docs/services/compute/vpc_nat_gateways/index.md +++ b/website/docs/services/compute/vpc_nat_gateways/index.md @@ -335,7 +335,8 @@ udp_timeout_seconds, updated_at, vpcs FROM digitalocean.compute.vpc_nat_gateways -WHERE id = '{{ id }}' -- required; +WHERE id = '{{ id }}' -- required +; ``` @@ -363,7 +364,8 @@ AND page = '{{ page }}' AND state = '{{ state }}' AND region = '{{ region }}' AND type = '{{ type }}' -AND name = '{{ name }}'; +AND name = '{{ name }}' +; ``` @@ -394,11 +396,11 @@ data__icmp_timeout_seconds, data__tcp_timeout_seconds ) SELECT -'{{ name }}' --required, -'{{ type }}' --required, -'{{ region }}' --required, -{{ size }} --required, -'{{ vpcs }}' --required, +'{{ name }}' /* required */, +'{{ type }}' /* required */, +'{{ region }}' /* required */, +{{ size }} /* required */, +'{{ vpcs }}' /* required */, {{ udp_timeout_seconds }}, {{ icmp_timeout_seconds }}, {{ tcp_timeout_seconds }} @@ -505,7 +507,8 @@ To destroy a VPC NAT Gateway, send a DELETE request to the `/v2/vpc_nat_gateways ```sql DELETE FROM digitalocean.compute.vpc_nat_gateways -WHERE id = '{{ id }}' --required; +WHERE id = '{{ id }}' --required +; ``` diff --git a/website/docs/services/container_registry/active_garbage_collection/index.md b/website/docs/services/container_registry/active_garbage_collection/index.md index 3e0ff2b..72cb522 100644 --- a/website/docs/services/container_registry/active_garbage_collection/index.md +++ b/website/docs/services/container_registry/active_garbage_collection/index.md @@ -158,7 +158,8 @@ status, updated_at, uuid FROM digitalocean.container_registry.active_garbage_collection -WHERE registry_name = '{{ registry_name }}' -- required; +WHERE registry_name = '{{ registry_name }}' -- required +; ``` diff --git a/website/docs/services/container_registry/docker_credentials/index.md b/website/docs/services/container_registry/docker_credentials/index.md index abc1b9f..158668b 100644 --- a/website/docs/services/container_registry/docker_credentials/index.md +++ b/website/docs/services/container_registry/docker_credentials/index.md @@ -139,7 +139,8 @@ In order to access your container registry with the Docker client or from a
@@ -160,7 +161,8 @@ In order to access your container registry with the Docker client or from a
diff --git a/website/docs/services/container_registry/garbage_collections/index.md b/website/docs/services/container_registry/garbage_collections/index.md index 0914d20..81213fc 100644 --- a/website/docs/services/container_registry/garbage_collections/index.md +++ b/website/docs/services/container_registry/garbage_collections/index.md @@ -217,7 +217,8 @@ uuid FROM digitalocean.container_registry.garbage_collections WHERE registry_name = '{{ registry_name }}' -- required AND per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` @@ -267,7 +268,8 @@ Garbage collection enables users to clear out unreferenced blobs (layer &
m ```sql EXEC digitalocean.container_registry.garbage_collections.registries_run_garbage_collection -@registry_name='{{ registry_name }}' --required; +@registry_name='{{ registry_name }}' --required +; ``` @@ -280,7 +282,8 @@ EXEC digitalocean.container_registry.garbage_collections.registry_run_garbage_co @@json= '{ "type": "{{ type }}" -}'; +}' +; ``` @@ -289,7 +292,8 @@ To get information about the currently-active garbage collection for a registry, ```sql EXEC digitalocean.container_registry.garbage_collections.registry_get_garbage_collection_legacy -@registry_name='{{ registry_name }}' --required; +@registry_name='{{ registry_name }}' --required +; ``` @@ -300,7 +304,8 @@ To get information about past garbage collections for a registry, send a GET req EXEC digitalocean.container_registry.garbage_collections.registry_list_garbage_collections_legacy @registry_name='{{ registry_name }}' --required, @per_page='{{ per_page }}', -@page='{{ page }}'; +@page='{{ page }}' +; ``` @@ -314,7 +319,8 @@ EXEC digitalocean.container_registry.garbage_collections.registry_update_garbage @@json= '{ "cancel": {{ cancel }} -}'; +}' +; ``` diff --git a/website/docs/services/container_registry/options/index.md b/website/docs/services/container_registry/options/index.md index d7089c6..4fd2683 100644 --- a/website/docs/services/container_registry/options/index.md +++ b/website/docs/services/container_registry/options/index.md @@ -129,7 +129,8 @@ This endpoint serves to provide additional information as to which option values SELECT available_regions, subscription_tiers -FROM digitalocean.container_registry.options; +FROM digitalocean.container_registry.options +; ``` @@ -149,6 +150,7 @@ This endpoint serves to provide additional information as to which option values ```sql EXEC digitalocean.container_registry.options.registry_get_options_legacy + ; ``` diff --git a/website/docs/services/container_registry/registries/index.md b/website/docs/services/container_registry/registries/index.md index 6d511c8..4f49500 100644 --- a/website/docs/services/container_registry/registries/index.md +++ b/website/docs/services/container_registry/registries/index.md @@ -54,7 +54,7 @@ The response will be a JSON object with the key `registry` containing informatio string - A globally unique name for the container registry. Must be lowercase and be composed only of numbers, letters and `-`, up to a limit of 63 characters. (pattern: ^[a-z0-9-]{1,63}$, example: example) + A globally unique name for the container registry. Must be lowercase and be composed only of numbers, letters and `-`, up to a limit of 63 characters. (pattern: ^[a-z0-9-]{1,63}$, example: example) @@ -220,7 +220,8 @@ region, storage_usage_bytes, storage_usage_bytes_updated_at FROM digitalocean.container_registry.registries -WHERE registry_name = '{{ registry_name }}' -- required; +WHERE registry_name = '{{ registry_name }}' -- required +; ``` @@ -230,7 +231,8 @@ To get information about any container registry in your account, send a GET requ ```sql SELECT * -FROM digitalocean.container_registry.registries; +FROM digitalocean.container_registry.registries +; ``` @@ -256,7 +258,7 @@ data__subscription_tier_slug, data__region ) SELECT -'{{ name }}' --required, +'{{ name }}' /* required */, '{{ subscription_tier_slug }}', '{{ region }}' RETURNING @@ -306,7 +308,8 @@ To delete your container registry, destroying all container image data stored in ```sql DELETE FROM digitalocean.container_registry.registries -WHERE registry_name = '{{ registry_name }}' --required; +WHERE registry_name = '{{ registry_name }}' --required +; ``` @@ -333,7 +336,8 @@ EXEC digitalocean.container_registry.registries.registries_validate_name @@json= '{ "name": "{{ name }}" -}'; +}' +; ``` @@ -342,6 +346,7 @@ To get information about your container registry, send a GET request to `/v2/reg ```sql EXEC digitalocean.container_registry.registries.registry_get_legacy + ; ``` @@ -356,7 +361,8 @@ EXEC digitalocean.container_registry.registries.registry_create_legacy "name": "{{ name }}", "subscription_tier_slug": "{{ subscription_tier_slug }}", "region": "{{ region }}" -}'; +}' +; ``` @@ -365,6 +371,7 @@ To delete your container registry, destroying all container image data stored in ```sql EXEC digitalocean.container_registry.registries.registry_delete_legacy + ; ``` @@ -377,7 +384,8 @@ EXEC digitalocean.container_registry.registries.registry_validate_name_legacy @@json= '{ "name": "{{ name }}" -}'; +}' +; ``` diff --git a/website/docs/services/container_registry/repositories/index.md b/website/docs/services/container_registry/repositories/index.md index 60a6c1f..fba28e6 100644 --- a/website/docs/services/container_registry/repositories/index.md +++ b/website/docs/services/container_registry/repositories/index.md @@ -190,7 +190,8 @@ FROM digitalocean.container_registry.repositories WHERE registry_name = '{{ registry_name }}' -- required AND per_page = '{{ per_page }}' AND page = '{{ page }}' -AND page_token = '{{ page_token }}'; +AND page_token = '{{ page_token }}' +; ``` @@ -211,7 +212,8 @@ To delete a container repository including all of its tags, send a DELETE reques ```sql DELETE FROM digitalocean.container_registry.repositories WHERE registry_name = '{{ registry_name }}' --required -AND repository_name = '{{ repository_name }}' --required; +AND repository_name = '{{ repository_name }}' --required +; ``` @@ -234,7 +236,8 @@ This endpoint has been deprecated in favor of the _List All Container Registry R EXEC digitalocean.container_registry.repositories.registry_list_repositories_legacy @registry_name='{{ registry_name }}' --required, @per_page='{{ per_page }}', -@page='{{ page }}'; +@page='{{ page }}' +; ``` @@ -246,7 +249,8 @@ EXEC digitalocean.container_registry.repositories.registry_list_repositories_v2_ @registry_name='{{ registry_name }}' --required, @per_page='{{ per_page }}', @page='{{ page }}', -@page_token='{{ page_token }}'; +@page_token='{{ page_token }}' +; ``` diff --git a/website/docs/services/container_registry/repository_manifests/index.md b/website/docs/services/container_registry/repository_manifests/index.md index 8accc4a..d0ee5ac 100644 --- a/website/docs/services/container_registry/repository_manifests/index.md +++ b/website/docs/services/container_registry/repository_manifests/index.md @@ -208,7 +208,8 @@ FROM digitalocean.container_registry.repository_manifests WHERE registry_name = '{{ registry_name }}' -- required AND repository_name = '{{ repository_name }}' -- required AND per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` @@ -230,7 +231,8 @@ To delete a container repository manifest by digest in one of your registries, s DELETE FROM digitalocean.container_registry.repository_manifests WHERE registry_name = '{{ registry_name }}' --required AND repository_name = '{{ repository_name }}' --required -AND manifest_digest = '{{ manifest_digest }}' --required; +AND manifest_digest = '{{ manifest_digest }}' --required +; ``` @@ -254,7 +256,8 @@ EXEC digitalocean.container_registry.repository_manifests.registry_list_reposito @registry_name='{{ registry_name }}' --required, @repository_name='{{ repository_name }}' --required, @per_page='{{ per_page }}', -@page='{{ page }}'; +@page='{{ page }}' +; ``` @@ -265,7 +268,8 @@ To delete a container repository manifest by digest, send a DELETE request to
diff --git a/website/docs/services/container_registry/repository_tags/index.md b/website/docs/services/container_registry/repository_tags/index.md index 4c03058..3d554fb 100644 --- a/website/docs/services/container_registry/repository_tags/index.md +++ b/website/docs/services/container_registry/repository_tags/index.md @@ -202,7 +202,8 @@ FROM digitalocean.container_registry.repository_tags WHERE registry_name = '{{ registry_name }}' -- required AND repository_name = '{{ repository_name }}' -- required AND per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` @@ -224,7 +225,8 @@ To delete a container repository tag in on of our container registries, send a D DELETE FROM digitalocean.container_registry.repository_tags WHERE registry_name = '{{ registry_name }}' --required AND repository_name = '{{ repository_name }}' --required -AND repository_tag = '{{ repository_tag }}' --required; +AND repository_tag = '{{ repository_tag }}' --required +; ``` @@ -248,7 +250,8 @@ EXEC digitalocean.container_registry.repository_tags.registry_list_repository_ta @registry_name='{{ registry_name }}' --required, @repository_name='{{ repository_name }}' --required, @per_page='{{ per_page }}', -@page='{{ page }}'; +@page='{{ page }}' +; ``` @@ -259,7 +262,8 @@ To delete a container repository tag, send a DELETE request to
`/v2/registr EXEC digitalocean.container_registry.repository_tags.registry_delete_repository_tag_legacy @registry_name='{{ registry_name }}' --required, @repository_name='{{ repository_name }}' --required, -@repository_tag='{{ repository_tag }}' --required; +@repository_tag='{{ repository_tag }}' --required +; ``` diff --git a/website/docs/services/container_registry/subscriptions/index.md b/website/docs/services/container_registry/subscriptions/index.md index ad87e17..f97491e 100644 --- a/website/docs/services/container_registry/subscriptions/index.md +++ b/website/docs/services/container_registry/subscriptions/index.md @@ -149,7 +149,8 @@ SELECT created_at, tier, updated_at -FROM digitalocean.container_registry.subscriptions; +FROM digitalocean.container_registry.subscriptions +; ``` @@ -211,6 +212,7 @@ A subscription is automatically created when you configure your container regist ```sql EXEC digitalocean.container_registry.subscriptions.registry_get_subscription_legacy + ; ``` @@ -223,7 +225,8 @@ EXEC digitalocean.container_registry.subscriptions.registry_update_subscription_ @@json= '{ "tier_slug": "{{ tier_slug }}" -}'; +}' +; ``` diff --git a/website/docs/services/databases/autoscale_config/index.md b/website/docs/services/databases/autoscale_config/index.md index 01fb264..fa4eb85 100644 --- a/website/docs/services/databases/autoscale_config/index.md +++ b/website/docs/services/databases/autoscale_config/index.md @@ -129,7 +129,8 @@ To retrieve the autoscale configuration for an existing database cluster, send a SELECT storage FROM digitalocean.databases.autoscale_config -WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required; +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required +; ``` diff --git a/website/docs/services/databases/backups/index.md b/website/docs/services/databases/backups/index.md index 194cea5..f881d00 100644 --- a/website/docs/services/databases/backups/index.md +++ b/website/docs/services/databases/backups/index.md @@ -128,7 +128,8 @@ SELECT created_at, size_gigabytes FROM digitalocean.databases.backups -WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required; +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required +; ``` diff --git a/website/docs/services/databases/ca/index.md b/website/docs/services/databases/ca/index.md index fa1cd4a..2d05819 100644 --- a/website/docs/services/databases/ca/index.md +++ b/website/docs/services/databases/ca/index.md @@ -122,7 +122,8 @@ To retrieve the public certificate used to secure the connection to the database SELECT certificate FROM digitalocean.databases.ca -WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required; +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required +; ``` diff --git a/website/docs/services/databases/cluster_config/index.md b/website/docs/services/databases/cluster_config/index.md index ed7ec2c..b921d38 100644 --- a/website/docs/services/databases/cluster_config/index.md +++ b/website/docs/services/databases/cluster_config/index.md @@ -129,7 +129,8 @@ Shows configuration parameters for an existing database cluster by sending a GET SELECT config FROM digitalocean.databases.cluster_config -WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required; +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required +; ``` diff --git a/website/docs/services/databases/cluster_metrics_credentials/index.md b/website/docs/services/databases/cluster_metrics_credentials/index.md index 9da3fac..5b72f31 100644 --- a/website/docs/services/databases/cluster_metrics_credentials/index.md +++ b/website/docs/services/databases/cluster_metrics_credentials/index.md @@ -123,7 +123,8 @@ To show the credentials for all database clusters' metrics endpoints, send a GET ```sql SELECT credentials -FROM digitalocean.databases.cluster_metrics_credentials; +FROM digitalocean.databases.cluster_metrics_credentials +; ``` @@ -144,9 +145,7 @@ To update the credentials for all database clusters' metrics endpoints, send a P ```sql REPLACE digitalocean.databases.cluster_metrics_credentials SET -data__credentials = '{{ credentials }}' -WHERE -; +data__credentials = '{{ credentials }}'; ``` diff --git a/website/docs/services/databases/clusters/index.md b/website/docs/services/databases/clusters/index.md index 49adfe4..560850c 100644 --- a/website/docs/services/databases/clusters/index.md +++ b/website/docs/services/databases/clusters/index.md @@ -109,7 +109,7 @@ A JSON object with a key of `database`. string - A string specifying the UUID of the VPC to which the database cluster will be assigned. If excluded, the cluster when creating a new database cluster, it will be assigned to your account's default VPC for the region.

Requires `vpc:read` scope. (pattern: ^$|[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}, example: d455e75d-4858-4eec-8c95-da2f0a5f93a7) + A string specifying the UUID of the VPC to which the database cluster will be assigned. If excluded, the cluster when creating a new database cluster, it will be assigned to your account's default VPC for the region.

Requires `vpc:read` scope. (pattern: ^$|[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}, example: d455e75d-4858-4eec-8c95-da2f0a5f93a7) @@ -260,7 +260,7 @@ A JSON object with a key of `databases`. string - A string specifying the UUID of the VPC to which the database cluster will be assigned. If excluded, the cluster when creating a new database cluster, it will be assigned to your account's default VPC for the region.

Requires `vpc:read` scope. (pattern: ^$|[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}, example: d455e75d-4858-4eec-8c95-da2f0a5f93a7) + A string specifying the UUID of the VPC to which the database cluster will be assigned. If excluded, the cluster when creating a new database cluster, it will be assigned to your account's default VPC for the region.

Requires `vpc:read` scope. (pattern: ^$|[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}, example: d455e75d-4858-4eec-8c95-da2f0a5f93a7) @@ -492,7 +492,8 @@ version, version_end_of_availability, version_end_of_life FROM digitalocean.databases.clusters -WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required; +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required +; ``` @@ -529,7 +530,8 @@ version, version_end_of_availability, version_end_of_life FROM digitalocean.databases.clusters -WHERE tag_name = '{{ tag_name }}'; +WHERE tag_name = '{{ tag_name }}' +; ``` @@ -565,12 +567,12 @@ data__autoscale, data__backup_restore ) SELECT -'{{ name }}' --required, -'{{ engine }}' --required, +'{{ name }}' /* required */, +'{{ engine }}' /* required */, '{{ version }}', -{{ num_nodes }} --required, -'{{ size }}' --required, -'{{ region }}' --required, +{{ num_nodes }} /* required */, +'{{ size }}' /* required */, +'{{ region }}' /* required */, '{{ private_network_uuid }}', '{{ tags }}', '{{ project_id }}', @@ -668,7 +670,8 @@ To destroy a specific database, send a DELETE request to `/v2/databases/$DATABAS ```sql DELETE FROM digitalocean.databases.clusters -WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' --required; +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' --required +; ``` @@ -696,7 +699,8 @@ EXEC digitalocean.databases.clusters.databases_update_region @@json= '{ "region": "{{ region }}" -}'; +}' +; ``` @@ -711,7 +715,8 @@ EXEC digitalocean.databases.clusters.databases_update_cluster_size "size": "{{ size }}", "num_nodes": {{ num_nodes }}, "storage_size_mib": {{ storage_size_mib }} -}'; +}' +; ``` @@ -725,7 +730,8 @@ EXEC digitalocean.databases.clusters.databases_update_maintenance_window '{ "day": "{{ day }}", "hour": "{{ hour }}" -}'; +}' +; ``` @@ -734,7 +740,8 @@ To start the installation of updates for a database cluster, send a PUT request ```sql EXEC digitalocean.databases.clusters.databases_install_update -@database_cluster_uuid='{{ database_cluster_uuid }}' --required; +@database_cluster_uuid='{{ database_cluster_uuid }}' --required +; ``` @@ -747,7 +754,8 @@ EXEC digitalocean.databases.clusters.databases_update_major_version @@json= '{ "version": "{{ version }}" -}'; +}' +; ``` diff --git a/website/docs/services/databases/connection_pools/index.md b/website/docs/services/databases/connection_pools/index.md index 00ed447..cff6550 100644 --- a/website/docs/services/databases/connection_pools/index.md +++ b/website/docs/services/databases/connection_pools/index.md @@ -267,7 +267,8 @@ standby_private_connection, user FROM digitalocean.databases.connection_pools WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required -AND pool_name = '{{ pool_name }}' -- required; +AND pool_name = '{{ pool_name }}' -- required +; ``` @@ -286,7 +287,8 @@ standby_connection, standby_private_connection, user FROM digitalocean.databases.connection_pools -WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required; +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required +; ``` @@ -315,10 +317,10 @@ data__user, database_cluster_uuid ) SELECT -'{{ name }}' --required, -'{{ mode }}' --required, -{{ size }} --required, -'{{ db }}' --required, +'{{ name }}' /* required */, +'{{ mode }}' /* required */, +{{ size }} /* required */, +'{{ db }}' /* required */, '{{ user }}', '{{ database_cluster_uuid }}' RETURNING @@ -410,7 +412,8 @@ To delete a specific connection pool for a PostgreSQL database cluster, send
diff --git a/website/docs/services/databases/dbs/index.md b/website/docs/services/databases/dbs/index.md index 2a69d02..a181f4b 100644 --- a/website/docs/services/databases/dbs/index.md +++ b/website/docs/services/databases/dbs/index.md @@ -172,7 +172,8 @@ SELECT name FROM digitalocean.databases.dbs WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required -AND database_name = '{{ database_name }}' -- required; +AND database_name = '{{ database_name }}' -- required +; ``` @@ -183,7 +184,8 @@ To list all of the databases in a clusters, send a GET request to
`/v2/data SELECT name FROM digitalocean.databases.dbs -WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required; +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required +; ``` @@ -208,7 +210,7 @@ data__name, database_cluster_uuid ) SELECT -'{{ name }}' --required, +'{{ name }}' /* required */, '{{ database_cluster_uuid }}' RETURNING db @@ -249,7 +251,8 @@ To delete a specific database, send a DELETE request to
`/v2/databases/$DAT ```sql DELETE FROM digitalocean.databases.dbs WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' --required -AND database_name = '{{ database_name }}' --required; +AND database_name = '{{ database_name }}' --required +; ``` diff --git a/website/docs/services/databases/events_logs/index.md b/website/docs/services/databases/events_logs/index.md index 0f733a4..de6df7c 100644 --- a/website/docs/services/databases/events_logs/index.md +++ b/website/docs/services/databases/events_logs/index.md @@ -140,7 +140,8 @@ cluster_name, create_time, event_type FROM digitalocean.databases.events_logs -WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required; +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required +; ``` diff --git a/website/docs/services/databases/eviction_policies/index.md b/website/docs/services/databases/eviction_policies/index.md index a904d3f..412eaea 100644 --- a/website/docs/services/databases/eviction_policies/index.md +++ b/website/docs/services/databases/eviction_policies/index.md @@ -124,7 +124,8 @@ To retrieve the configured eviction policy for an existing Caching or Valkey clu SELECT * FROM digitalocean.databases.eviction_policies -WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required; +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required +; ``` diff --git a/website/docs/services/databases/firewall_rules/index.md b/website/docs/services/databases/firewall_rules/index.md index ea2df5d..450cac8 100644 --- a/website/docs/services/databases/firewall_rules/index.md +++ b/website/docs/services/databases/firewall_rules/index.md @@ -53,7 +53,7 @@ A JSON object with a key of `rules`. string - A unique ID for the database cluster to which the rule is applied. (pattern: ^$|[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}, example: 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30) + A unique ID for the database cluster to which the rule is applied. (pattern: ^$|[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}, example: 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30) @@ -68,7 +68,7 @@ A JSON object with a key of `rules`. string - A unique ID for the firewall rule itself. (pattern: ^$|[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}, example: 79f26d28-ea8a-41f2-8ad8-8cfcdd020095) + A unique ID for the firewall rule itself. (pattern: ^$|[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}, example: 79f26d28-ea8a-41f2-8ad8-8cfcdd020095) @@ -153,7 +153,8 @@ type, uuid, value FROM digitalocean.databases.firewall_rules -WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required; +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required +; ``` diff --git a/website/docs/services/databases/kafka_schema_config/index.md b/website/docs/services/databases/kafka_schema_config/index.md index 8976680..5e89c38 100644 --- a/website/docs/services/databases/kafka_schema_config/index.md +++ b/website/docs/services/databases/kafka_schema_config/index.md @@ -129,7 +129,8 @@ To retrieve the Schema Registry configuration for a Kafka cluster, send a GET re SELECT compatibility_level FROM digitalocean.databases.kafka_schema_config -WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required; +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required +; ``` diff --git a/website/docs/services/databases/kafka_schema_subject_config/index.md b/website/docs/services/databases/kafka_schema_subject_config/index.md index d170bd8..22d921a 100644 --- a/website/docs/services/databases/kafka_schema_subject_config/index.md +++ b/website/docs/services/databases/kafka_schema_subject_config/index.md @@ -141,7 +141,8 @@ subject_name, compatibility_level FROM digitalocean.databases.kafka_schema_subject_config WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required -AND subject_name = '{{ subject_name }}' -- required; +AND subject_name = '{{ subject_name }}' -- required +; ``` diff --git a/website/docs/services/databases/kafka_schema_version/index.md b/website/docs/services/databases/kafka_schema_version/index.md index 26b4371..4b89848 100644 --- a/website/docs/services/databases/kafka_schema_version/index.md +++ b/website/docs/services/databases/kafka_schema_version/index.md @@ -158,7 +158,8 @@ version FROM digitalocean.databases.kafka_schema_version WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required AND subject_name = '{{ subject_name }}' -- required -AND version = '{{ version }}' -- required; +AND version = '{{ version }}' -- required +; ``` diff --git a/website/docs/services/databases/kafka_schemas/index.md b/website/docs/services/databases/kafka_schemas/index.md index d76f6ed..081c00d 100644 --- a/website/docs/services/databases/kafka_schemas/index.md +++ b/website/docs/services/databases/kafka_schemas/index.md @@ -211,7 +211,8 @@ schema_type, version FROM digitalocean.databases.kafka_schemas WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required -AND subject_name = '{{ subject_name }}' -- required; +AND subject_name = '{{ subject_name }}' -- required +; ``` @@ -225,7 +226,8 @@ subject_name, schema, schema_type FROM digitalocean.databases.kafka_schemas -WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required; +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required +; ``` @@ -252,9 +254,9 @@ data__schema, database_cluster_uuid ) SELECT -'{{ subject_name }}' --required, -'{{ schema_type }}' --required, -'{{ schema }}' --required, +'{{ subject_name }}' /* required */, +'{{ schema_type }}' /* required */, +'{{ schema }}' /* required */, '{{ database_cluster_uuid }}' RETURNING schema_id, @@ -309,7 +311,8 @@ To delete a specific schema by subject name for a Kafka cluster, send a DELETE r ```sql DELETE FROM digitalocean.databases.kafka_schemas WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' --required -AND subject_name = '{{ subject_name }}' --required; +AND subject_name = '{{ subject_name }}' --required +; ``` diff --git a/website/docs/services/databases/kafka_topics/index.md b/website/docs/services/databases/kafka_topics/index.md index 071a373..fa99dac 100644 --- a/website/docs/services/databases/kafka_topics/index.md +++ b/website/docs/services/databases/kafka_topics/index.md @@ -218,7 +218,8 @@ replication_factor, state FROM digitalocean.databases.kafka_topics WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required -AND topic_name = '{{ topic_name }}' -- required; +AND topic_name = '{{ topic_name }}' -- required +; ``` @@ -232,7 +233,8 @@ partition_count, replication_factor, state FROM digitalocean.databases.kafka_topics -WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required; +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required +; ``` @@ -260,7 +262,7 @@ data__config, database_cluster_uuid ) SELECT -'{{ name }}' --required, +'{{ name }}' /* required */, {{ replication_factor }}, {{ partition_count }}, '{{ config }}', @@ -344,7 +346,8 @@ To delete a single topic within a Kafka cluster, send a DELETE request
to ` ```sql DELETE FROM digitalocean.databases.kafka_topics WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' --required -AND topic_name = '{{ topic_name }}' --required; +AND topic_name = '{{ topic_name }}' --required +; ``` diff --git a/website/docs/services/databases/log_sinks/index.md b/website/docs/services/databases/log_sinks/index.md index 9ddba52..6c6169f 100644 --- a/website/docs/services/databases/log_sinks/index.md +++ b/website/docs/services/databases/log_sinks/index.md @@ -194,7 +194,8 @@ SELECT sink FROM digitalocean.databases.log_sinks WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required -AND logsink_id = '{{ logsink_id }}' -- required; +AND logsink_id = '{{ logsink_id }}' -- required +; ``` @@ -208,7 +209,8 @@ sink_name, config, sink_type FROM digitalocean.databases.log_sinks -WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required; +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required +; ``` @@ -235,9 +237,9 @@ data__config, database_cluster_uuid ) SELECT -'{{ sink_name }}' --required, -'{{ sink_type }}' --required, -'{{ config }}' --required, +'{{ sink_name }}' /* required */, +'{{ sink_type }}' /* required */, +'{{ config }}' /* required */, '{{ database_cluster_uuid }}' RETURNING sink @@ -317,7 +319,8 @@ To delete a logsink for a database cluster, send a DELETE request to
`/v2/d ```sql DELETE FROM digitalocean.databases.log_sinks WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' --required -AND logsink_id = '{{ logsink_id }}' --required; +AND logsink_id = '{{ logsink_id }}' --required +; ``` diff --git a/website/docs/services/databases/online_migrations/index.md b/website/docs/services/databases/online_migrations/index.md index c1121f4..b33ed7f 100644 --- a/website/docs/services/databases/online_migrations/index.md +++ b/website/docs/services/databases/online_migrations/index.md @@ -153,7 +153,8 @@ id, created_at, status FROM digitalocean.databases.online_migrations -WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required; +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required +; ``` @@ -180,7 +181,8 @@ EXEC digitalocean.databases.online_migrations.databases_update_online_migration "source": "{{ source }}", "disable_ssl": {{ disable_ssl }}, "ignore_dbs": "{{ ignore_dbs }}" -}'; +}' +; ``` @@ -190,7 +192,8 @@ To stop an online migration, send a DELETE request to `/v2/databases/$DATABASE_I ```sql EXEC digitalocean.databases.online_migrations.databases_delete_online_migration @database_cluster_uuid='{{ database_cluster_uuid }}' --required, -@migration_id='{{ migration_id }}' --required; +@migration_id='{{ migration_id }}' --required +; ``` diff --git a/website/docs/services/databases/opensearch_indexes/index.md b/website/docs/services/databases/opensearch_indexes/index.md index 1434dbe..bcf4be6 100644 --- a/website/docs/services/databases/opensearch_indexes/index.md +++ b/website/docs/services/databases/opensearch_indexes/index.md @@ -170,7 +170,8 @@ number_of_shards, size, status FROM digitalocean.databases.opensearch_indexes -WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required; +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required +; ``` @@ -191,7 +192,8 @@ To delete a single index within OpenSearch cluster, send a DELETE request
t ```sql DELETE FROM digitalocean.databases.opensearch_indexes WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' --required -AND index_name = '{{ index_name }}' --required; +AND index_name = '{{ index_name }}' --required +; ``` diff --git a/website/docs/services/databases/options/index.md b/website/docs/services/databases/options/index.md index ad779fb..229ec9b 100644 --- a/website/docs/services/databases/options/index.md +++ b/website/docs/services/databases/options/index.md @@ -122,7 +122,8 @@ To list all of the options available for the offered database engines, send a GE SELECT options, version_availability -FROM digitalocean.databases.options; +FROM digitalocean.databases.options +; ``` diff --git a/website/docs/services/databases/replicas/index.md b/website/docs/services/databases/replicas/index.md index 04ee6ae..91e9b66 100644 --- a/website/docs/services/databases/replicas/index.md +++ b/website/docs/services/databases/replicas/index.md @@ -289,7 +289,8 @@ storage_size_mib, tags FROM digitalocean.databases.replicas WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required -AND replica_name = '{{ replica_name }}' -- required; +AND replica_name = '{{ replica_name }}' -- required +; ``` @@ -310,7 +311,8 @@ status, storage_size_mib, tags FROM digitalocean.databases.replicas -WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required; +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required +; ``` @@ -340,7 +342,7 @@ data__storage_size_mib, database_cluster_uuid ) SELECT -'{{ name }}' --required, +'{{ name }}' /* required */, '{{ region }}', '{{ size }}', '{{ tags }}', @@ -411,7 +413,8 @@ To destroy a specific read-only replica, send a DELETE request to `/v2/databases ```sql DELETE FROM digitalocean.databases.replicas WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' --required -AND replica_name = '{{ replica_name }}' --required; +AND replica_name = '{{ replica_name }}' --required +; ``` @@ -432,7 +435,8 @@ To promote a specific read-only replica, send a PUT request to `/v2/databases/$D ```sql EXEC digitalocean.databases.replicas.databases_promote_replica @database_cluster_uuid='{{ database_cluster_uuid }}' --required, -@replica_name='{{ replica_name }}' --required; +@replica_name='{{ replica_name }}' --required +; ``` diff --git a/website/docs/services/databases/sql_mode/index.md b/website/docs/services/databases/sql_mode/index.md index 49d9811..f25e091 100644 --- a/website/docs/services/databases/sql_mode/index.md +++ b/website/docs/services/databases/sql_mode/index.md @@ -129,7 +129,8 @@ To retrieve the configured SQL modes for an existing MySQL cluster, send a GET r SELECT sql_mode FROM digitalocean.databases.sql_mode -WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required; +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required +; ``` diff --git a/website/docs/services/databases/users/index.md b/website/docs/services/databases/users/index.md index 52307ed..9a3ecf2 100644 --- a/website/docs/services/databases/users/index.md +++ b/website/docs/services/databases/users/index.md @@ -252,7 +252,8 @@ role, settings FROM digitalocean.databases.users WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required -AND username = '{{ username }}' -- required; +AND username = '{{ username }}' -- required +; ``` @@ -269,7 +270,8 @@ password, role, settings FROM digitalocean.databases.users -WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required; +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required +; ``` @@ -297,7 +299,7 @@ data__readonly, database_cluster_uuid ) SELECT -'{{ name }}' --required, +'{{ name }}' /* required */, '{{ mysql_settings }}', '{{ settings }}', {{ readonly }}, @@ -380,7 +382,8 @@ To remove a specific database user, send a DELETE request to
`/v2/databases ```sql DELETE FROM digitalocean.databases.users WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' --required -AND username = '{{ username }}' --required; +AND username = '{{ username }}' --required +; ``` @@ -405,7 +408,8 @@ EXEC digitalocean.databases.users.databases_reset_auth @@json= '{ "mysql_settings": "{{ mysql_settings }}" -}'; +}' +; ``` diff --git a/website/docs/services/genai/agent_api_keys/index.md b/website/docs/services/genai/agent_api_keys/index.md index f2a0154..cc4738d 100644 --- a/website/docs/services/genai/agent_api_keys/index.md +++ b/website/docs/services/genai/agent_api_keys/index.md @@ -179,7 +179,8 @@ meta FROM digitalocean.genai.agent_api_keys WHERE agent_uuid = '{{ agent_uuid }}' -- required AND page = '{{ page }}' -AND per_page = '{{ per_page }}'; +AND per_page = '{{ per_page }}' +; ``` @@ -280,7 +281,8 @@ To delete an API key for an agent, send a DELETE request to `/v2/gen-ai/agents/& ```sql DELETE FROM digitalocean.genai.agent_api_keys WHERE agent_uuid = '{{ agent_uuid }}' --required -AND api_key_uuid = '{{ api_key_uuid }}' --required; +AND api_key_uuid = '{{ api_key_uuid }}' --required +; ``` @@ -301,7 +303,8 @@ To regenerate an agent API key, send a PUT request to `/v2/gen-ai/agents/{a ```sql EXEC digitalocean.genai.agent_api_keys.genai_regenerate_agent_api_key @agent_uuid='{{ agent_uuid }}' --required, -@api_key_uuid='{{ api_key_uuid }}' --required; +@api_key_uuid='{{ api_key_uuid }}' --required +; ``` diff --git a/website/docs/services/genai/agent_routes/index.md b/website/docs/services/genai/agent_routes/index.md index a46d392..ca5c131 100644 --- a/website/docs/services/genai/agent_routes/index.md +++ b/website/docs/services/genai/agent_routes/index.md @@ -356,7 +356,8 @@ uuid, version_hash, workspace FROM digitalocean.genai.agent_routes -WHERE uuid = '{{ uuid }}' -- required; +WHERE uuid = '{{ uuid }}' -- required +; ``` diff --git a/website/docs/services/genai/agent_usage/index.md b/website/docs/services/genai/agent_usage/index.md index cf133b8..131fd9b 100644 --- a/website/docs/services/genai/agent_usage/index.md +++ b/website/docs/services/genai/agent_usage/index.md @@ -140,7 +140,8 @@ usage FROM digitalocean.genai.agent_usage WHERE uuid = '{{ uuid }}' -- required AND start = '{{ start }}' -AND stop = '{{ stop }}'; +AND stop = '{{ stop }}' +; ``` diff --git a/website/docs/services/genai/agent_versions/index.md b/website/docs/services/genai/agent_versions/index.md index 59e4eb8..816b6da 100644 --- a/website/docs/services/genai/agent_versions/index.md +++ b/website/docs/services/genai/agent_versions/index.md @@ -153,7 +153,8 @@ meta FROM digitalocean.genai.agent_versions WHERE uuid = '{{ uuid }}' -- required AND page = '{{ page }}' -AND per_page = '{{ per_page }}'; +AND per_page = '{{ per_page }}' +; ``` @@ -178,7 +179,8 @@ EXEC digitalocean.genai.agent_versions.genai_rollback_to_agent_version '{ "uuid": "{{ uuid }}", "version_hash": "{{ version_hash }}" -}'; +}' +; ``` diff --git a/website/docs/services/genai/agents/index.md b/website/docs/services/genai/agents/index.md index 8e2748b..e64d019 100644 --- a/website/docs/services/genai/agents/index.md +++ b/website/docs/services/genai/agents/index.md @@ -553,7 +553,8 @@ uuid, version_hash, workspace FROM digitalocean.genai.agents -WHERE uuid = '{{ uuid }}' -- required; +WHERE uuid = '{{ uuid }}' -- required +; ``` @@ -569,7 +570,8 @@ FROM digitalocean.genai.agents WHERE workspace_uuid = '{{ workspace_uuid }}' -- required AND only_deployed = '{{ only_deployed }}' AND page = '{{ page }}' -AND per_page = '{{ per_page }}'; +AND per_page = '{{ per_page }}' +; ``` @@ -584,7 +586,8 @@ meta FROM digitalocean.genai.agents WHERE only_deployed = '{{ only_deployed }}' AND page = '{{ page }}' -AND per_page = '{{ per_page }}'; +AND per_page = '{{ per_page }}' +; ``` @@ -764,7 +767,8 @@ To delete an agent, send a DELETE request to `/v2/gen-ai/agents/{uuid} ```sql DELETE FROM digitalocean.genai.agents -WHERE uuid = '{{ uuid }}' --required; +WHERE uuid = '{{ uuid }}' --required +; ``` @@ -800,7 +804,8 @@ EXEC digitalocean.genai.agents.genai_attach_agent_function "function_name": "{{ function_name }}", "input_schema": "{{ input_schema }}", "output_schema": "{{ output_schema }}" -}'; +}' +; ``` @@ -821,7 +826,8 @@ EXEC digitalocean.genai.agents.genai_update_agent_function "function_uuid": "{{ function_uuid }}", "input_schema": "{{ input_schema }}", "output_schema": "{{ output_schema }}" -}'; +}' +; ``` @@ -831,7 +837,8 @@ To delete a function route from an agent, send a DELETE request to `/v2/gen-ai/a ```sql EXEC digitalocean.genai.agents.genai_detach_agent_function @agent_uuid='{{ agent_uuid }}' --required, -@function_uuid='{{ function_uuid }}' --required; +@function_uuid='{{ function_uuid }}' --required +; ``` @@ -848,7 +855,8 @@ EXEC digitalocean.genai.agents.genai_attach_agent "if_case": "{{ if_case }}", "parent_agent_uuid": "{{ parent_agent_uuid }}", "route_name": "{{ route_name }}" -}'; +}' +; ``` @@ -866,7 +874,8 @@ EXEC digitalocean.genai.agents.genai_update_attached_agent "parent_agent_uuid": "{{ parent_agent_uuid }}", "route_name": "{{ route_name }}", "uuid": "{{ uuid }}" -}'; +}' +; ``` @@ -876,7 +885,8 @@ To delete an agent route from a parent agent, send a DELETE request to `/v2/gen- ```sql EXEC digitalocean.genai.agents.genai_detach_agent @parent_agent_uuid='{{ parent_agent_uuid }}' --required, -@child_agent_uuid='{{ child_agent_uuid }}' --required; +@child_agent_uuid='{{ child_agent_uuid }}' --required +; ``` @@ -890,7 +900,8 @@ EXEC digitalocean.genai.agents.genai_update_agent_deployment_visibility '{ "uuid": "{{ uuid }}", "visibility": "{{ visibility }}" -}'; +}' +; ``` diff --git a/website/docs/services/genai/agents_by_anthropic_key/index.md b/website/docs/services/genai/agents_by_anthropic_key/index.md index 088ee19..b1967d6 100644 --- a/website/docs/services/genai/agents_by_anthropic_key/index.md +++ b/website/docs/services/genai/agents_by_anthropic_key/index.md @@ -146,7 +146,8 @@ meta FROM digitalocean.genai.agents_by_anthropic_key WHERE uuid = '{{ uuid }}' -- required AND page = '{{ page }}' -AND per_page = '{{ per_page }}'; +AND per_page = '{{ per_page }}' +; ``` diff --git a/website/docs/services/genai/agents_by_openai_key/index.md b/website/docs/services/genai/agents_by_openai_key/index.md index 2e17728..637b229 100644 --- a/website/docs/services/genai/agents_by_openai_key/index.md +++ b/website/docs/services/genai/agents_by_openai_key/index.md @@ -146,7 +146,8 @@ meta FROM digitalocean.genai.agents_by_openai_key WHERE uuid = '{{ uuid }}' -- required AND page = '{{ page }}' -AND per_page = '{{ per_page }}'; +AND per_page = '{{ per_page }}' +; ``` diff --git a/website/docs/services/genai/anthropic_api_keys/index.md b/website/docs/services/genai/anthropic_api_keys/index.md index 20e7b11..66d9afb 100644 --- a/website/docs/services/genai/anthropic_api_keys/index.md +++ b/website/docs/services/genai/anthropic_api_keys/index.md @@ -223,7 +223,8 @@ deleted_at, updated_at, uuid FROM digitalocean.genai.anthropic_api_keys -WHERE api_key_uuid = '{{ api_key_uuid }}' -- required; +WHERE api_key_uuid = '{{ api_key_uuid }}' -- required +; ``` @@ -237,7 +238,8 @@ links, meta FROM digitalocean.genai.anthropic_api_keys WHERE page = '{{ page }}' -AND per_page = '{{ per_page }}'; +AND per_page = '{{ per_page }}' +; ``` @@ -331,7 +333,8 @@ To delete an Anthropic API key, send a DELETE request to `/v2/gen-ai/anthropic/k ```sql DELETE FROM digitalocean.genai.anthropic_api_keys -WHERE api_key_uuid = '{{ api_key_uuid }}' --required; +WHERE api_key_uuid = '{{ api_key_uuid }}' --required +; ``` diff --git a/website/docs/services/genai/datacenter_regions/index.md b/website/docs/services/genai/datacenter_regions/index.md index 6d7fc04..e40bd8c 100644 --- a/website/docs/services/genai/datacenter_regions/index.md +++ b/website/docs/services/genai/datacenter_regions/index.md @@ -152,7 +152,8 @@ serves_inference, stream_inference_url FROM digitalocean.genai.datacenter_regions WHERE serves_inference = '{{ serves_inference }}' -AND serves_batch = '{{ serves_batch }}'; +AND serves_batch = '{{ serves_batch }}' +; ``` diff --git a/website/docs/services/genai/evaluation_datasets/index.md b/website/docs/services/genai/evaluation_datasets/index.md index a18b761..96716dd 100644 --- a/website/docs/services/genai/evaluation_datasets/index.md +++ b/website/docs/services/genai/evaluation_datasets/index.md @@ -146,7 +146,8 @@ EXEC digitalocean.genai.evaluation_datasets.genai_create_evaluation_dataset_file @@json= '{ "files": "{{ files }}" -}'; +}' +; ``` diff --git a/website/docs/services/genai/evaluation_metrics/index.md b/website/docs/services/genai/evaluation_metrics/index.md index de00ab9..471165c 100644 --- a/website/docs/services/genai/evaluation_metrics/index.md +++ b/website/docs/services/genai/evaluation_metrics/index.md @@ -158,7 +158,8 @@ metric_uuid, metric_value_type, range_max, range_min -FROM digitalocean.genai.evaluation_metrics; +FROM digitalocean.genai.evaluation_metrics +; ``` diff --git a/website/docs/services/genai/evaluation_run_prompt_results/index.md b/website/docs/services/genai/evaluation_run_prompt_results/index.md index 88ee9d9..1cb885f 100644 --- a/website/docs/services/genai/evaluation_run_prompt_results/index.md +++ b/website/docs/services/genai/evaluation_run_prompt_results/index.md @@ -170,7 +170,8 @@ prompt_chunks, prompt_level_metric_results FROM digitalocean.genai.evaluation_run_prompt_results WHERE evaluation_run_uuid = '{{ evaluation_run_uuid }}' -- required -AND prompt_id = '{{ prompt_id }}' -- required; +AND prompt_id = '{{ prompt_id }}' -- required +; ``` diff --git a/website/docs/services/genai/evaluation_run_results/index.md b/website/docs/services/genai/evaluation_run_results/index.md index 9d3a047..e273087 100644 --- a/website/docs/services/genai/evaluation_run_results/index.md +++ b/website/docs/services/genai/evaluation_run_results/index.md @@ -152,7 +152,8 @@ prompts FROM digitalocean.genai.evaluation_run_results WHERE evaluation_run_uuid = '{{ evaluation_run_uuid }}' -- required AND page = '{{ page }}' -AND per_page = '{{ per_page }}'; +AND per_page = '{{ per_page }}' +; ``` diff --git a/website/docs/services/genai/evaluation_runs/index.md b/website/docs/services/genai/evaluation_runs/index.md index 3d27c44..4a289b0 100644 --- a/website/docs/services/genai/evaluation_runs/index.md +++ b/website/docs/services/genai/evaluation_runs/index.md @@ -255,7 +255,8 @@ test_case_description, test_case_uuid, test_case_version FROM digitalocean.genai.evaluation_runs -WHERE evaluation_run_uuid = '{{ evaluation_run_uuid }}' -- required; +WHERE evaluation_run_uuid = '{{ evaluation_run_uuid }}' -- required +; ``` diff --git a/website/docs/services/genai/evaluation_test_cases/index.md b/website/docs/services/genai/evaluation_test_cases/index.md index 1d8d1e9..737dcbb 100644 --- a/website/docs/services/genai/evaluation_test_cases/index.md +++ b/website/docs/services/genai/evaluation_test_cases/index.md @@ -623,7 +623,8 @@ test_case_uuid, test_case_version FROM digitalocean.genai.evaluation_test_cases WHERE evaluation_test_case_uuid = '{{ evaluation_test_case_uuid }}' -- required -AND evaluation_test_case_version = '{{ evaluation_test_case_version }}'; +AND evaluation_test_case_version = '{{ evaluation_test_case_version }}' +; ``` @@ -652,7 +653,8 @@ updated_by_user_email, version FROM digitalocean.genai.evaluation_test_cases WHERE test_case_uuid = '{{ test_case_uuid }}' -- required -AND evaluation_test_case_version = '{{ evaluation_test_case_version }}'; +AND evaluation_test_case_version = '{{ evaluation_test_case_version }}' +; ``` @@ -680,7 +682,8 @@ updated_at, updated_by_user_email, version FROM digitalocean.genai.evaluation_test_cases -WHERE workspace_uuid = '{{ workspace_uuid }}' -- required; +WHERE workspace_uuid = '{{ workspace_uuid }}' -- required +; ``` @@ -707,7 +710,8 @@ total_runs, updated_at, updated_by_user_email, version -FROM digitalocean.genai.evaluation_test_cases; +FROM digitalocean.genai.evaluation_test_cases +; ``` diff --git a/website/docs/services/genai/indexing_job_data_sources/index.md b/website/docs/services/genai/indexing_job_data_sources/index.md index e3a619f..3feb7e3 100644 --- a/website/docs/services/genai/indexing_job_data_sources/index.md +++ b/website/docs/services/genai/indexing_job_data_sources/index.md @@ -200,7 +200,8 @@ total_bytes, total_bytes_indexed, total_file_count FROM digitalocean.genai.indexing_job_data_sources -WHERE indexing_job_uuid = '{{ indexing_job_uuid }}' -- required; +WHERE indexing_job_uuid = '{{ indexing_job_uuid }}' -- required +; ``` diff --git a/website/docs/services/genai/indexing_jobs/index.md b/website/docs/services/genai/indexing_jobs/index.md index d2b138b..0f5876c 100644 --- a/website/docs/services/genai/indexing_jobs/index.md +++ b/website/docs/services/genai/indexing_jobs/index.md @@ -270,7 +270,8 @@ total_items_skipped, updated_at, uuid FROM digitalocean.genai.indexing_jobs -WHERE uuid = '{{ uuid }}' -- required; +WHERE uuid = '{{ uuid }}' -- required +; ``` @@ -284,7 +285,8 @@ links, meta FROM digitalocean.genai.indexing_jobs WHERE page = '{{ page }}' -AND per_page = '{{ per_page }}'; +AND per_page = '{{ per_page }}' +; ``` diff --git a/website/docs/services/genai/knowledge_base_data_sources/index.md b/website/docs/services/genai/knowledge_base_data_sources/index.md index 14127e8..fd6a6ac 100644 --- a/website/docs/services/genai/knowledge_base_data_sources/index.md +++ b/website/docs/services/genai/knowledge_base_data_sources/index.md @@ -172,7 +172,8 @@ meta FROM digitalocean.genai.knowledge_base_data_sources WHERE knowledge_base_uuid = '{{ knowledge_base_uuid }}' -- required AND page = '{{ page }}' -AND per_page = '{{ per_page }}'; +AND per_page = '{{ per_page }}' +; ``` @@ -259,7 +260,8 @@ To delete a data source from a knowledge base, send a DELETE request to `/v2/gen ```sql DELETE FROM digitalocean.genai.knowledge_base_data_sources WHERE knowledge_base_uuid = '{{ knowledge_base_uuid }}' --required -AND data_source_uuid = '{{ data_source_uuid }}' --required; +AND data_source_uuid = '{{ data_source_uuid }}' --required +; ``` @@ -282,7 +284,8 @@ EXEC digitalocean.genai.knowledge_base_data_sources.genai_create_data_source_fil @@json= '{ "files": "{{ files }}" -}'; +}' +; ``` diff --git a/website/docs/services/genai/knowledge_bases/index.md b/website/docs/services/genai/knowledge_bases/index.md index df8b271..65d7e83 100644 --- a/website/docs/services/genai/knowledge_bases/index.md +++ b/website/docs/services/genai/knowledge_bases/index.md @@ -230,7 +230,8 @@ SELECT database_status, knowledge_base FROM digitalocean.genai.knowledge_bases -WHERE uuid = '{{ uuid }}' -- required; +WHERE uuid = '{{ uuid }}' -- required +; ``` @@ -244,7 +245,8 @@ links, meta FROM digitalocean.genai.knowledge_bases WHERE page = '{{ page }}' -AND per_page = '{{ per_page }}'; +AND per_page = '{{ per_page }}' +; ``` @@ -385,7 +387,8 @@ To delete a knowledge base, send a DELETE request to `/v2/gen-ai/knowledge_bases ```sql DELETE FROM digitalocean.genai.knowledge_bases -WHERE uuid = '{{ uuid }}' --required; +WHERE uuid = '{{ uuid }}' --required +; ``` @@ -407,7 +410,8 @@ To attach knowledge bases to an agent, send a POST request to `/v2/gen-ai/agents ```sql EXEC digitalocean.genai.knowledge_bases.genai_attach_knowledge_bases -@agent_uuid='{{ agent_uuid }}' --required; +@agent_uuid='{{ agent_uuid }}' --required +; ``` @@ -417,7 +421,8 @@ To attach a knowledge base to an agent, send a POST request to `/v2/gen-ai/agent ```sql EXEC digitalocean.genai.knowledge_bases.genai_attach_knowledge_base @agent_uuid='{{ agent_uuid }}' --required, -@knowledge_base_uuid='{{ knowledge_base_uuid }}' --required; +@knowledge_base_uuid='{{ knowledge_base_uuid }}' --required +; ``` @@ -427,7 +432,8 @@ To detach a knowledge base from an agent, send a DELETE request to `/v2/gen-ai/a ```sql EXEC digitalocean.genai.knowledge_bases.genai_detach_knowledge_base @agent_uuid='{{ agent_uuid }}' --required, -@knowledge_base_uuid='{{ knowledge_base_uuid }}' --required; +@knowledge_base_uuid='{{ knowledge_base_uuid }}' --required +; ``` diff --git a/website/docs/services/genai/model_api_keys/index.md b/website/docs/services/genai/model_api_keys/index.md index 0e4aece..3c4ba50 100644 --- a/website/docs/services/genai/model_api_keys/index.md +++ b/website/docs/services/genai/model_api_keys/index.md @@ -173,7 +173,8 @@ links, meta FROM digitalocean.genai.model_api_keys WHERE page = '{{ page }}' -AND per_page = '{{ per_page }}'; +AND per_page = '{{ per_page }}' +; ``` @@ -259,7 +260,8 @@ To delete an API key for a model, send a DELETE request to `/v2/gen-ai/models/ap ```sql DELETE FROM digitalocean.genai.model_api_keys -WHERE api_key_uuid = '{{ api_key_uuid }}' --required; +WHERE api_key_uuid = '{{ api_key_uuid }}' --required +; ``` @@ -279,7 +281,8 @@ To regenerate a model API key, send a PUT request to `/v2/gen-ai/models/api_keys ```sql EXEC digitalocean.genai.model_api_keys.genai_regenerate_model_api_key -@api_key_uuid='{{ api_key_uuid }}' --required; +@api_key_uuid='{{ api_key_uuid }}' --required +; ``` diff --git a/website/docs/services/genai/models/index.md b/website/docs/services/genai/models/index.md index db319a4..1ad47c7 100644 --- a/website/docs/services/genai/models/index.md +++ b/website/docs/services/genai/models/index.md @@ -152,7 +152,8 @@ FROM digitalocean.genai.models WHERE usecases = '{{ usecases }}' AND public_only = '{{ public_only }}' AND page = '{{ page }}' -AND per_page = '{{ per_page }}'; +AND per_page = '{{ per_page }}' +; ``` diff --git a/website/docs/services/genai/oauth2/index.md b/website/docs/services/genai/oauth2/index.md index 5e7ae13..a70428f 100644 --- a/website/docs/services/genai/oauth2/index.md +++ b/website/docs/services/genai/oauth2/index.md @@ -135,7 +135,8 @@ SELECT url FROM digitalocean.genai.oauth2 WHERE type = '{{ type }}' -AND redirect_url = '{{ redirect_url }}'; +AND redirect_url = '{{ redirect_url }}' +; ``` @@ -159,7 +160,8 @@ EXEC digitalocean.genai.oauth2.genai_create_oauth2_dropbox_tokens '{ "code": "{{ code }}", "redirect_url": "{{ redirect_url }}" -}'; +}' +; ``` diff --git a/website/docs/services/genai/openai_api_keys/index.md b/website/docs/services/genai/openai_api_keys/index.md index e875ba6..0d8c887 100644 --- a/website/docs/services/genai/openai_api_keys/index.md +++ b/website/docs/services/genai/openai_api_keys/index.md @@ -229,7 +229,8 @@ models, updated_at, uuid FROM digitalocean.genai.openai_api_keys -WHERE api_key_uuid = '{{ api_key_uuid }}' -- required; +WHERE api_key_uuid = '{{ api_key_uuid }}' -- required +; ``` @@ -243,7 +244,8 @@ links, meta FROM digitalocean.genai.openai_api_keys WHERE page = '{{ page }}' -AND per_page = '{{ per_page }}'; +AND per_page = '{{ per_page }}' +; ``` @@ -337,7 +339,8 @@ To delete an OpenAI API key, send a DELETE request to `/v2/gen-ai/openai/keys/&# ```sql DELETE FROM digitalocean.genai.openai_api_keys -WHERE api_key_uuid = '{{ api_key_uuid }}' --required; +WHERE api_key_uuid = '{{ api_key_uuid }}' --required +; ``` diff --git a/website/docs/services/genai/workspaces/index.md b/website/docs/services/genai/workspaces/index.md index 2fb9bc7..5463145 100644 --- a/website/docs/services/genai/workspaces/index.md +++ b/website/docs/services/genai/workspaces/index.md @@ -272,7 +272,8 @@ evaluation_test_cases, updated_at, uuid FROM digitalocean.genai.workspaces -WHERE workspace_uuid = '{{ workspace_uuid }}' -- required; +WHERE workspace_uuid = '{{ workspace_uuid }}' -- required +; ``` @@ -291,7 +292,8 @@ description, evaluation_test_cases, updated_at, uuid -FROM digitalocean.genai.workspaces; +FROM digitalocean.genai.workspaces +; ``` @@ -392,7 +394,8 @@ To delete a workspace, send a DELETE request to `/v2/gen-ai/workspace/{work ```sql DELETE FROM digitalocean.genai.workspaces -WHERE workspace_uuid = '{{ workspace_uuid }}' --required; +WHERE workspace_uuid = '{{ workspace_uuid }}' --required +; ``` diff --git a/website/docs/services/kubernetes/associated_resources/index.md b/website/docs/services/kubernetes/associated_resources/index.md index 5d9bd58..8256fc1 100644 --- a/website/docs/services/kubernetes/associated_resources/index.md +++ b/website/docs/services/kubernetes/associated_resources/index.md @@ -148,7 +148,8 @@ load_balancers, volume_snapshots, volumes FROM digitalocean.kubernetes.associated_resources -WHERE cluster_id = '{{ cluster_id }}' -- required; +WHERE cluster_id = '{{ cluster_id }}' -- required +; ``` @@ -168,7 +169,8 @@ To delete a Kubernetes cluster along with a subset of its associated resources,< ```sql DELETE FROM digitalocean.kubernetes.associated_resources -WHERE cluster_id = '{{ cluster_id }}' --required; +WHERE cluster_id = '{{ cluster_id }}' --required +; ``` @@ -188,7 +190,8 @@ To delete a Kubernetes cluster with all of its associated resources, send a
diff --git a/website/docs/services/kubernetes/available_upgrades/index.md b/website/docs/services/kubernetes/available_upgrades/index.md index 240f4b2..d66285b 100644 --- a/website/docs/services/kubernetes/available_upgrades/index.md +++ b/website/docs/services/kubernetes/available_upgrades/index.md @@ -134,7 +134,8 @@ kubernetes_version, slug, supported_features FROM digitalocean.kubernetes.available_upgrades -WHERE cluster_id = '{{ cluster_id }}' -- required; +WHERE cluster_id = '{{ cluster_id }}' -- required +; ``` diff --git a/website/docs/services/kubernetes/cluster_user/index.md b/website/docs/services/kubernetes/cluster_user/index.md index 520ab1d..f090905 100644 --- a/website/docs/services/kubernetes/cluster_user/index.md +++ b/website/docs/services/kubernetes/cluster_user/index.md @@ -128,7 +128,8 @@ SELECT groups, username FROM digitalocean.kubernetes.cluster_user -WHERE cluster_id = '{{ cluster_id }}' -- required; +WHERE cluster_id = '{{ cluster_id }}' -- required +; ``` diff --git a/website/docs/services/kubernetes/clusters/index.md b/website/docs/services/kubernetes/clusters/index.md index a53f291..ebcd5df 100644 --- a/website/docs/services/kubernetes/clusters/index.md +++ b/website/docs/services/kubernetes/clusters/index.md @@ -469,7 +469,8 @@ updated_at, version, vpc_uuid FROM digitalocean.kubernetes.clusters -WHERE cluster_id = '{{ cluster_id }}' -- required; +WHERE cluster_id = '{{ cluster_id }}' -- required +; ``` @@ -504,7 +505,8 @@ version, vpc_uuid FROM digitalocean.kubernetes.clusters WHERE per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` @@ -544,14 +546,14 @@ data__amd_gpu_device_plugin, data__amd_gpu_device_metrics_exporter_plugin ) SELECT -'{{ name }}' --required, -'{{ region }}' --required, -'{{ version }}' --required, +'{{ name }}' /* required */, +'{{ region }}' /* required */, +'{{ version }}' /* required */, '{{ cluster_subnet }}', '{{ service_subnet }}', '{{ vpc_uuid }}', '{{ tags }}', -'{{ node_pools }}' --required, +'{{ node_pools }}' /* required */, '{{ maintenance_policy }}', {{ auto_upgrade }}, {{ surge_upgrade }}, @@ -715,7 +717,8 @@ To delete a Kubernetes cluster and all services deployed to it, send a DELETE
@@ -739,7 +742,8 @@ This endpoint returns a kubeconfig file in YAML format. It can be used to
c ```sql EXEC digitalocean.kubernetes.clusters.kubernetes_get_kubeconfig @cluster_id='{{ cluster_id }}' --required, -@expiry_seconds='{{ expiry_seconds }}'; +@expiry_seconds='{{ expiry_seconds }}' +; ``` @@ -752,7 +756,8 @@ EXEC digitalocean.kubernetes.clusters.kubernetes_upgrade_cluster @@json= '{ "version": "{{ version }}" -}'; +}' +; ``` @@ -764,7 +769,8 @@ EXEC digitalocean.kubernetes.clusters.kubernetes_add_registry @@json= '{ "cluster_uuids": "{{ cluster_uuids }}" -}'; +}' +; ``` @@ -776,7 +782,8 @@ EXEC digitalocean.kubernetes.clusters.kubernetes_remove_registry @@json= '{ "cluster_uuids": "{{ cluster_uuids }}" -}'; +}' +; ``` diff --git a/website/docs/services/kubernetes/credentials/index.md b/website/docs/services/kubernetes/credentials/index.md index b76b874..65b5603 100644 --- a/website/docs/services/kubernetes/credentials/index.md +++ b/website/docs/services/kubernetes/credentials/index.md @@ -158,7 +158,8 @@ server, token FROM digitalocean.kubernetes.credentials WHERE cluster_id = '{{ cluster_id }}' -- required -AND expiry_seconds = '{{ expiry_seconds }}'; +AND expiry_seconds = '{{ expiry_seconds }}' +; ``` diff --git a/website/docs/services/kubernetes/lint_checks/index.md b/website/docs/services/kubernetes/lint_checks/index.md index d7382ad..0ccbb4c 100644 --- a/website/docs/services/kubernetes/lint_checks/index.md +++ b/website/docs/services/kubernetes/lint_checks/index.md @@ -153,7 +153,8 @@ diagnostics, requested_at FROM digitalocean.kubernetes.lint_checks WHERE cluster_id = '{{ cluster_id }}' -- required -AND run_id = '{{ run_id }}'; +AND run_id = '{{ run_id }}' +; ``` @@ -180,7 +181,8 @@ EXEC digitalocean.kubernetes.lint_checks.kubernetes_run_cluster_lint "include_checks": "{{ include_checks }}", "exclude_groups": "{{ exclude_groups }}", "exclude_checks": "{{ exclude_checks }}" -}'; +}' +; ``` diff --git a/website/docs/services/kubernetes/node_pools/index.md b/website/docs/services/kubernetes/node_pools/index.md index 3472446..a476dde 100644 --- a/website/docs/services/kubernetes/node_pools/index.md +++ b/website/docs/services/kubernetes/node_pools/index.md @@ -296,7 +296,8 @@ tags, taints FROM digitalocean.kubernetes.node_pools WHERE cluster_id = '{{ cluster_id }}' -- required -AND node_pool_id = '{{ node_pool_id }}' -- required; +AND node_pool_id = '{{ node_pool_id }}' -- required +; ``` @@ -317,7 +318,8 @@ size, tags, taints FROM digitalocean.kubernetes.node_pools -WHERE cluster_id = '{{ cluster_id }}' -- required; +WHERE cluster_id = '{{ cluster_id }}' -- required +; ``` @@ -350,9 +352,9 @@ data__max_nodes, cluster_id ) SELECT -'{{ size }}' --required, -'{{ name }}' --required, -{{ count }} --required, +'{{ size }}' /* required */, +'{{ name }}' /* required */, +{{ count }} /* required */, '{{ tags }}', '{{ labels }}', '{{ taints }}', @@ -474,7 +476,8 @@ To delete a node pool, send a DELETE request to
`/v2/kubernetes/clusters/$K ```sql DELETE FROM digitalocean.kubernetes.node_pools WHERE cluster_id = '{{ cluster_id }}' --required -AND node_pool_id = '{{ node_pool_id }}' --required; +AND node_pool_id = '{{ node_pool_id }}' --required +; ``` @@ -499,7 +502,8 @@ EXEC digitalocean.kubernetes.node_pools.kubernetes_recycle_node_pool @@json= '{ "nodes": "{{ nodes }}" -}'; +}' +; ``` diff --git a/website/docs/services/kubernetes/nodes/index.md b/website/docs/services/kubernetes/nodes/index.md index d225018..ffd7f8a 100644 --- a/website/docs/services/kubernetes/nodes/index.md +++ b/website/docs/services/kubernetes/nodes/index.md @@ -118,7 +118,8 @@ WHERE cluster_id = '{{ cluster_id }}' --required AND node_pool_id = '{{ node_pool_id }}' --required AND node_id = '{{ node_id }}' --required AND skip_drain = '{{ skip_drain }}' -AND replace = '{{ replace }}'; +AND replace = '{{ replace }}' +; ``` diff --git a/website/docs/services/kubernetes/options/index.md b/website/docs/services/kubernetes/options/index.md index 6e28a52..b399273 100644 --- a/website/docs/services/kubernetes/options/index.md +++ b/website/docs/services/kubernetes/options/index.md @@ -128,7 +128,8 @@ SELECT regions, sizes, versions -FROM digitalocean.kubernetes.options; +FROM digitalocean.kubernetes.options +; ``` diff --git a/website/docs/services/kubernetes/status_messages/index.md b/website/docs/services/kubernetes/status_messages/index.md index 99bdd15..ed9f47a 100644 --- a/website/docs/services/kubernetes/status_messages/index.md +++ b/website/docs/services/kubernetes/status_messages/index.md @@ -134,7 +134,8 @@ message, timestamp FROM digitalocean.kubernetes.status_messages WHERE cluster_id = '{{ cluster_id }}' -- required -AND since = '{{ since }}'; +AND since = '{{ since }}' +; ``` diff --git a/website/docs/services/monitoring/alert_policies/index.md b/website/docs/services/monitoring/alert_policies/index.md index 64d49de..0fecd24 100644 --- a/website/docs/services/monitoring/alert_policies/index.md +++ b/website/docs/services/monitoring/alert_policies/index.md @@ -247,7 +247,8 @@ uuid, value, window FROM digitalocean.monitoring.alert_policies -WHERE alert_uuid = '{{ alert_uuid }}' -- required; +WHERE alert_uuid = '{{ alert_uuid }}' -- required +; ``` @@ -261,7 +262,8 @@ meta, policies FROM digitalocean.monitoring.alert_policies WHERE per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` @@ -293,15 +295,15 @@ data__value, data__window ) SELECT -'{{ alerts }}' --required, -'{{ compare }}' --required, -'{{ description }}' --required, -{{ enabled }} --required, -'{{ entities }}' --required, -'{{ tags }}' --required, -'{{ type }}' --required, -{{ value }} --required, -'{{ window }}' --required +'{{ alerts }}' /* required */, +'{{ compare }}' /* required */, +'{{ description }}' /* required */, +{{ enabled }} /* required */, +'{{ entities }}' /* required */, +'{{ tags }}' /* required */, +'{{ type }}' /* required */, +{{ value }} /* required */, +'{{ window }}' /* required */ RETURNING policy ; @@ -395,7 +397,8 @@ To delete an alert policy, send a DELETE request to `/v2/monitoring/alerts/{ ```sql DELETE FROM digitalocean.monitoring.alert_policies -WHERE alert_uuid = '{{ alert_uuid }}' --required; +WHERE alert_uuid = '{{ alert_uuid }}' --required +; ``` diff --git a/website/docs/services/monitoring/alerts/index.md b/website/docs/services/monitoring/alerts/index.md index 05a6fb8..9e2a39e 100644 --- a/website/docs/services/monitoring/alerts/index.md +++ b/website/docs/services/monitoring/alerts/index.md @@ -255,7 +255,8 @@ threshold, type FROM digitalocean.monitoring.alerts WHERE check_id = '{{ check_id }}' -- required -AND alert_id = '{{ alert_id }}' -- required; +AND alert_id = '{{ alert_id }}' -- required +; ``` @@ -274,7 +275,8 @@ type FROM digitalocean.monitoring.alerts WHERE check_id = '{{ check_id }}' -- required AND per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` @@ -304,12 +306,12 @@ data__period, check_id ) SELECT -'{{ name }}' --required, -'{{ type }}' --required, +'{{ name }}' /* required */, +'{{ type }}' /* required */, {{ threshold }}, '{{ comparison }}', -'{{ notifications }}' --required, -'{{ period }}' --required, +'{{ notifications }}' /* required */, +'{{ period }}' /* required */, '{{ check_id }}' RETURNING alert @@ -413,7 +415,8 @@ To delete an Uptime alert, send a DELETE request to `/v2/uptime/checks/$CHECK_ID ```sql DELETE FROM digitalocean.monitoring.alerts WHERE check_id = '{{ check_id }}' --required -AND alert_id = '{{ alert_id }}' --required; +AND alert_id = '{{ alert_id }}' --required +; ``` diff --git a/website/docs/services/monitoring/app_cpu_percentage_metrics/index.md b/website/docs/services/monitoring/app_cpu_percentage_metrics/index.md index 7df0d73..00be7f3 100644 --- a/website/docs/services/monitoring/app_cpu_percentage_metrics/index.md +++ b/website/docs/services/monitoring/app_cpu_percentage_metrics/index.md @@ -146,7 +146,8 @@ FROM digitalocean.monitoring.app_cpu_percentage_metrics WHERE app_id = '{{ app_id }}' -- required AND start = '{{ start }}' -- required AND end = '{{ end }}' -- required -AND app_component = '{{ app_component }}'; +AND app_component = '{{ app_component }}' +; ``` diff --git a/website/docs/services/monitoring/app_memory_percentage_metrics/index.md b/website/docs/services/monitoring/app_memory_percentage_metrics/index.md index ccc9301..f283465 100644 --- a/website/docs/services/monitoring/app_memory_percentage_metrics/index.md +++ b/website/docs/services/monitoring/app_memory_percentage_metrics/index.md @@ -146,7 +146,8 @@ FROM digitalocean.monitoring.app_memory_percentage_metrics WHERE app_id = '{{ app_id }}' -- required AND start = '{{ start }}' -- required AND end = '{{ end }}' -- required -AND app_component = '{{ app_component }}'; +AND app_component = '{{ app_component }}' +; ``` diff --git a/website/docs/services/monitoring/app_restart_count_metrics/index.md b/website/docs/services/monitoring/app_restart_count_metrics/index.md index 6528ae9..c9e028b 100644 --- a/website/docs/services/monitoring/app_restart_count_metrics/index.md +++ b/website/docs/services/monitoring/app_restart_count_metrics/index.md @@ -146,7 +146,8 @@ FROM digitalocean.monitoring.app_restart_count_metrics WHERE app_id = '{{ app_id }}' -- required AND start = '{{ start }}' -- required AND end = '{{ end }}' -- required -AND app_component = '{{ app_component }}'; +AND app_component = '{{ app_component }}' +; ``` diff --git a/website/docs/services/monitoring/check_states/index.md b/website/docs/services/monitoring/check_states/index.md index d32893c..3c27987 100644 --- a/website/docs/services/monitoring/check_states/index.md +++ b/website/docs/services/monitoring/check_states/index.md @@ -128,7 +128,8 @@ SELECT previous_outage, regions FROM digitalocean.monitoring.check_states -WHERE check_id = '{{ check_id }}' -- required; +WHERE check_id = '{{ check_id }}' -- required +; ``` diff --git a/website/docs/services/monitoring/checks/index.md b/website/docs/services/monitoring/checks/index.md index efe739a..a9d274f 100644 --- a/website/docs/services/monitoring/checks/index.md +++ b/website/docs/services/monitoring/checks/index.md @@ -238,7 +238,8 @@ regions, target, type FROM digitalocean.monitoring.checks -WHERE check_id = '{{ check_id }}' -- required; +WHERE check_id = '{{ check_id }}' -- required +; ``` @@ -255,7 +256,8 @@ target, type FROM digitalocean.monitoring.checks WHERE per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` @@ -283,11 +285,11 @@ data__regions, data__enabled ) SELECT -'{{ name }}' --required, -'{{ type }}' --required, -'{{ target }}' --required, -'{{ regions }}' --required, -{{ enabled }} --required +'{{ name }}' /* required */, +'{{ type }}' /* required */, +'{{ target }}' /* required */, +'{{ regions }}' /* required */, +{{ enabled }} /* required */ RETURNING check ; @@ -374,7 +376,8 @@ To delete an Uptime check, send a DELETE request to `/v2/uptime/checks/$CHECK_ID ```sql DELETE FROM digitalocean.monitoring.checks -WHERE check_id = '{{ check_id }}' --required; +WHERE check_id = '{{ check_id }}' --required +; ``` diff --git a/website/docs/services/monitoring/destinations/index.md b/website/docs/services/monitoring/destinations/index.md index ff61b0c..9e3d746 100644 --- a/website/docs/services/monitoring/destinations/index.md +++ b/website/docs/services/monitoring/destinations/index.md @@ -206,7 +206,8 @@ name, config, type FROM digitalocean.monitoring.destinations -WHERE destination_uuid = '{{ destination_uuid }}' -- required; +WHERE destination_uuid = '{{ destination_uuid }}' -- required +; ``` @@ -219,7 +220,8 @@ id, name, config, type -FROM digitalocean.monitoring.destinations; +FROM digitalocean.monitoring.destinations +; ``` @@ -248,8 +250,8 @@ destination_uuid ) SELECT '{{ name }}', -'{{ type }}' --required, -'{{ config }}' --required, +'{{ type }}' /* required */, +'{{ config }}' /* required */, '{{ destination_uuid }}' ; ``` @@ -266,8 +268,8 @@ data__config ) SELECT '{{ name }}', -'{{ type }}' --required, -'{{ config }}' --required +'{{ type }}' /* required */, +'{{ config }}' /* required */ RETURNING destination ; @@ -315,7 +317,8 @@ To delete a destination and all associated sinks, send a DELETE request to `/v2/ ```sql DELETE FROM digitalocean.monitoring.destinations -WHERE destination_uuid = '{{ destination_uuid }}' --required; +WHERE destination_uuid = '{{ destination_uuid }}' --required +; ``` diff --git a/website/docs/services/monitoring/droplet_autoscale_current_cpu_utilization/index.md b/website/docs/services/monitoring/droplet_autoscale_current_cpu_utilization/index.md index ff1d8d2..2d454e0 100644 --- a/website/docs/services/monitoring/droplet_autoscale_current_cpu_utilization/index.md +++ b/website/docs/services/monitoring/droplet_autoscale_current_cpu_utilization/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.droplet_autoscale_current_cpu_utilization WHERE autoscale_pool_id = '{{ autoscale_pool_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/droplet_autoscale_current_instances/index.md b/website/docs/services/monitoring/droplet_autoscale_current_instances/index.md index 12ff878..9c7a230 100644 --- a/website/docs/services/monitoring/droplet_autoscale_current_instances/index.md +++ b/website/docs/services/monitoring/droplet_autoscale_current_instances/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.droplet_autoscale_current_instances WHERE autoscale_pool_id = '{{ autoscale_pool_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/droplet_autoscale_current_memory_utilization/index.md b/website/docs/services/monitoring/droplet_autoscale_current_memory_utilization/index.md index 0ba60d6..b20043f 100644 --- a/website/docs/services/monitoring/droplet_autoscale_current_memory_utilization/index.md +++ b/website/docs/services/monitoring/droplet_autoscale_current_memory_utilization/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.droplet_autoscale_current_memory_utilization WHERE autoscale_pool_id = '{{ autoscale_pool_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/droplet_autoscale_target_cpu_utilization/index.md b/website/docs/services/monitoring/droplet_autoscale_target_cpu_utilization/index.md index f0707af..f29c395 100644 --- a/website/docs/services/monitoring/droplet_autoscale_target_cpu_utilization/index.md +++ b/website/docs/services/monitoring/droplet_autoscale_target_cpu_utilization/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.droplet_autoscale_target_cpu_utilization WHERE autoscale_pool_id = '{{ autoscale_pool_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/droplet_autoscale_target_instances/index.md b/website/docs/services/monitoring/droplet_autoscale_target_instances/index.md index 4e33dab..5271115 100644 --- a/website/docs/services/monitoring/droplet_autoscale_target_instances/index.md +++ b/website/docs/services/monitoring/droplet_autoscale_target_instances/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.droplet_autoscale_target_instances WHERE autoscale_pool_id = '{{ autoscale_pool_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/droplet_autoscale_target_memory_utilization/index.md b/website/docs/services/monitoring/droplet_autoscale_target_memory_utilization/index.md index a6ac857..a5ce016 100644 --- a/website/docs/services/monitoring/droplet_autoscale_target_memory_utilization/index.md +++ b/website/docs/services/monitoring/droplet_autoscale_target_memory_utilization/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.droplet_autoscale_target_memory_utilization WHERE autoscale_pool_id = '{{ autoscale_pool_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/droplet_bandwidth_metrics/index.md b/website/docs/services/monitoring/droplet_bandwidth_metrics/index.md index dd0820e..640eba9 100644 --- a/website/docs/services/monitoring/droplet_bandwidth_metrics/index.md +++ b/website/docs/services/monitoring/droplet_bandwidth_metrics/index.md @@ -152,7 +152,8 @@ WHERE host_id = '{{ host_id }}' -- required AND interface = '{{ interface }}' -- required AND direction = '{{ direction }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/droplet_cpu_metrics/index.md b/website/docs/services/monitoring/droplet_cpu_metrics/index.md index ccc9ae9..01f9d0f 100644 --- a/website/docs/services/monitoring/droplet_cpu_metrics/index.md +++ b/website/docs/services/monitoring/droplet_cpu_metrics/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.droplet_cpu_metrics WHERE host_id = '{{ host_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/droplet_filesystem_free_metrics/index.md b/website/docs/services/monitoring/droplet_filesystem_free_metrics/index.md index 0cdb2dc..70ab040 100644 --- a/website/docs/services/monitoring/droplet_filesystem_free_metrics/index.md +++ b/website/docs/services/monitoring/droplet_filesystem_free_metrics/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.droplet_filesystem_free_metrics WHERE host_id = '{{ host_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/droplet_filesystem_size_metrics/index.md b/website/docs/services/monitoring/droplet_filesystem_size_metrics/index.md index 82a83e7..9c78d2f 100644 --- a/website/docs/services/monitoring/droplet_filesystem_size_metrics/index.md +++ b/website/docs/services/monitoring/droplet_filesystem_size_metrics/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.droplet_filesystem_size_metrics WHERE host_id = '{{ host_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/droplet_load15_metrics/index.md b/website/docs/services/monitoring/droplet_load15_metrics/index.md index 49559e7..b0013b4 100644 --- a/website/docs/services/monitoring/droplet_load15_metrics/index.md +++ b/website/docs/services/monitoring/droplet_load15_metrics/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.droplet_load15_metrics WHERE host_id = '{{ host_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/droplet_load1_metrics/index.md b/website/docs/services/monitoring/droplet_load1_metrics/index.md index 0d69bea..5039274 100644 --- a/website/docs/services/monitoring/droplet_load1_metrics/index.md +++ b/website/docs/services/monitoring/droplet_load1_metrics/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.droplet_load1_metrics WHERE host_id = '{{ host_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/droplet_load5_metrics/index.md b/website/docs/services/monitoring/droplet_load5_metrics/index.md index 6285db7..b385796 100644 --- a/website/docs/services/monitoring/droplet_load5_metrics/index.md +++ b/website/docs/services/monitoring/droplet_load5_metrics/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.droplet_load5_metrics WHERE host_id = '{{ host_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/droplet_memory_available_metrics/index.md b/website/docs/services/monitoring/droplet_memory_available_metrics/index.md index 42e432d..190d8be 100644 --- a/website/docs/services/monitoring/droplet_memory_available_metrics/index.md +++ b/website/docs/services/monitoring/droplet_memory_available_metrics/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.droplet_memory_available_metrics WHERE host_id = '{{ host_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/droplet_memory_cached_metrics/index.md b/website/docs/services/monitoring/droplet_memory_cached_metrics/index.md index 93ebf20..1916ab2 100644 --- a/website/docs/services/monitoring/droplet_memory_cached_metrics/index.md +++ b/website/docs/services/monitoring/droplet_memory_cached_metrics/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.droplet_memory_cached_metrics WHERE host_id = '{{ host_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/droplet_memory_free_metrics/index.md b/website/docs/services/monitoring/droplet_memory_free_metrics/index.md index 62a937e..30d422e 100644 --- a/website/docs/services/monitoring/droplet_memory_free_metrics/index.md +++ b/website/docs/services/monitoring/droplet_memory_free_metrics/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.droplet_memory_free_metrics WHERE host_id = '{{ host_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/droplet_memory_total_metrics/index.md b/website/docs/services/monitoring/droplet_memory_total_metrics/index.md index f021ee7..9ce418e 100644 --- a/website/docs/services/monitoring/droplet_memory_total_metrics/index.md +++ b/website/docs/services/monitoring/droplet_memory_total_metrics/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.droplet_memory_total_metrics WHERE host_id = '{{ host_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/lb_droplets_connections/index.md b/website/docs/services/monitoring/lb_droplets_connections/index.md index e1fdc12..7f887d9 100644 --- a/website/docs/services/monitoring/lb_droplets_connections/index.md +++ b/website/docs/services/monitoring/lb_droplets_connections/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.lb_droplets_connections WHERE lb_id = '{{ lb_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/lb_droplets_downtime/index.md b/website/docs/services/monitoring/lb_droplets_downtime/index.md index 51aae78..fcde490 100644 --- a/website/docs/services/monitoring/lb_droplets_downtime/index.md +++ b/website/docs/services/monitoring/lb_droplets_downtime/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.lb_droplets_downtime WHERE lb_id = '{{ lb_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/lb_droplets_health_checks/index.md b/website/docs/services/monitoring/lb_droplets_health_checks/index.md index b58a638..589c6ae 100644 --- a/website/docs/services/monitoring/lb_droplets_health_checks/index.md +++ b/website/docs/services/monitoring/lb_droplets_health_checks/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.lb_droplets_health_checks WHERE lb_id = '{{ lb_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/lb_droplets_http_response_time_50p/index.md b/website/docs/services/monitoring/lb_droplets_http_response_time_50p/index.md index 5f8f6bd..cc16a2a 100644 --- a/website/docs/services/monitoring/lb_droplets_http_response_time_50p/index.md +++ b/website/docs/services/monitoring/lb_droplets_http_response_time_50p/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.lb_droplets_http_response_time_50p WHERE lb_id = '{{ lb_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/lb_droplets_http_response_time_95p/index.md b/website/docs/services/monitoring/lb_droplets_http_response_time_95p/index.md index 768871b..589e941 100644 --- a/website/docs/services/monitoring/lb_droplets_http_response_time_95p/index.md +++ b/website/docs/services/monitoring/lb_droplets_http_response_time_95p/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.lb_droplets_http_response_time_95p WHERE lb_id = '{{ lb_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/lb_droplets_http_response_time_99p/index.md b/website/docs/services/monitoring/lb_droplets_http_response_time_99p/index.md index 55d07d2..706a4ee 100644 --- a/website/docs/services/monitoring/lb_droplets_http_response_time_99p/index.md +++ b/website/docs/services/monitoring/lb_droplets_http_response_time_99p/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.lb_droplets_http_response_time_99p WHERE lb_id = '{{ lb_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/lb_droplets_http_response_time_avg/index.md b/website/docs/services/monitoring/lb_droplets_http_response_time_avg/index.md index 3c4102e..608dd98 100644 --- a/website/docs/services/monitoring/lb_droplets_http_response_time_avg/index.md +++ b/website/docs/services/monitoring/lb_droplets_http_response_time_avg/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.lb_droplets_http_response_time_avg WHERE lb_id = '{{ lb_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/lb_droplets_http_responses/index.md b/website/docs/services/monitoring/lb_droplets_http_responses/index.md index 12dfee7..a6e4f4a 100644 --- a/website/docs/services/monitoring/lb_droplets_http_responses/index.md +++ b/website/docs/services/monitoring/lb_droplets_http_responses/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.lb_droplets_http_responses WHERE lb_id = '{{ lb_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/lb_droplets_http_session_duration_50p/index.md b/website/docs/services/monitoring/lb_droplets_http_session_duration_50p/index.md index 1ad426a..e5e7ba9 100644 --- a/website/docs/services/monitoring/lb_droplets_http_session_duration_50p/index.md +++ b/website/docs/services/monitoring/lb_droplets_http_session_duration_50p/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.lb_droplets_http_session_duration_50p WHERE lb_id = '{{ lb_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/lb_droplets_http_session_duration_95p/index.md b/website/docs/services/monitoring/lb_droplets_http_session_duration_95p/index.md index 4740695..facef65 100644 --- a/website/docs/services/monitoring/lb_droplets_http_session_duration_95p/index.md +++ b/website/docs/services/monitoring/lb_droplets_http_session_duration_95p/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.lb_droplets_http_session_duration_95p WHERE lb_id = '{{ lb_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/lb_droplets_http_session_duration_avg/index.md b/website/docs/services/monitoring/lb_droplets_http_session_duration_avg/index.md index b510f01..4b1b33a 100644 --- a/website/docs/services/monitoring/lb_droplets_http_session_duration_avg/index.md +++ b/website/docs/services/monitoring/lb_droplets_http_session_duration_avg/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.lb_droplets_http_session_duration_avg WHERE lb_id = '{{ lb_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/lb_droplets_queue_size/index.md b/website/docs/services/monitoring/lb_droplets_queue_size/index.md index d79ce72..17926f4 100644 --- a/website/docs/services/monitoring/lb_droplets_queue_size/index.md +++ b/website/docs/services/monitoring/lb_droplets_queue_size/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.lb_droplets_queue_size WHERE lb_id = '{{ lb_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/lb_frontend_connections_current/index.md b/website/docs/services/monitoring/lb_frontend_connections_current/index.md index be47418..34146c0 100644 --- a/website/docs/services/monitoring/lb_frontend_connections_current/index.md +++ b/website/docs/services/monitoring/lb_frontend_connections_current/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.lb_frontend_connections_current WHERE lb_id = '{{ lb_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/lb_frontend_connections_limit/index.md b/website/docs/services/monitoring/lb_frontend_connections_limit/index.md index d2bc561..d097271 100644 --- a/website/docs/services/monitoring/lb_frontend_connections_limit/index.md +++ b/website/docs/services/monitoring/lb_frontend_connections_limit/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.lb_frontend_connections_limit WHERE lb_id = '{{ lb_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/lb_frontend_cpu_utilization/index.md b/website/docs/services/monitoring/lb_frontend_cpu_utilization/index.md index 165c072..bd4ca24 100644 --- a/website/docs/services/monitoring/lb_frontend_cpu_utilization/index.md +++ b/website/docs/services/monitoring/lb_frontend_cpu_utilization/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.lb_frontend_cpu_utilization WHERE lb_id = '{{ lb_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/lb_frontend_firewall_dropped_bytes/index.md b/website/docs/services/monitoring/lb_frontend_firewall_dropped_bytes/index.md index c662ce3..95d2640 100644 --- a/website/docs/services/monitoring/lb_frontend_firewall_dropped_bytes/index.md +++ b/website/docs/services/monitoring/lb_frontend_firewall_dropped_bytes/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.lb_frontend_firewall_dropped_bytes WHERE lb_id = '{{ lb_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/lb_frontend_firewall_dropped_packets/index.md b/website/docs/services/monitoring/lb_frontend_firewall_dropped_packets/index.md index a92716c..23f538a 100644 --- a/website/docs/services/monitoring/lb_frontend_firewall_dropped_packets/index.md +++ b/website/docs/services/monitoring/lb_frontend_firewall_dropped_packets/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.lb_frontend_firewall_dropped_packets WHERE lb_id = '{{ lb_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/lb_frontend_http_requests_per_second/index.md b/website/docs/services/monitoring/lb_frontend_http_requests_per_second/index.md index 0ac7fb0..94c8bad 100644 --- a/website/docs/services/monitoring/lb_frontend_http_requests_per_second/index.md +++ b/website/docs/services/monitoring/lb_frontend_http_requests_per_second/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.lb_frontend_http_requests_per_second WHERE lb_id = '{{ lb_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/lb_frontend_http_responses/index.md b/website/docs/services/monitoring/lb_frontend_http_responses/index.md index 1a36578..ddf534b 100644 --- a/website/docs/services/monitoring/lb_frontend_http_responses/index.md +++ b/website/docs/services/monitoring/lb_frontend_http_responses/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.lb_frontend_http_responses WHERE lb_id = '{{ lb_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/lb_frontend_network_throughput_http/index.md b/website/docs/services/monitoring/lb_frontend_network_throughput_http/index.md index f2904a5..bf4ec43 100644 --- a/website/docs/services/monitoring/lb_frontend_network_throughput_http/index.md +++ b/website/docs/services/monitoring/lb_frontend_network_throughput_http/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.lb_frontend_network_throughput_http WHERE lb_id = '{{ lb_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/lb_frontend_network_throughput_tcp/index.md b/website/docs/services/monitoring/lb_frontend_network_throughput_tcp/index.md index e31a700..716831e 100644 --- a/website/docs/services/monitoring/lb_frontend_network_throughput_tcp/index.md +++ b/website/docs/services/monitoring/lb_frontend_network_throughput_tcp/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.lb_frontend_network_throughput_tcp WHERE lb_id = '{{ lb_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/lb_frontend_network_throughput_udp/index.md b/website/docs/services/monitoring/lb_frontend_network_throughput_udp/index.md index acef33d..502f175 100644 --- a/website/docs/services/monitoring/lb_frontend_network_throughput_udp/index.md +++ b/website/docs/services/monitoring/lb_frontend_network_throughput_udp/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.lb_frontend_network_throughput_udp WHERE lb_id = '{{ lb_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/lb_frontend_nlb_tcp_network_throughput/index.md b/website/docs/services/monitoring/lb_frontend_nlb_tcp_network_throughput/index.md index fe6c533..7a4c4a9 100644 --- a/website/docs/services/monitoring/lb_frontend_nlb_tcp_network_throughput/index.md +++ b/website/docs/services/monitoring/lb_frontend_nlb_tcp_network_throughput/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.lb_frontend_nlb_tcp_network_throughput WHERE lb_id = '{{ lb_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/lb_frontend_nlb_udp_network_throughput/index.md b/website/docs/services/monitoring/lb_frontend_nlb_udp_network_throughput/index.md index d9a4e29..681303a 100644 --- a/website/docs/services/monitoring/lb_frontend_nlb_udp_network_throughput/index.md +++ b/website/docs/services/monitoring/lb_frontend_nlb_udp_network_throughput/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.lb_frontend_nlb_udp_network_throughput WHERE lb_id = '{{ lb_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/lb_frontend_tls_connections_current/index.md b/website/docs/services/monitoring/lb_frontend_tls_connections_current/index.md index 4bc0a66..43bdb1f 100644 --- a/website/docs/services/monitoring/lb_frontend_tls_connections_current/index.md +++ b/website/docs/services/monitoring/lb_frontend_tls_connections_current/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.lb_frontend_tls_connections_current WHERE lb_id = '{{ lb_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/lb_frontend_tls_connections_exceeding_rate_limit/index.md b/website/docs/services/monitoring/lb_frontend_tls_connections_exceeding_rate_limit/index.md index 4fcea15..7994bb9 100644 --- a/website/docs/services/monitoring/lb_frontend_tls_connections_exceeding_rate_limit/index.md +++ b/website/docs/services/monitoring/lb_frontend_tls_connections_exceeding_rate_limit/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.lb_frontend_tls_connections_exceeding_rate_limit WHERE lb_id = '{{ lb_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/lb_frontend_tls_connections_limit/index.md b/website/docs/services/monitoring/lb_frontend_tls_connections_limit/index.md index 997499f..2785544 100644 --- a/website/docs/services/monitoring/lb_frontend_tls_connections_limit/index.md +++ b/website/docs/services/monitoring/lb_frontend_tls_connections_limit/index.md @@ -140,7 +140,8 @@ status FROM digitalocean.monitoring.lb_frontend_tls_connections_limit WHERE lb_id = '{{ lb_id }}' -- required AND start = '{{ start }}' -- required -AND end = '{{ end }}' -- required; +AND end = '{{ end }}' -- required +; ``` diff --git a/website/docs/services/monitoring/sinks/index.md b/website/docs/services/monitoring/sinks/index.md index bbe0098..9dfa98f 100644 --- a/website/docs/services/monitoring/sinks/index.md +++ b/website/docs/services/monitoring/sinks/index.md @@ -182,7 +182,8 @@ SELECT destination, resources FROM digitalocean.monitoring.sinks -WHERE sink_uuid = '{{ sink_uuid }}' -- required; +WHERE sink_uuid = '{{ sink_uuid }}' -- required +; ``` @@ -194,7 +195,8 @@ SELECT destination, resources FROM digitalocean.monitoring.sinks -WHERE resource_id = '{{ resource_id }}'; +WHERE resource_id = '{{ resource_id }}' +; ``` @@ -259,7 +261,8 @@ To delete a sink, send a DELETE request to `/v2/monitoring/sinks/${sink_uui ```sql DELETE FROM digitalocean.monitoring.sinks -WHERE sink_uuid = '{{ sink_uuid }}' --required; +WHERE sink_uuid = '{{ sink_uuid }}' --required +; ``` diff --git a/website/docs/services/network/byoip_prefix_resources/index.md b/website/docs/services/network/byoip_prefix_resources/index.md index c516ad4..bc9989f 100644 --- a/website/docs/services/network/byoip_prefix_resources/index.md +++ b/website/docs/services/network/byoip_prefix_resources/index.md @@ -158,7 +158,8 @@ resource FROM digitalocean.network.byoip_prefix_resources WHERE byoip_prefix_uuid = '{{ byoip_prefix_uuid }}' -- required AND per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` diff --git a/website/docs/services/network/byoip_prefixes/index.md b/website/docs/services/network/byoip_prefixes/index.md index 4214b6f..4b27d7c 100644 --- a/website/docs/services/network/byoip_prefixes/index.md +++ b/website/docs/services/network/byoip_prefixes/index.md @@ -282,7 +282,8 @@ status, uuid, validations FROM digitalocean.network.byoip_prefixes -WHERE byoip_prefix_uuid = '{{ byoip_prefix_uuid }}' -- required; +WHERE byoip_prefix_uuid = '{{ byoip_prefix_uuid }}' -- required +; ``` @@ -303,7 +304,8 @@ uuid, validations FROM digitalocean.network.byoip_prefixes WHERE per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` @@ -329,9 +331,9 @@ data__region, data__signature ) SELECT -'{{ prefix }}' --required, -'{{ region }}' --required, -'{{ signature }}' --required +'{{ prefix }}' /* required */, +'{{ region }}' /* required */, +'{{ signature }}' /* required */ RETURNING region, status, @@ -404,7 +406,8 @@ To delete a BYOIP prefix and remove it from your account, send a DELETE request< ```sql DELETE FROM digitalocean.network.byoip_prefixes -WHERE byoip_prefix_uuid = '{{ byoip_prefix_uuid }}' --required; +WHERE byoip_prefix_uuid = '{{ byoip_prefix_uuid }}' --required +; ``` diff --git a/website/docs/services/network/floating_ip_actions/index.md b/website/docs/services/network/floating_ip_actions/index.md index 55ef6e6..84975f2 100644 --- a/website/docs/services/network/floating_ip_actions/index.md +++ b/website/docs/services/network/floating_ip_actions/index.md @@ -154,7 +154,7 @@ The following methods are available for this resource: - floating_ip + floating_ip, type To initiate an action on a floating IP send a POST request to
`/v2/floating_ips/$FLOATING_IP/actions`. In the JSON body to the request,
set the `type` attribute to on of the supported action types:

| Action | Details
|------------|--------
| `assign` | Assigns a floating IP to a Droplet
| `unassign` | Unassign a floating IP from a Droplet
@@ -205,7 +205,8 @@ SELECT action FROM digitalocean.network.floating_ip_actions WHERE floating_ip = '{{ floating_ip }}' -- required -AND action_id = '{{ action_id }}' -- required; +AND action_id = '{{ action_id }}' -- required +; ``` @@ -224,7 +225,8 @@ started_at, status, type FROM digitalocean.network.floating_ip_actions -WHERE floating_ip = '{{ floating_ip }}' -- required; +WHERE floating_ip = '{{ floating_ip }}' -- required +; ``` @@ -244,7 +246,12 @@ To initiate an action on a floating IP send a POST request to
`/v2/floating ```sql EXEC digitalocean.network.floating_ip_actions.floating_ips_action_post -@floating_ip='{{ floating_ip }}' --required; +@floating_ip='{{ floating_ip }}' --required +@@json= +'{ +"type": "{{ type }}" +}' +; ``` diff --git a/website/docs/services/network/floating_ips/index.md b/website/docs/services/network/floating_ips/index.md index 85e2507..e03126d 100644 --- a/website/docs/services/network/floating_ips/index.md +++ b/website/docs/services/network/floating_ips/index.md @@ -154,7 +154,7 @@ The following methods are available for this resource: - + data__droplet_id On creation, a floating IP must be either assigned to a Droplet or reserved to a region.
* To create a new floating IP assigned to a Droplet, send a POST
request to `/v2/floating_ips` with the `droplet_id` attribute.

* To create a new floating IP reserved to a region, send a POST request to
`/v2/floating_ips` with the `region` attribute.

**Note**: In addition to the standard rate limiting, only 12 floating IPs may be created per 60 seconds. @@ -220,7 +220,8 @@ ip, locked, region FROM digitalocean.network.floating_ips -WHERE floating_ip = '{{ floating_ip }}' -- required; +WHERE floating_ip = '{{ floating_ip }}' -- required +; ``` @@ -236,7 +237,8 @@ locked, region FROM digitalocean.network.floating_ips WHERE per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` @@ -257,10 +259,10 @@ On creation, a floating IP must be either assigned to a Droplet or reserved to a ```sql INSERT INTO digitalocean.network.floating_ips ( - +data__droplet_id ) SELECT - +{{ droplet_id }} /* required */ RETURNING floating_ip, links @@ -273,6 +275,11 @@ links # Description fields are for documentation purposes - name: floating_ips props: + - name: droplet_id + value: integer + description: > + The ID of the Droplet that the floating IP will be assigned to. + ``` @@ -292,7 +299,8 @@ To delete a floating IP and remove it from your account, send a DELETE request diff --git a/website/docs/services/network/partner_attachment_service_keys/index.md b/website/docs/services/network/partner_attachment_service_keys/index.md index 7157333..a6c7752 100644 --- a/website/docs/services/network/partner_attachment_service_keys/index.md +++ b/website/docs/services/network/partner_attachment_service_keys/index.md @@ -141,7 +141,8 @@ created_at, state, value FROM digitalocean.network.partner_attachment_service_keys -WHERE pa_id = '{{ pa_id }}' -- required; +WHERE pa_id = '{{ pa_id }}' -- required +; ``` diff --git a/website/docs/services/network/partner_attachments/index.md b/website/docs/services/network/partner_attachments/index.md index 6232523..df8519f 100644 --- a/website/docs/services/network/partner_attachments/index.md +++ b/website/docs/services/network/partner_attachments/index.md @@ -59,7 +59,7 @@ The response will be a JSON object with details about the partner attachment
string - The name of the partner attachment. Must be unique and may only contain alphanumeric characters, dashes, and periods. (pattern: ^[a-zA-Z0-9\-\.]+$, example: env.prod-partner-network-connect) + The name of the partner attachment. Must be unique and may only contain alphanumeric characters, dashes, and periods. (pattern: ^[a-zA-Z0-9\-\.]+$, example: env.prod-partner-network-connect) @@ -130,7 +130,7 @@ The response will be a JSON object with a `partner_attachments` key
that co string - The name of the partner attachment. Must be unique and may only contain alphanumeric characters, dashes, and periods. (pattern: ^[a-zA-Z0-9\-\.]+$, example: env.prod-partner-network-connect) + The name of the partner attachment. Must be unique and may only contain alphanumeric characters, dashes, and periods. (pattern: ^[a-zA-Z0-9\-\.]+$, example: env.prod-partner-network-connect) @@ -221,7 +221,7 @@ The following methods are available for this resource: - pa_id + pa_id, data__name To update an existing partner attachment, send a `PATCH` request to
`/v2/partner_network_connect/attachments/{pa_id}` with a JSON object containing the
fields to be updated.
@@ -293,7 +293,8 @@ region, state, vpc_ids FROM digitalocean.network.partner_attachments -WHERE pa_id = '{{ pa_id }}' -- required; +WHERE pa_id = '{{ pa_id }}' -- required +; ``` @@ -315,7 +316,8 @@ state, vpc_ids FROM digitalocean.network.partner_attachments WHERE per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` @@ -346,11 +348,11 @@ data__bgp, data__redundancy_zone ) SELECT -'{{ name }}' --required, -{{ connection_bandwidth_in_mbps }} --required, -'{{ region }}' --required, -'{{ naas_provider }}' --required, -'{{ vpc_ids }}' --required, +'{{ name }}' /* required */, +{{ connection_bandwidth_in_mbps }} /* required */, +'{{ region }}' /* required */, +'{{ naas_provider }}' /* required */, +'{{ vpc_ids }}' /* required */, '{{ parent_uuid }}', '{{ bgp }}', '{{ redundancy_zone }}' @@ -425,9 +427,10 @@ To update an existing partner attachment, send a `PATCH` request to
`/v2/pa ```sql UPDATE digitalocean.network.partner_attachments SET --- No updatable properties +data__name = '{{ name }}' WHERE pa_id = '{{ pa_id }}' --required +AND data__name = '{{ name }}' --required RETURNING partner_attachment; ``` @@ -449,7 +452,8 @@ To delete an existing partner attachment, send a `DELETE` request to
`/v2/p ```sql DELETE FROM digitalocean.network.partner_attachments -WHERE pa_id = '{{ pa_id }}' --required; +WHERE pa_id = '{{ pa_id }}' --required +; ``` diff --git a/website/docs/services/network/partner_attachments_bgp_auth_key/index.md b/website/docs/services/network/partner_attachments_bgp_auth_key/index.md index f69fcb5..e374a31 100644 --- a/website/docs/services/network/partner_attachments_bgp_auth_key/index.md +++ b/website/docs/services/network/partner_attachments_bgp_auth_key/index.md @@ -134,7 +134,8 @@ created_at, state, value FROM digitalocean.network.partner_attachments_bgp_auth_key -WHERE pa_id = '{{ pa_id }}' -- required; +WHERE pa_id = '{{ pa_id }}' -- required +; ``` diff --git a/website/docs/services/network/partner_attachments_remote_routes/index.md b/website/docs/services/network/partner_attachments_remote_routes/index.md index ea8d48e..2c3400c 100644 --- a/website/docs/services/network/partner_attachments_remote_routes/index.md +++ b/website/docs/services/network/partner_attachments_remote_routes/index.md @@ -134,7 +134,8 @@ cidr FROM digitalocean.network.partner_attachments_remote_routes WHERE pa_id = '{{ pa_id }}' -- required AND per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` diff --git a/website/docs/services/oneclick/applications/index.md b/website/docs/services/oneclick/applications/index.md index 7fd5c6d..45a784c 100644 --- a/website/docs/services/oneclick/applications/index.md +++ b/website/docs/services/oneclick/applications/index.md @@ -135,7 +135,8 @@ SELECT slug, type FROM digitalocean.oneclick.applications -WHERE type = '{{ type }}'; +WHERE type = '{{ type }}' +; ``` @@ -160,8 +161,8 @@ data__addon_slugs, data__cluster_uuid ) SELECT -'{{ addon_slugs }}' --required, -'{{ cluster_uuid }}' --required +'{{ addon_slugs }}' /* required */, +'{{ cluster_uuid }}' /* required */ RETURNING message ; diff --git a/website/docs/services/projects/default_resources/index.md b/website/docs/services/projects/default_resources/index.md index e88e768..f0935b7 100644 --- a/website/docs/services/projects/default_resources/index.md +++ b/website/docs/services/projects/default_resources/index.md @@ -68,7 +68,7 @@ The response will be a JSON object with a key called `resources`.
The value string - The uniform resource name (URN) for the resource in the format do:resource_type:resource_id. (pattern: ^do:(dbaas|domain|droplet|floatingip|loadbalancer|space|volume|kubernetes|vpc):.*, example: do:droplet:13457723) + The uniform resource name (URN) for the resource in the format do:resource_type:resource_id. (pattern: ^do:(dbaas|domain|droplet|floatingip|loadbalancer|space|volume|kubernetes|vpc):.*, example: do:droplet:13457723) @@ -141,7 +141,8 @@ assigned_at, links, status, urn -FROM digitalocean.projects.default_resources; +FROM digitalocean.projects.default_resources +; ``` diff --git a/website/docs/services/projects/defaults/index.md b/website/docs/services/projects/defaults/index.md index d531a75..35f9873 100644 --- a/website/docs/services/projects/defaults/index.md +++ b/website/docs/services/projects/defaults/index.md @@ -184,7 +184,8 @@ is_default, owner_uuid, purpose, updated_at -FROM digitalocean.projects.defaults; +FROM digitalocean.projects.defaults +; ``` @@ -210,8 +211,6 @@ data__description = '{{ description }}', data__purpose = '{{ purpose }}', data__environment = '{{ environment }}', data__is_default = {{ is_default }} -WHERE - RETURNING project; ``` diff --git a/website/docs/services/projects/projects/index.md b/website/docs/services/projects/projects/index.md index 4720c64..c7aaa1c 100644 --- a/website/docs/services/projects/projects/index.md +++ b/website/docs/services/projects/projects/index.md @@ -289,7 +289,8 @@ owner_uuid, purpose, updated_at FROM digitalocean.projects.projects -WHERE project_id = '{{ project_id }}' -- required; +WHERE project_id = '{{ project_id }}' -- required +; ``` @@ -310,7 +311,8 @@ purpose, updated_at FROM digitalocean.projects.projects WHERE per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` @@ -337,9 +339,9 @@ data__purpose, data__environment ) SELECT -'{{ name }}' --required, +'{{ name }}' /* required */, '{{ description }}', -'{{ purpose }}' --required, +'{{ purpose }}' /* required */, '{{ environment }}' RETURNING project @@ -469,7 +471,8 @@ To delete a project, send a DELETE request to `/v2/projects/$PROJECT_ID`. To
diff --git a/website/docs/services/projects/resources/index.md b/website/docs/services/projects/resources/index.md index a93418a..3ecebfa 100644 --- a/website/docs/services/projects/resources/index.md +++ b/website/docs/services/projects/resources/index.md @@ -68,7 +68,7 @@ The response will be a JSON object with a key called `resources`.
The value string - The uniform resource name (URN) for the resource in the format do:resource_type:resource_id. (pattern: ^do:(dbaas|domain|droplet|floatingip|loadbalancer|space|volume|kubernetes|vpc):.*, example: do:droplet:13457723) + The uniform resource name (URN) for the resource in the format do:resource_type:resource_id. (pattern: ^do:(dbaas|domain|droplet|floatingip|loadbalancer|space|volume|kubernetes|vpc):.*, example: do:droplet:13457723) @@ -159,7 +159,8 @@ urn FROM digitalocean.projects.resources WHERE project_id = '{{ project_id }}' -- required AND per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` diff --git a/website/docs/services/serverless/namespaces/index.md b/website/docs/services/serverless/namespaces/index.md index 3a32c43..3426399 100644 --- a/website/docs/services/serverless/namespaces/index.md +++ b/website/docs/services/serverless/namespaces/index.md @@ -243,7 +243,8 @@ region, updated_at, uuid FROM digitalocean.serverless.namespaces -WHERE namespace_id = '{{ namespace_id }}' -- required; +WHERE namespace_id = '{{ namespace_id }}' -- required +; ``` @@ -260,7 +261,8 @@ namespace, region, updated_at, uuid -FROM digitalocean.serverless.namespaces; +FROM digitalocean.serverless.namespaces +; ``` @@ -285,8 +287,8 @@ data__region, data__label ) SELECT -'{{ region }}' --required, -'{{ label }}' --required +'{{ region }}' /* required */, +'{{ label }}' /* required */ RETURNING namespace ; @@ -327,7 +329,8 @@ Deletes the given namespace. When a namespace is deleted all assets, in the nam ```sql DELETE FROM digitalocean.serverless.namespaces -WHERE namespace_id = '{{ namespace_id }}' --required; +WHERE namespace_id = '{{ namespace_id }}' --required +; ``` diff --git a/website/docs/services/serverless/triggers/index.md b/website/docs/services/serverless/triggers/index.md index 070ab03..93b439f 100644 --- a/website/docs/services/serverless/triggers/index.md +++ b/website/docs/services/serverless/triggers/index.md @@ -267,7 +267,8 @@ type, updated_at FROM digitalocean.serverless.triggers WHERE namespace_id = '{{ namespace_id }}' -- required -AND trigger_name = '{{ trigger_name }}' -- required; +AND trigger_name = '{{ trigger_name }}' -- required +; ``` @@ -286,7 +287,8 @@ scheduled_runs, type, updated_at FROM digitalocean.serverless.triggers -WHERE namespace_id = '{{ namespace_id }}' -- required; +WHERE namespace_id = '{{ namespace_id }}' -- required +; ``` @@ -315,11 +317,11 @@ data__scheduled_details, namespace_id ) SELECT -'{{ name }}' --required, -'{{ function }}' --required, -'{{ type }}' --required, -{{ is_enabled }} --required, -'{{ scheduled_details }}' --required, +'{{ name }}' /* required */, +'{{ function }}' /* required */, +'{{ type }}' /* required */, +{{ is_enabled }} /* required */, +'{{ scheduled_details }}' /* required */, '{{ namespace_id }}' RETURNING trigger @@ -407,7 +409,8 @@ Deletes the given trigger.
To delete trigger, send a DELETE request to `/v2 ```sql DELETE FROM digitalocean.serverless.triggers WHERE namespace_id = '{{ namespace_id }}' --required -AND trigger_name = '{{ trigger_name }}' --required; +AND trigger_name = '{{ trigger_name }}' --required +; ``` diff --git a/website/docs/services/spaces/keys/index.md b/website/docs/services/spaces/keys/index.md index 03922cc..0035e41 100644 --- a/website/docs/services/spaces/keys/index.md +++ b/website/docs/services/spaces/keys/index.md @@ -248,7 +248,8 @@ access_key, created_at, grants FROM digitalocean.spaces.keys -WHERE access_key = '{{ access_key }}' -- required; +WHERE access_key = '{{ access_key }}' -- required +; ``` @@ -268,7 +269,8 @@ AND sort = '{{ sort }}' AND sort_direction = '{{ sort_direction }}' AND name = '{{ name }}' AND bucket = '{{ bucket }}' -AND permission = '{{ permission }}'; +AND permission = '{{ permission }}' +; ``` @@ -388,7 +390,8 @@ To delete a Spaces Access Key, send a DELETE request to `/v2/spaces/keys/$ACCESS ```sql DELETE FROM digitalocean.spaces.keys -WHERE access_key = '{{ access_key }}' --required; +WHERE access_key = '{{ access_key }}' --required +; ``` diff --git a/website/docs/services/vpcs/members/index.md b/website/docs/services/vpcs/members/index.md index 942cc3b..5c40c3c 100644 --- a/website/docs/services/vpcs/members/index.md +++ b/website/docs/services/vpcs/members/index.md @@ -63,7 +63,7 @@ The response will be a JSON object with a key called members. This will be set string - The uniform resource name (URN) for the resource in the format do:resource_type:resource_id. (pattern: ^do:(dbaas|domain|droplet|floatingip|loadbalancer|space|volume|kubernetes|vpc):.*, example: do:droplet:13457723) + The uniform resource name (URN) for the resource in the format do:resource_type:resource_id. (pattern: ^do:(dbaas|domain|droplet|floatingip|loadbalancer|space|volume|kubernetes|vpc):.*, example: do:droplet:13457723) @@ -152,7 +152,8 @@ FROM digitalocean.vpcs.members WHERE vpc_id = '{{ vpc_id }}' -- required AND resource_type = '{{ resource_type }}' AND per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` diff --git a/website/docs/services/vpcs/peerings/index.md b/website/docs/services/vpcs/peerings/index.md index 1b68083..3703953 100644 --- a/website/docs/services/vpcs/peerings/index.md +++ b/website/docs/services/vpcs/peerings/index.md @@ -58,7 +58,7 @@ The response will be a JSON object with a key called `peerings`. This will be s string - The name of the VPC peering. Must be unique within the team and may only contain alphanumeric characters and dashes. (pattern: ^[a-zA-Z0-9\-]+$, example: nyc1-blr1-peering) + The name of the VPC peering. Must be unique within the team and may only contain alphanumeric characters and dashes. (pattern: ^[a-zA-Z0-9\-]+$, example: nyc1-blr1-peering) @@ -177,7 +177,8 @@ vpc_ids FROM digitalocean.vpcs.peerings WHERE vpc_id = '{{ vpc_id }}' -- required AND per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` @@ -203,8 +204,8 @@ data__vpc_id, vpc_id ) SELECT -'{{ name }}' --required, -'{{ vpc_id }}' --required, +'{{ name }}' /* required */, +'{{ vpc_id }}' /* required */, '{{ vpc_id }}' RETURNING peering diff --git a/website/docs/services/vpcs/vpc_peerings/index.md b/website/docs/services/vpcs/vpc_peerings/index.md index 4d0224c..b947944 100644 --- a/website/docs/services/vpcs/vpc_peerings/index.md +++ b/website/docs/services/vpcs/vpc_peerings/index.md @@ -59,7 +59,7 @@ The response will be a JSON object with a key called `vpc_peering`. The value of string - The name of the VPC peering. Must be unique within the team and may only contain alphanumeric characters and dashes. (pattern: ^[a-zA-Z0-9\-]+$, example: nyc1-blr1-peering) + The name of the VPC peering. Must be unique within the team and may only contain alphanumeric characters and dashes. (pattern: ^[a-zA-Z0-9\-]+$, example: nyc1-blr1-peering) @@ -100,7 +100,7 @@ The response will be a JSON object with a key called `vpc_peerings`. This will string - The name of the VPC peering. Must be unique within the team and may only contain alphanumeric characters and dashes. (pattern: ^[a-zA-Z0-9\-]+$, example: nyc1-blr1-peering) + The name of the VPC peering. Must be unique within the team and may only contain alphanumeric characters and dashes. (pattern: ^[a-zA-Z0-9\-]+$, example: nyc1-blr1-peering) @@ -232,7 +232,8 @@ created_at, status, vpc_ids FROM digitalocean.vpcs.vpc_peerings -WHERE vpc_peering_id = '{{ vpc_peering_id }}' -- required; +WHERE vpc_peering_id = '{{ vpc_peering_id }}' -- required +; ``` @@ -249,7 +250,8 @@ vpc_ids FROM digitalocean.vpcs.vpc_peerings WHERE per_page = '{{ per_page }}' AND page = '{{ page }}' -AND region = '{{ region }}'; +AND region = '{{ region }}' +; ``` @@ -274,8 +276,8 @@ data__name, data__vpc_ids ) SELECT -'{{ name }}' --required, -'{{ vpc_ids }}' --required +'{{ name }}' /* required */, +'{{ vpc_ids }}' /* required */ RETURNING vpc_peering ; @@ -342,7 +344,8 @@ To delete a VPC peering, send a DELETE request to `/v2/vpc_peerings/$VPC_PEERING ```sql DELETE FROM digitalocean.vpcs.vpc_peerings -WHERE vpc_peering_id = '{{ vpc_peering_id }}' --required; +WHERE vpc_peering_id = '{{ vpc_peering_id }}' --required +; ``` diff --git a/website/docs/services/vpcs/vpcs/index.md b/website/docs/services/vpcs/vpcs/index.md index 3ac89cc..8844d55 100644 --- a/website/docs/services/vpcs/vpcs/index.md +++ b/website/docs/services/vpcs/vpcs/index.md @@ -59,7 +59,7 @@ The response will be a JSON object with a key called `vpc`. The value of this wi string - The name of the VPC. Must be unique and may only contain alphanumeric characters, dashes, and periods. (pattern: ^[a-zA-Z0-9\-\.]+$, example: env.prod-vpc) + The name of the VPC. Must be unique and may only contain alphanumeric characters, dashes, and periods. (pattern: ^[a-zA-Z0-9\-\.]+$, example: env.prod-vpc) @@ -89,7 +89,7 @@ The response will be a JSON object with a key called `vpc`. The value of this wi string - The uniform resource name (URN) for the resource in the format do:resource_type:resource_id. (pattern: ^do:(dbaas|domain|droplet|floatingip|loadbalancer|space|volume|kubernetes|vpc):.*, example: do:droplet:13457723) + The uniform resource name (URN) for the resource in the format do:resource_type:resource_id. (pattern: ^do:(dbaas|domain|droplet|floatingip|loadbalancer|space|volume|kubernetes|vpc):.*, example: do:droplet:13457723) @@ -115,7 +115,7 @@ The response will be a JSON object with a key called `vpcs`. This will be set to string - The name of the VPC. Must be unique and may only contain alphanumeric characters, dashes, and periods. (pattern: ^[a-zA-Z0-9\-\.]+$, example: env.prod-vpc) + The name of the VPC. Must be unique and may only contain alphanumeric characters, dashes, and periods. (pattern: ^[a-zA-Z0-9\-\.]+$, example: env.prod-vpc) @@ -145,7 +145,7 @@ The response will be a JSON object with a key called `vpcs`. This will be set to string - The uniform resource name (URN) for the resource in the format do:resource_type:resource_id. (pattern: ^do:(dbaas|domain|droplet|floatingip|loadbalancer|space|volume|kubernetes|vpc):.*, example: do:droplet:13457723) + The uniform resource name (URN) for the resource in the format do:resource_type:resource_id. (pattern: ^do:(dbaas|domain|droplet|floatingip|loadbalancer|space|volume|kubernetes|vpc):.*, example: do:droplet:13457723) @@ -267,7 +267,8 @@ ip_range, region, urn FROM digitalocean.vpcs.vpcs -WHERE vpc_id = '{{ vpc_id }}' -- required; +WHERE vpc_id = '{{ vpc_id }}' -- required +; ``` @@ -286,7 +287,8 @@ region, urn FROM digitalocean.vpcs.vpcs WHERE per_page = '{{ per_page }}' -AND page = '{{ page }}'; +AND page = '{{ page }}' +; ``` @@ -313,9 +315,9 @@ data__region, data__ip_range ) SELECT -'{{ name }}' --required, +'{{ name }}' /* required */, '{{ description }}', -'{{ region }}' --required, +'{{ region }}' /* required */, '{{ ip_range }}' RETURNING vpc @@ -422,7 +424,8 @@ To delete a VPC, send a DELETE request to `/v2/vpcs/$VPC_ID`. A 204 status
```sql DELETE FROM digitalocean.vpcs.vpcs -WHERE vpc_id = '{{ vpc_id }}' --required; +WHERE vpc_id = '{{ vpc_id }}' --required +; ```