From afe4af752ea5d8fa13ace04181fd598986da6c16 Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Fri, 12 Sep 2025 16:52:39 +1000 Subject: [PATCH] doc updates --- package-lock.json | 8 +- package.json | 2 +- .../docs/services/database/backups/index.md | 24 ++- .../docs/services/database/databases/index.md | 8 +- .../services/deployment/app_logs/index.md | 3 +- .../services/deployment/build_logs/index.md | 3 +- .../services/deployment/deployments/index.md | 165 ++++++++---------- .../docs/services/deployment/domains/index.md | 3 +- .../services/domain/certificates/index.md | 6 +- website/docs/services/domain/domains/index.md | 17 +- .../services/organization/analytics/index.md | 3 +- .../organization/organizations/index.md | 3 +- .../docs/services/project/analytics/index.md | 3 +- .../docs/services/project/projects/index.md | 19 +- 14 files changed, 135 insertions(+), 132 deletions(-) diff --git a/package-lock.json b/package-lock.json index 2c10128..b446e09 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.4" + "@stackql/provider-utils": "^0.4.9" }, "engines": { "node": ">=14.16.0" @@ -110,9 +110,9 @@ } }, "node_modules/@stackql/provider-utils": { - "version": "0.4.4", - "resolved": "https://registry.npmjs.org/@stackql/provider-utils/-/provider-utils-0.4.4.tgz", - "integrity": "sha512-ZRU1qklveVZRDhMjx00zn1S64Ol5dWa0ZtQJ4p76fjnjGQAlQfxcCNzPXr07jqOvJbDQuqG8kkFnx4+B9tcpPA==", + "version": "0.4.9", + "resolved": "https://registry.npmjs.org/@stackql/provider-utils/-/provider-utils-0.4.9.tgz", + "integrity": "sha512-htO+VhdD6GbfP0fqHyuqbnSqNA/F+aBUTGXeepMDEzsaRLVkxxa/xUPBR65iaVgNF6icxlsM+dH5XpNWSJtHog==", "license": "MIT", "dependencies": { "@apidevtools/swagger-parser": "^10.1.1", diff --git a/package.json b/package.json index 97e9621..a128d54 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.9" }, "keywords": [ "stackql", diff --git a/website/docs/services/database/backups/index.md b/website/docs/services/database/backups/index.md index d666b77..da68e37 100644 --- a/website/docs/services/database/backups/index.md +++ b/website/docs/services/database/backups/index.md @@ -120,7 +120,7 @@ The following methods are available for this resource: - databaseId + databaseId, endpoint, bucketName, bucketRegion, accessKeyId, secretAccessKey, kind This API allows you to enable a backup for a KV database. The backup can be
stored in your S3 bucket.

Currently, only one backup can be enabled per database. When a second backup
is being configured, the API will return a `409 Conflict` error. @@ -178,7 +178,8 @@ SELECT id, status FROM deno.database.backups -WHERE databaseId = '{{ databaseId }}' -- required; +WHERE databaseId = '{{ databaseId }}' -- required +; ``` @@ -190,7 +191,8 @@ SELECT id, status FROM deno.database.backups -WHERE databaseBackupId = '{{ databaseBackupId }}' -- required; +WHERE databaseBackupId = '{{ databaseBackupId }}' -- required +; ``` @@ -211,7 +213,18 @@ This API allows you to enable a backup for a KV database. The backup can be
@@ -220,7 +233,8 @@ This API allows you to disable a backup for a KV database. ```sql EXEC deno.database.backups.disable_kv_backup -@databaseBackupId='{{ databaseBackupId }}' --required; +@databaseBackupId='{{ databaseBackupId }}' --required +; ``` diff --git a/website/docs/services/database/databases/index.md b/website/docs/services/database/databases/index.md index f945b7f..684984c 100644 --- a/website/docs/services/database/databases/index.md +++ b/website/docs/services/database/databases/index.md @@ -193,7 +193,8 @@ AND page = '{{ page }}' AND limit = '{{ limit }}' AND q = '{{ q }}' AND sort = '{{ sort }}' -AND order = '{{ order }}'; +AND order = '{{ order }}' +; ``` @@ -240,10 +241,9 @@ updatedAt description: Required parameter for the databases resource. - name: description value: string - description: > + description: | The description of the KV database. If this is `null`, an empty string -will be set. - + will be set. ``` diff --git a/website/docs/services/deployment/app_logs/index.md b/website/docs/services/deployment/app_logs/index.md index ddc138d..63afae2 100644 --- a/website/docs/services/deployment/app_logs/index.md +++ b/website/docs/services/deployment/app_logs/index.md @@ -192,7 +192,8 @@ AND until = '{{ until }}' AND limit = '{{ limit }}' AND sort = '{{ sort }}' AND order = '{{ order }}' -AND cursor = '{{ cursor }}'; +AND cursor = '{{ cursor }}' +; ``` diff --git a/website/docs/services/deployment/build_logs/index.md b/website/docs/services/deployment/build_logs/index.md index 9c1b455..065563f 100644 --- a/website/docs/services/deployment/build_logs/index.md +++ b/website/docs/services/deployment/build_logs/index.md @@ -126,7 +126,8 @@ SELECT level, message FROM deno.deployment.build_logs -WHERE deploymentId = '{{ deploymentId }}' -- required; +WHERE deploymentId = '{{ deploymentId }}' -- required +; ``` diff --git a/website/docs/services/deployment/deployments/index.md b/website/docs/services/deployment/deployments/index.md index 33b8103..9e7531c 100644 --- a/website/docs/services/deployment/deployments/index.md +++ b/website/docs/services/deployment/deployments/index.md @@ -303,7 +303,8 @@ AND page = '{{ page }}' AND limit = '{{ limit }}' AND q = '{{ q }}' AND sort = '{{ sort }}' -AND order = '{{ order }}'; +AND order = '{{ order }}' +; ``` @@ -323,7 +324,8 @@ requestTimeout, status, updatedAt FROM deno.deployment.deployments -WHERE deploymentId = '{{ deploymentId }}' -- required; +WHERE deploymentId = '{{ deploymentId }}' -- required +; ``` @@ -359,13 +361,13 @@ data__enableCron, projectId ) SELECT -'{{ entryPointUrl }}' --required, +'{{ entryPointUrl }}' /* required */, '{{ importMapUrl }}', '{{ lockFileUrl }}', '{{ compilerOptions }}', -'{{ assets }}' --required, +'{{ assets }}' /* required */, '{{ domains }}', -'{{ envVars }}' --required, +'{{ envVars }}' /* required */, '{{ databases }}', {{ requestTimeout }}, '{{ permissions }}', @@ -397,128 +399,99 @@ updatedAt description: Required parameter for the deployments resource. - name: entryPointUrl value: string - description: > + description: | An URL of the entry point of the application. -This is the file that will be executed when the deployment is invoked. - + This is the file that will be executed when the deployment is invoked. - name: importMapUrl value: string - description: > + description: | An URL of the import map file. - -If `null` is given, import map auto-discovery logic will be performed, -where it looks for Deno's config file (i.e. `deno.json` or `deno.jsonc`) -which may contain an embedded import map or a path to an import map file. -If found, that import map will be used. - -If an empty string is given, no import map will be used. - + If `null` is given, import map auto-discovery logic will be performed, + where it looks for Deno's config file (i.e. `deno.json` or `deno.jsonc`) + which may contain an embedded import map or a path to an import map file. + If found, that import map will be used. + If an empty string is given, no import map will be used. - name: lockFileUrl value: string - description: > + description: | An URL of the lock file. - -If `null` is given, lock file auto-discovery logic will be performed, -where it looks for Deno's config file (i.e. `deno.json` or `deno.jsonc`) -which may contain a path to a lock file or boolean value, such as `"lock": -false` or `"lock": "my-lock.lock"`. If a config file is found, the -semantics of the lock field is the same as the Deno CLI, so refer to [the -CLI doc page](https://docs.deno.com/runtime/manual/basics/modules/integrity_checking#auto-generated-lockfile). - -If an empty string is given, no lock file will be used. - + If `null` is given, lock file auto-discovery logic will be performed, + where it looks for Deno's config file (i.e. `deno.json` or `deno.jsonc`) + which may contain a path to a lock file or boolean value, such as `"lock": + false` or `"lock": "my-lock.lock"`. If a config file is found, the + semantics of the lock field is the same as the Deno CLI, so refer to [the + CLI doc page](https://docs.deno.com/runtime/manual/basics/modules/integrity_checking#auto-generated-lockfile). + If an empty string is given, no lock file will be used. - name: compilerOptions value: object - description: > + description: | Compiler options to be used when building the deployment. - -If `null` is given, Deno's config file (i.e. `deno.json` or `deno.jsonc`) -will be auto-discovered, which may contain a `compilerOptions` field. If -found, that compiler options will be applied. - -If an empty object `{}` is given, [the default compiler options](https://docs.deno.com/runtime/manual/advanced/typescript/configuration#how-deno-uses-a-configuration-file) -will be applied. - + If `null` is given, Deno's config file (i.e. `deno.json` or `deno.jsonc`) + will be auto-discovered, which may contain a `compilerOptions` field. If + found, that compiler options will be applied. + If an empty object `{}` is given, [the default compiler options](https://docs.deno.com/runtime/manual/advanced/typescript/configuration#how-deno-uses-a-configuration-file) + will be applied. - name: assets value: object - description: > + description: | A map whose key represents a file path, and the value is an asset that -composes the deployment. - -Each asset is one of the following three kinds: - -1. A file with content data (which is UTF-8 for text, or base64 for binary) -2. A file with a git sha1 hash of the content -3. A symbolic link to another asset - -Assets that were uploaded in some of the previous deployments don't need to -be uploaded again. In this case, in order to identify the asset, just provide the -git SHA-1 hash of the content (use `git hash-object -t 'blob' ` command to generate). - + composes the deployment. + Each asset is one of the following three kinds: + 1. A file with content data (which is UTF-8 for text, or base64 for binary) + 2. A file with a git sha1 hash of the content + 3. A symbolic link to another asset + Assets that were uploaded in some of the previous deployments don't need to + be uploaded again. In this case, in order to identify the asset, just provide the + git SHA-1 hash of the content (use `git hash-object -t 'blob' ` command to generate). - name: domains value: array - description: > + description: | A list of domains that will be attached to the deployment once it's -successfully deployed. - -If this field is omitted or `null` is provided, the default domain will be -attached to the deployment, which looks like `projectname-deploymentid.deno.dev`. - -If an empty list is provided, no domain will be attached to the deployment. -In this case, the default one will not get attached either. - -If a list is provided, only the domains in the list will be attached, but -the default domain will not. - + successfully deployed. + If this field is omitted or `null` is provided, the default domain will be + attached to the deployment, which looks like `projectname-deploymentid.deno.dev`. + If an empty list is provided, no domain will be attached to the deployment. + In this case, the default one will not get attached either. + If a list is provided, only the domains in the list will be attached, but + the default domain will not. - name: envVars value: object - description: > + description: | A dictionary of environment variables to be set in the runtime environment -of the deployment. - + of the deployment. - name: databases value: object - description: > + description: | KV database ID mappings to associate with the deployment. - -A key represents a KV database name (e.g. `"default"`), and a value is a -KV database ID. - -Currently, only `"default"` database is supported. If any other database -name is specified, that will be rejected. - -If not provided, the deployment will be created with no KV database -attached. - + A key represents a KV database name (e.g. `"default"`), and a value is a + KV database ID. + Currently, only `"default"` database is supported. If any other database + name is specified, that will be rejected. + If not provided, the deployment will be created with no KV database + attached. - name: requestTimeout value: integer - description: > + description: | The wall-clock timeout in milliseconds for requests to the deployment. - -If not provided, the system default value will be used. - + If not provided, the system default value will be used. - name: permissions value: object - description: > + description: | Permissions to be set for the deployment. - -Currently only `net` is supported, where you can specify a list of IP -addresses and/or hostnames that the deployment is allowed to make outbound -network requests to. - + Currently only `net` is supported, where you can specify a list of IP + addresses and/or hostnames that the deployment is allowed to make outbound + network requests to. - name: description value: string - description: > + description: | A description of the created deployment. If not provided, an empty string -will be set. - + will be set. - name: enableCron value: boolean - description: > + description: | Enables cron functionality for this deployment. Requires a database to be attached. -When multiple projects share the same database, only the first project to enable crons -will have access to cron management. Other projects sharing the database cannot use crons. - + When multiple projects share the same database, only the first project to enable crons + will have access to cron management. Other projects sharing the database cannot use crons. ``` @@ -538,7 +511,8 @@ No description available. ```sql DELETE FROM deno.deployment.deployments -WHERE deploymentId = '{{ deploymentId }}' --required; +WHERE deploymentId = '{{ deploymentId }}' --required +; ``` @@ -566,7 +540,8 @@ EXEC deno.deployment.deployments.redeploy_deployment "requestTimeout": {{ requestTimeout }}, "permissions": "{{ permissions }}", "description": "{{ description }}" -}'; +}' +; ``` diff --git a/website/docs/services/deployment/domains/index.md b/website/docs/services/deployment/domains/index.md index 23f6bd1..4648e93 100644 --- a/website/docs/services/deployment/domains/index.md +++ b/website/docs/services/deployment/domains/index.md @@ -133,7 +133,8 @@ This API disassociates a domain from a deployment. Once this operation is
c ```sql DELETE FROM deno.deployment.domains WHERE deploymentId = '{{ deploymentId }}' --required -AND domain = '{{ domain }}' --required; +AND domain = '{{ domain }}' --required +; ``` diff --git a/website/docs/services/domain/certificates/index.md b/website/docs/services/domain/certificates/index.md index 2965031..6e4ba13 100644 --- a/website/docs/services/domain/certificates/index.md +++ b/website/docs/services/domain/certificates/index.md @@ -107,7 +107,8 @@ EXEC deno.domain.certificates.add_domain_certificate '{ "privateKey": "{{ privateKey }}", "certificateChain": "{{ certificateChain }}" -}'; +}' +; ``` @@ -116,7 +117,8 @@ This API begins the provisioning of TLS certificates for a domain.

No ```sql EXEC deno.domain.certificates.provision_domain_certificates -@domainId='{{ domainId }}' --required; +@domainId='{{ domainId }}' --required +; ``` diff --git a/website/docs/services/domain/domains/index.md b/website/docs/services/domain/domains/index.md index c4d524a..9c8db65 100644 --- a/website/docs/services/domain/domains/index.md +++ b/website/docs/services/domain/domains/index.md @@ -332,7 +332,8 @@ AND page = '{{ page }}' AND limit = '{{ limit }}' AND q = '{{ q }}' AND sort = '{{ sort }}' -AND order = '{{ order }}'; +AND order = '{{ order }}' +; ``` @@ -354,7 +355,8 @@ provisioningStatus, token, updatedAt FROM deno.domain.domains -WHERE domainId = '{{ domainId }}' -- required; +WHERE domainId = '{{ domainId }}' -- required +; ``` @@ -379,7 +381,7 @@ data__domain, organizationId ) SELECT -'{{ domain }}' --required, +'{{ domain }}' /* required */, '{{ organizationId }}' RETURNING id, @@ -427,7 +429,8 @@ No description available. ```sql DELETE FROM deno.domain.domains -WHERE domainId = '{{ domainId }}' --required; +WHERE domainId = '{{ domainId }}' --required +; ``` @@ -452,7 +455,8 @@ EXEC deno.domain.domains.update_domain_association @@json= '{ "deploymentId": "{{ deploymentId }}" -}'; +}' +; ``` @@ -461,7 +465,8 @@ This API triggers the ownership verification of a domain. It should be
call ```sql EXEC deno.domain.domains.verify_domain -@domainId='{{ domainId }}' --required; +@domainId='{{ domainId }}' --required +; ``` diff --git a/website/docs/services/organization/analytics/index.md b/website/docs/services/organization/analytics/index.md index 0e68aea..a84c8e4 100644 --- a/website/docs/services/organization/analytics/index.md +++ b/website/docs/services/organization/analytics/index.md @@ -138,7 +138,8 @@ values FROM deno.organization.analytics WHERE organizationId = '{{ organizationId }}' -- required AND since = '{{ since }}' -- required -AND until = '{{ until }}' -- required; +AND until = '{{ until }}' -- required +; ``` diff --git a/website/docs/services/organization/organizations/index.md b/website/docs/services/organization/organizations/index.md index 598e116..7b7329e 100644 --- a/website/docs/services/organization/organizations/index.md +++ b/website/docs/services/organization/organizations/index.md @@ -138,7 +138,8 @@ name, createdAt, updatedAt FROM deno.organization.organizations -WHERE organizationId = '{{ organizationId }}' -- required; +WHERE organizationId = '{{ organizationId }}' -- required +; ``` diff --git a/website/docs/services/project/analytics/index.md b/website/docs/services/project/analytics/index.md index 6b1726e..c719e15 100644 --- a/website/docs/services/project/analytics/index.md +++ b/website/docs/services/project/analytics/index.md @@ -138,7 +138,8 @@ values FROM deno.project.analytics WHERE projectId = '{{ projectId }}' -- required AND since = '{{ since }}' -- required -AND until = '{{ until }}' -- required; +AND until = '{{ until }}' -- required +; ``` diff --git a/website/docs/services/project/projects/index.md b/website/docs/services/project/projects/index.md index dc81ab7..f50c7c6 100644 --- a/website/docs/services/project/projects/index.md +++ b/website/docs/services/project/projects/index.md @@ -248,7 +248,8 @@ AND page = '{{ page }}' AND limit = '{{ limit }}' AND q = '{{ q }}' AND sort = '{{ sort }}' -AND order = '{{ order }}'; +AND order = '{{ order }}' +; ``` @@ -263,7 +264,8 @@ createdAt, description, updatedAt FROM deno.project.projects -WHERE projectId = '{{ projectId }}' -- required; +WHERE projectId = '{{ projectId }}' -- required +; ``` @@ -312,16 +314,14 @@ updatedAt description: Required parameter for the projects resource. - name: name value: string - description: > + description: | The name of the project. This must be globally unique. If this is `null`, -a random unique name will be generated. - + a random unique name will be generated. - name: description value: string - description: > + description: | The description of the project. If this is `null`, an empty string will be -set. - + set. ``` @@ -371,7 +371,8 @@ No description available. ```sql DELETE FROM deno.project.projects -WHERE projectId = '{{ projectId }}' --required; +WHERE projectId = '{{ projectId }}' --required +; ```