diff --git a/cypress.config.ts b/cypress.config.ts index 5596210ce..a2e9147af 100644 --- a/cypress.config.ts +++ b/cypress.config.ts @@ -17,5 +17,6 @@ export default defineConfig({ }, }) }, + experimentalMemoryManagement: true, }, }) diff --git a/cypress/e2e/broken-links.cy.ts b/cypress/e2e/broken-links.cy.ts index b4138c0ff..ea49051b6 100644 --- a/cypress/e2e/broken-links.cy.ts +++ b/cypress/e2e/broken-links.cy.ts @@ -31,6 +31,14 @@ const IGNORED_URLS = [ 'https://portal.azure.com', ] +const rootBaseUrl = Cypress.config('baseUrl') + +const isInternalUrl = (url: string) => { + // check against the base url + // and check if the url does not contain a file extension + return url.startsWith(rootBaseUrl) && !url.includes('.') +} + const isExternalUrl = (url: string) => { return !url.includes('localhost') } @@ -67,14 +75,11 @@ describe('Broken links test suite', () => { links .filter((_i, link) => { + const href = link.getAttribute('href') + const src = link.getAttribute('src') + return !IGNORED_URLS.some( - (l) => - //@ts-ignore - (link.getAttribute('href') && - link.getAttribute('href')?.includes(l)) || - //@ts-ignore - (link.getAttribute('src') && - link.getAttribute('src').includes(l)), + (l) => href?.includes(l) || src?.includes(l), ) }) .each((link) => { @@ -87,6 +92,25 @@ describe('Broken links test suite', () => { cy.log(`link already checked`) expect(VISITED_SUCCESSFUL_LINKS[url]).to.be.true } else { + // if the link is internal then check the link against the pages fixture (sitemap) + if (isInternalUrl(url)) { + // clean the url by removing the base url and query params + const rootBaseUrlRegex = new RegExp(`^${rootBaseUrl}`) + let cleanUrl = url.replace(rootBaseUrlRegex, '') + const queryIndex = cleanUrl.indexOf('?') + cleanUrl = + queryIndex !== -1 ? cleanUrl.slice(0, queryIndex) : cleanUrl + + cy.log(`checking internal link: ${cleanUrl}`) + if (!pages.includes(cleanUrl)) { + assert.fail(`${cleanUrl} is not part of the pages fixture`) + } else { + VISITED_SUCCESSFUL_LINKS[url] = true + } + + return + } + cy.wait(25) req(url).then((res: Cypress.Response) => { diff --git a/docs/reference/dart/api/api-all.mdx b/docs/reference/dart/api/api-all.mdx index 38a9470b2..b4e758719 100644 --- a/docs/reference/dart/api/api-all.mdx +++ b/docs/reference/dart/api/api-all.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Register a single handler fo # Dart - api.all() + + This is reference documentation for the Nitric Dart SDK. To learn about APIs + in Nitric start with the [API docs](/apis). + + Register a single handler for all HTTP Methods (GET, POST, PUT, DELETE, PATCH) on a route. diff --git a/docs/reference/dart/api/api-delete.mdx b/docs/reference/dart/api/api-delete.mdx index 87ecd56ce..9bbab0bf7 100644 --- a/docs/reference/dart/api/api-delete.mdx +++ b/docs/reference/dart/api/api-delete.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Register an API route and se # Dart - api.delete() + + This is reference documentation for the Nitric Dart SDK. To learn about APIs + in Nitric start with the [API docs](/apis). + + Register an API route and set a specific HTTP DELETE handler on that route. diff --git a/docs/reference/dart/api/api-get.mdx b/docs/reference/dart/api/api-get.mdx index a9c919e78..f93b35ffc 100644 --- a/docs/reference/dart/api/api-get.mdx +++ b/docs/reference/dart/api/api-get.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Register an API route and se # Dart - api.get() + + This is reference documentation for the Nitric Dart SDK. To learn about APIs + in Nitric start with the [API docs](/apis). + + Register an API route and set a specific HTTP GET handler on that route. diff --git a/docs/reference/dart/api/api-patch.mdx b/docs/reference/dart/api/api-patch.mdx index a85c56215..21050f942 100644 --- a/docs/reference/dart/api/api-patch.mdx +++ b/docs/reference/dart/api/api-patch.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Register an API route and se # Dart - api.patch() + + This is reference documentation for the Nitric Dart SDK. To learn about APIs + in Nitric start with the [API docs](/apis). + + Register an API route and set a specific HTTP PATCH handler on that route. diff --git a/docs/reference/dart/api/api-post.mdx b/docs/reference/dart/api/api-post.mdx index 790f9ad8a..0e8c37bbb 100644 --- a/docs/reference/dart/api/api-post.mdx +++ b/docs/reference/dart/api/api-post.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Register an API route and se # Dart - api.post() + + This is reference documentation for the Nitric Dart SDK. To learn about APIs + in Nitric start with the [API docs](/apis). + + Register an API route and set a specific HTTP POST handler on that route. diff --git a/docs/reference/dart/api/api-put.mdx b/docs/reference/dart/api/api-put.mdx index baff07add..42faa9d46 100644 --- a/docs/reference/dart/api/api-put.mdx +++ b/docs/reference/dart/api/api-put.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Register an API route and se # Dart - api.put() + + This is reference documentation for the Nitric Dart SDK. To learn about APIs + in Nitric start with the [API docs](/apis). + + Register an API route and set a specific HTTP PUT handler on that route. diff --git a/docs/reference/dart/api/api-route-all.mdx b/docs/reference/dart/api/api-route-all.mdx index 6cff7bba7..e663bbc01 100644 --- a/docs/reference/dart/api/api-route-all.mdx +++ b/docs/reference/dart/api/api-route-all.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Register a single handler fo # Dart - api.route.all() + + This is reference documentation for the Nitric Dart SDK. To learn about APIs + in Nitric start with the [API docs](/apis). + + Register a single handler for all HTTP Methods (GET, POST, PUT, DELETE, PATCH) on the route. ```dart diff --git a/docs/reference/dart/api/api-route-delete.mdx b/docs/reference/dart/api/api-route-delete.mdx index e01f5393c..20f8a3f17 100644 --- a/docs/reference/dart/api/api-route-delete.mdx +++ b/docs/reference/dart/api/api-route-delete.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Register a handler for HTTP # Dart - api.route.delete() + + This is reference documentation for the Nitric Dart SDK. To learn about APIs + in Nitric start with the [API docs](/apis). + + Register a handler for HTTP DELETE requests to the route. ```dart diff --git a/docs/reference/dart/api/api-route-get.mdx b/docs/reference/dart/api/api-route-get.mdx index d22dc9039..b376b8d86 100644 --- a/docs/reference/dart/api/api-route-get.mdx +++ b/docs/reference/dart/api/api-route-get.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Register a handler for HTTP # Dart - api.route.get() + + This is reference documentation for the Nitric Dart SDK. To learn about APIs + in Nitric start with the [API docs](/apis). + + Register a handler for HTTP GET requests to the route. ```dart diff --git a/docs/reference/dart/api/api-route-patch.mdx b/docs/reference/dart/api/api-route-patch.mdx index 25a1fa4b2..565a8bcaa 100644 --- a/docs/reference/dart/api/api-route-patch.mdx +++ b/docs/reference/dart/api/api-route-patch.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Register a handler for HTTP # Dart - api.route.patch() + + This is reference documentation for the Nitric Dart SDK. To learn about APIs + in Nitric start with the [API docs](/apis). + + Register a handler for HTTP PATCH requests to the route. ```dart diff --git a/docs/reference/dart/api/api-route-post.mdx b/docs/reference/dart/api/api-route-post.mdx index fbd14b8b9..3075833c9 100644 --- a/docs/reference/dart/api/api-route-post.mdx +++ b/docs/reference/dart/api/api-route-post.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Register a handler for HTTP # Dart - api.route.post() + + This is reference documentation for the Nitric Dart SDK. To learn about APIs + in Nitric start with the [API docs](/apis). + + Register a handler for HTTP POST requests to the route. ```dart diff --git a/docs/reference/dart/api/api-route-put.mdx b/docs/reference/dart/api/api-route-put.mdx index c35ab6991..f64a6a2bf 100644 --- a/docs/reference/dart/api/api-route-put.mdx +++ b/docs/reference/dart/api/api-route-put.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Register a handler for HTTP # Dart - api.route.put() + + This is reference documentation for the Nitric Dart SDK. To learn about APIs + in Nitric start with the [API docs](/apis). + + Register a handler for HTTP PUT requests to the route. ```dart diff --git a/docs/reference/dart/api/api-route.mdx b/docs/reference/dart/api/api-route.mdx index 8dc4e84b6..c6441cc7e 100644 --- a/docs/reference/dart/api/api-route.mdx +++ b/docs/reference/dart/api/api-route.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Creates a new route (path) w # Dart - api.route() + + This is reference documentation for the Nitric Dart SDK. To learn about APIs + in Nitric start with the [API docs](/apis). + + Creates a new route (path) within an API. ```dart diff --git a/docs/reference/dart/api/api.mdx b/docs/reference/dart/api/api.mdx index ce2b9df91..451fe51bb 100644 --- a/docs/reference/dart/api/api.mdx +++ b/docs/reference/dart/api/api.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Create APIs with the Nitric # Dart - api() + + This is reference documentation for the Nitric Dart SDK. To learn about APIs + in Nitric start with the [API docs](/apis). + + Creates a new HTTP API. ```dart diff --git a/docs/reference/dart/batch/job-handler.mdx b/docs/reference/dart/batch/job-handler.mdx index 9321dcadc..2d76f93e2 100644 --- a/docs/reference/dart/batch/job-handler.mdx +++ b/docs/reference/dart/batch/job-handler.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Register a job handler to wi # Dart - job.handler() + + This is reference documentation for the Nitric Dart SDK. To learn about Batch + Services in Nitric start with the [Batch docs](/batch). + + Job handlers are the code that is run when a job request is submitted. These handlers should be written in a separate file to your services. ```dart diff --git a/docs/reference/dart/batch/job-submit.mdx b/docs/reference/dart/batch/job-submit.mdx index d70087f28..440cb39ba 100644 --- a/docs/reference/dart/batch/job-submit.mdx +++ b/docs/reference/dart/batch/job-submit.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Submit a batch job request w # Dart - job.submit() + + This is reference documentation for the Nitric Dart SDK. To learn about Batch + Services in Nitric start with the [Batch docs](/batch). + + Jobs may be submitted from Nitric `services` or other `batches` using the `submit` method on the job reference. When submitting a job you can provide a payload that will be passed to the job handler function. ```dart diff --git a/docs/reference/dart/batch/job.mdx b/docs/reference/dart/batch/job.mdx index 2fa72a564..bc9f5b7d2 100644 --- a/docs/reference/dart/batch/job.mdx +++ b/docs/reference/dart/batch/job.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Create Batch Jobs with the N # Dart - job() + + This is reference documentation for the Nitric Dart SDK. To learn about Batch + Services in Nitric start with the [Batch docs](/batch). + + Creates a new Batch Job. ```dart diff --git a/docs/reference/dart/index.mdx b/docs/reference/dart/index.mdx index eb6935155..88267ca37 100644 --- a/docs/reference/dart/index.mdx +++ b/docs/reference/dart/index.mdx @@ -8,6 +8,12 @@ This SDK reference provides documentation for the services and methods in Nitric The library provides the ability to define and interact with cloud resources, as well as build application services. + + This is reference documentation for the Nitric Dart SDK. If you're just + learning Nitric, we recommend starting with the + [Quickstart](/get-started/quickstart) guide. + + ## Installation If you used a Nitric starter template for Dart to scaffold your project, then `nitric_sdk` will already be included in the dependencies in your `pubspec.yaml` file. Using starter templates is the recommended installation option since it ensures the other files and configuration needed are also set up. diff --git a/docs/reference/dart/keyvalue/keyvalue-delete.mdx b/docs/reference/dart/keyvalue/keyvalue-delete.mdx index 78c78b29b..19973fae7 100644 --- a/docs/reference/dart/keyvalue/keyvalue-delete.mdx +++ b/docs/reference/dart/keyvalue/keyvalue-delete.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Delete key from a key value # Dart - kv.delete() + + This is reference documentation for the Nitric Dart SDK. To learn about + Key/Value Stores in Nitric start with the [Key/Value Store docs](/keyvalue). + + Delete key from a key value store. ```dart diff --git a/docs/reference/dart/keyvalue/keyvalue-get.mdx b/docs/reference/dart/keyvalue/keyvalue-get.mdx index e947b729c..ef863bb70 100644 --- a/docs/reference/dart/keyvalue/keyvalue-get.mdx +++ b/docs/reference/dart/keyvalue/keyvalue-get.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Get a value from a key value # Dart - kv.get() + + This is reference documentation for the Nitric Dart SDK. To learn about + Key/Value Stores in Nitric start with the [Key/Value Store docs](/keyvalue). + + Get a value from a key value store. ```dart diff --git a/docs/reference/dart/keyvalue/keyvalue-keys.mdx b/docs/reference/dart/keyvalue/keyvalue-keys.mdx index 4d628cffc..8de116152 100644 --- a/docs/reference/dart/keyvalue/keyvalue-keys.mdx +++ b/docs/reference/dart/keyvalue/keyvalue-keys.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Retrieve all or some of the # Dart - kv.keys() + + This is reference documentation for the Nitric Dart SDK. To learn about + Key/Value Stores in Nitric start with the [Key/Value Store docs](/keyvalue). + + Return an async iterable of keys in the store. ```dart diff --git a/docs/reference/dart/keyvalue/keyvalue-set.mdx b/docs/reference/dart/keyvalue/keyvalue-set.mdx index 130e0fbb6..16ca4c835 100644 --- a/docs/reference/dart/keyvalue/keyvalue-set.mdx +++ b/docs/reference/dart/keyvalue/keyvalue-set.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Store a key value pair in a # Dart - kv.set() + + This is reference documentation for the Nitric Dart SDK. To learn about + Key/Value Stores in Nitric start with the [Key/Value Store docs](/keyvalue). + + Store a key value pair in a key value store. ```dart diff --git a/docs/reference/dart/keyvalue/keyvalue.mdx b/docs/reference/dart/keyvalue/keyvalue.mdx index b3a76e628..cec229885 100644 --- a/docs/reference/dart/keyvalue/keyvalue.mdx +++ b/docs/reference/dart/keyvalue/keyvalue.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Creates a new key value stor # Dart - kv() + + This is reference documentation for the Nitric Dart SDK. To learn about + Key/Value Stores in Nitric start with the [Key/Value Store docs](/keyvalue). + + Creates a new key value store to get, set, and delete key value pairs. ```dart diff --git a/docs/reference/dart/queues/queue-dequeue.mdx b/docs/reference/dart/queues/queue-dequeue.mdx index d048265e1..8c67add83 100644 --- a/docs/reference/dart/queues/queue-dequeue.mdx +++ b/docs/reference/dart/queues/queue-dequeue.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Dequeue messages." # Dart - queue.dequeue() + + This is reference documentation for the Nitric Dart SDK. To learn about Queues + in Nitric start with the [Async Messaging docs](/messaging#queues). + + Dequeue messages. ```dart diff --git a/docs/reference/dart/queues/queue-enqueue.mdx b/docs/reference/dart/queues/queue-enqueue.mdx index 3af630c0b..646b3e0be 100644 --- a/docs/reference/dart/queues/queue-enqueue.mdx +++ b/docs/reference/dart/queues/queue-enqueue.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Send messages to a queue." # Dart - queue.enqueue() + + This is reference documentation for the Nitric Dart SDK. To learn about Queues + in Nitric start with the [Async Messaging docs](/messaging#queues). + + Send messages to a queue. ```dart diff --git a/docs/reference/dart/queues/queue.mdx b/docs/reference/dart/queues/queue.mdx index 9f50d2913..a12a670db 100644 --- a/docs/reference/dart/queues/queue.mdx +++ b/docs/reference/dart/queues/queue.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Creates a new Queue to proce # Dart - queue() + + This is reference documentation for the Nitric Dart SDK. To learn about Queues + in Nitric start with the [Async Messaging docs](/messaging#queues). + + Creates a new Queue to process asynchronous messages. ```dart diff --git a/docs/reference/dart/schedule/schedule-cron.mdx b/docs/reference/dart/schedule/schedule-cron.mdx index d1c9b2103..9b31fd87b 100644 --- a/docs/reference/dart/schedule/schedule-cron.mdx +++ b/docs/reference/dart/schedule/schedule-cron.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Sets the cron expression and # Dart - schedule.cron() + + This is reference documentation for the Nitric Dart SDK. To learn about + Schedules in Nitric start with the [Schedule docs](/schedules). + + Sets the cron expressions that determines when the schedule triggers and a callback to be triggered. ```dart diff --git a/docs/reference/dart/schedule/schedule-every.mdx b/docs/reference/dart/schedule/schedule-every.mdx index bd256f1ab..25d0dc622 100644 --- a/docs/reference/dart/schedule/schedule-every.mdx +++ b/docs/reference/dart/schedule/schedule-every.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Sets the frequency and one o # Dart - schedule.every() + + This is reference documentation for the Nitric Dart SDK. To learn about + Schedules in Nitric start with the [Schedule docs](/schedules). + + Sets the frequency and one or many handlers to be triggered. ```dart diff --git a/docs/reference/dart/schedule/schedule.mdx b/docs/reference/dart/schedule/schedule.mdx index 8119ad807..f33344a85 100644 --- a/docs/reference/dart/schedule/schedule.mdx +++ b/docs/reference/dart/schedule/schedule.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Creates a new Schedule to ru # Dart - schedule() + + This is reference documentation for the Nitric Dart SDK. To learn about + Schedules in Nitric start with the [Schedule docs](/schedules). + + Creates a new Schedule to run a service on a defined frequency. ```dart diff --git a/docs/reference/dart/secrets/secret-latest.mdx b/docs/reference/dart/secrets/secret-latest.mdx index 44a9e86c1..5ff659d18 100644 --- a/docs/reference/dart/secrets/secret-latest.mdx +++ b/docs/reference/dart/secrets/secret-latest.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Returns a reference to the l # Dart - secret.latest() + + This is reference documentation for the Nitric Dart SDK. To learn about + Secrets in Nitric start with the [Secrets docs](/secrets). + + Returns a reference to the `latest` version of a secret, regardless of that version's ID. ```dart diff --git a/docs/reference/dart/secrets/secret-put.mdx b/docs/reference/dart/secrets/secret-put.mdx index d4d2270e6..09a64c541 100644 --- a/docs/reference/dart/secrets/secret-put.mdx +++ b/docs/reference/dart/secrets/secret-put.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Store a new secret value" # Dart - secret.put() + + This is reference documentation for the Nitric Dart SDK. To learn about + Secrets in Nitric start with the [Secrets docs](/secrets). + + Store a new secret value, creating a new [version](./secret-version) to store the value. ```dart diff --git a/docs/reference/dart/secrets/secret-version-access.mdx b/docs/reference/dart/secrets/secret-version-access.mdx index 6e84ec07d..2ea50611b 100644 --- a/docs/reference/dart/secrets/secret-version-access.mdx +++ b/docs/reference/dart/secrets/secret-version-access.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Retrieves the value from a v # Dart - secret.version.access() + + This is reference documentation for the Nitric Dart SDK. To learn about + Secrets in Nitric start with the [Secrets docs](/secrets). + + Retrieves the value from a version of a secret. ```dart diff --git a/docs/reference/dart/secrets/secret-version.mdx b/docs/reference/dart/secrets/secret-version.mdx index c0c076782..8119debb4 100644 --- a/docs/reference/dart/secrets/secret-version.mdx +++ b/docs/reference/dart/secrets/secret-version.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Returns a reference to a kno # Dart - secret.version() + + This is reference documentation for the Nitric Dart SDK. To learn about + Secrets in Nitric start with the [Secrets docs](/secrets). + + Returns a reference to a known version of a secret. ```dart diff --git a/docs/reference/dart/secrets/secret.mdx b/docs/reference/dart/secrets/secret.mdx index 9d5bb5d47..0df1edb6e 100644 --- a/docs/reference/dart/secrets/secret.mdx +++ b/docs/reference/dart/secrets/secret.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Creates a reference to a sec # Dart - secret() + + This is reference documentation for the Nitric Dart SDK. To learn about + Secrets in Nitric start with the [Secrets docs](/secrets). + + Creates a reference to a secret in the secrets manager. ```dart diff --git a/docs/reference/dart/sql/sql-connection-string.mdx b/docs/reference/dart/sql/sql-connection-string.mdx index 71b06279e..4f431a665 100644 --- a/docs/reference/dart/sql/sql-connection-string.mdx +++ b/docs/reference/dart/sql/sql-connection-string.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Returns the connection strin # Dart - sql.connectionString() + + This is reference documentation for the Nitric Dart SDK. To learn about SQL + Databases in Nitric start with the [SQL docs](/sql). + + Returns the connection string for a SQL database at runtime. ```dart diff --git a/docs/reference/dart/sql/sql.mdx b/docs/reference/dart/sql/sql.mdx index 999f04ebd..9e11df317 100644 --- a/docs/reference/dart/sql/sql.mdx +++ b/docs/reference/dart/sql/sql.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Creates a reference to a SQL # Dart - sql() + + This is reference documentation for the Nitric Dart SDK. To learn about SQL + Databases in Nitric start with the [SQL docs](/sql). + + Creates a reference to a SQL database. ```dart diff --git a/docs/reference/dart/storage/bucket-file-delete.mdx b/docs/reference/dart/storage/bucket-file-delete.mdx index 2d22558cd..7467ff13c 100644 --- a/docs/reference/dart/storage/bucket-file-delete.mdx +++ b/docs/reference/dart/storage/bucket-file-delete.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Delete a file from a bucket. # Dart - bucket.file.delete() + + This is reference documentation for the Nitric Dart SDK. To learn about + Storage and Buckets in Nitric start with the [Storage docs](/storage). + + Delete a file from a bucket. ```dart diff --git a/docs/reference/dart/storage/bucket-file-downloadurl.mdx b/docs/reference/dart/storage/bucket-file-downloadurl.mdx index f5791e242..b3e25d84a 100644 --- a/docs/reference/dart/storage/bucket-file-downloadurl.mdx +++ b/docs/reference/dart/storage/bucket-file-downloadurl.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Get a download url for a fil # Dart - bucket.file.getDownloadUrl() + + This is reference documentation for the Nitric Dart SDK. To learn about + Storage and Buckets in Nitric start with the [Storage docs](/storage). + + Create a download url for a file within a bucket. ```dart diff --git a/docs/reference/dart/storage/bucket-file-exists.mdx b/docs/reference/dart/storage/bucket-file-exists.mdx index 40fe726b5..e81d5b4bf 100644 --- a/docs/reference/dart/storage/bucket-file-exists.mdx +++ b/docs/reference/dart/storage/bucket-file-exists.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Determine if a file exists i # Dart - bucket.file.exists() + + This is reference documentation for the Nitric Dart SDK. To learn about + Storage and Buckets in Nitric start with the [Storage docs](/storage). + + Determine if a file exists in a bucket. ```dart diff --git a/docs/reference/dart/storage/bucket-file-read.mdx b/docs/reference/dart/storage/bucket-file-read.mdx index d0f78999a..c39ba67cd 100644 --- a/docs/reference/dart/storage/bucket-file-read.mdx +++ b/docs/reference/dart/storage/bucket-file-read.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Read the contents of a file # Dart - bucket.file.read() + + This is reference documentation for the Nitric Dart SDK. To learn about + Storage and Buckets in Nitric start with the [Storage docs](/storage). + + Read the contents of a file from a bucket. ```dart diff --git a/docs/reference/dart/storage/bucket-file-uploadurl.mdx b/docs/reference/dart/storage/bucket-file-uploadurl.mdx index 6725cc02f..07296a690 100644 --- a/docs/reference/dart/storage/bucket-file-uploadurl.mdx +++ b/docs/reference/dart/storage/bucket-file-uploadurl.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Get an upload URL for a file # Dart - bucket.file.getUploadUrl() + + This is reference documentation for the Nitric Dart SDK. To learn about + Storage and Buckets in Nitric start with the [Storage docs](/storage). + + Create an upload URL for a file within a bucket. ```dart diff --git a/docs/reference/dart/storage/bucket-file-write.mdx b/docs/reference/dart/storage/bucket-file-write.mdx index 59122d45e..f35e4017a 100644 --- a/docs/reference/dart/storage/bucket-file-write.mdx +++ b/docs/reference/dart/storage/bucket-file-write.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Write a file to a bucket." # Dart - bucket.file.write() + + This is reference documentation for the Nitric Dart SDK. To learn about + Storage and Buckets in Nitric start with the [Storage docs](/storage). + + Write a file to a bucket. ```dart diff --git a/docs/reference/dart/storage/bucket-file.mdx b/docs/reference/dart/storage/bucket-file.mdx index ae49c9c19..9d77ba84c 100644 --- a/docs/reference/dart/storage/bucket-file.mdx +++ b/docs/reference/dart/storage/bucket-file.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Create a reference to a file # Dart - bucket.file() + + This is reference documentation for the Nitric Dart SDK. To learn about + Storage and Buckets in Nitric start with the [Storage docs](/storage). + + Create a reference to a file within a bucket. ```dart diff --git a/docs/reference/dart/storage/bucket-files.mdx b/docs/reference/dart/storage/bucket-files.mdx index ef039caeb..5eb1c877b 100644 --- a/docs/reference/dart/storage/bucket-files.mdx +++ b/docs/reference/dart/storage/bucket-files.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Get a list of file reference # Dart - bucket.files() + + This is reference documentation for the Nitric Dart SDK. To learn about + Storage and Buckets in Nitric start with the [Storage docs](/storage). + + Get a list of file references for files that exist in the bucket. ```dart diff --git a/docs/reference/dart/storage/bucket-on.mdx b/docs/reference/dart/storage/bucket-on.mdx index 669f3f0bb..b821e3ed9 100644 --- a/docs/reference/dart/storage/bucket-on.mdx +++ b/docs/reference/dart/storage/bucket-on.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Create a new bucket notifica # Dart - bucket.on() + + This is reference documentation for the Nitric Dart SDK. To learn about + Storage and Buckets in Nitric start with the [Storage docs](/storage). + + Create a new bucket notification trigger when certain files are created or deleted. ```dart diff --git a/docs/reference/dart/storage/bucket.mdx b/docs/reference/dart/storage/bucket.mdx index 1a54fb59c..f638a42cd 100644 --- a/docs/reference/dart/storage/bucket.mdx +++ b/docs/reference/dart/storage/bucket.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Create a new bucket for stor # Dart - bucket() + + This is reference documentation for the Nitric Dart SDK. To learn about + Storage and Buckets in Nitric start with the [Storage docs](/storage). + + Create a new bucket for storing and retrieving files. ```dart diff --git a/docs/reference/dart/topic/topic-publish.mdx b/docs/reference/dart/topic/topic-publish.mdx index e3d23b9f5..0fc4c581e 100644 --- a/docs/reference/dart/topic/topic-publish.mdx +++ b/docs/reference/dart/topic/topic-publish.mdx @@ -4,6 +4,12 @@ description: "Reference for Nitric's Dart library - Publish new events to the to # Dart - topic.publish() + + This is reference documentation for the Nitric Dart SDK. To learn about Topics + and Pub/Sub in Nitric start with the [Async Messaging + docs](/messaging#topics). + + Publish an event (push based message) to a topic. ```dart diff --git a/docs/reference/dart/topic/topic-subscribe.mdx b/docs/reference/dart/topic/topic-subscribe.mdx index 6eeaca1f8..bd066d68b 100644 --- a/docs/reference/dart/topic/topic-subscribe.mdx +++ b/docs/reference/dart/topic/topic-subscribe.mdx @@ -4,6 +4,12 @@ description: "Reference for Nitric's Dart library - Subscribe a handler to a top # Dart - topic.subscribe() + + This is reference documentation for the Nitric Dart SDK. To learn about Topics + and Pub/Sub in Nitric start with the [Async Messaging + docs](/messaging#topics). + + Subscribe a handler to a topic and receive new events for processing. ```dart diff --git a/docs/reference/dart/topic/topic.mdx b/docs/reference/dart/topic/topic.mdx index 1bc3be649..a00d61f81 100644 --- a/docs/reference/dart/topic/topic.mdx +++ b/docs/reference/dart/topic/topic.mdx @@ -4,6 +4,12 @@ description: "Reference for Nitric's Dart library - Creates a new Topic." # Dart - topic() + + This is reference documentation for the Nitric Dart SDK. To learn about Topics + and Pub/Sub in Nitric start with the [Async Messaging + docs](/messaging#topics). + + Creates a new Topic. ```dart diff --git a/docs/reference/dart/websocket/websocket-close.mdx b/docs/reference/dart/websocket/websocket-close.mdx index a29c27610..1070bc11d 100644 --- a/docs/reference/dart/websocket/websocket-close.mdx +++ b/docs/reference/dart/websocket/websocket-close.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Close a connection to a webs # Dart - websocket.close() + + This is reference documentation for the Nitric Dart SDK. To learn about + Websockets in Nitric start with the [Websockets docs](/websockets). + + Closes a connection to a websocket ```dart diff --git a/docs/reference/dart/websocket/websocket-on.mdx b/docs/reference/dart/websocket/websocket-on.mdx index 6991aca38..d609b72e5 100644 --- a/docs/reference/dart/websocket/websocket-on.mdx +++ b/docs/reference/dart/websocket/websocket-on.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Register a handler for conne # Dart - websocket.on() + + This is reference documentation for the Nitric Dart SDK. To learn about + Websockets in Nitric start with the [Websockets docs](/websockets). + + Register a handler for connections, disconnections, or messages for the websocket. ```dart diff --git a/docs/reference/dart/websocket/websocket-send.mdx b/docs/reference/dart/websocket/websocket-send.mdx index 003fe10e9..41e8260fe 100644 --- a/docs/reference/dart/websocket/websocket-send.mdx +++ b/docs/reference/dart/websocket/websocket-send.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Send a message to a connecte # Dart - websocket.send() + + This is reference documentation for the Nitric Dart SDK. To learn about + Websockets in Nitric start with the [Websockets docs](/websockets). + + Send a message to a connected websocket client. ```dart diff --git a/docs/reference/dart/websocket/websocket.mdx b/docs/reference/dart/websocket/websocket.mdx index 94633d168..76bac4ff5 100644 --- a/docs/reference/dart/websocket/websocket.mdx +++ b/docs/reference/dart/websocket/websocket.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Create Websockets with the N # Dart - websocket() + + This is reference documentation for the Nitric Dart SDK. To learn about + Websockets in Nitric start with the [Websockets docs](/websockets). + + Creates a new Websocket. ```dart diff --git a/docs/reference/go/api/api-delete.mdx b/docs/reference/go/api/api-delete.mdx index 000721c31..f8a9b5eed 100644 --- a/docs/reference/go/api/api-delete.mdx +++ b/docs/reference/go/api/api-delete.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Register an API route and set # Go - Api.Delete() + + This is reference documentation for the Nitric Go SDK. To learn about APIs in + Nitric start with the [API docs](/apis). + + Register an API route and set a specific HTTP DELETE handler on that route. diff --git a/docs/reference/go/api/api-get.mdx b/docs/reference/go/api/api-get.mdx index 3872dbfa1..c2702080f 100644 --- a/docs/reference/go/api/api-get.mdx +++ b/docs/reference/go/api/api-get.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Register an API route and set # Go - Api.Get() + + This is reference documentation for the Nitric Go SDK. To learn about APIs in + Nitric start with the [API docs](/apis). + + Register an API route and set a specific HTTP GET handler on that route. diff --git a/docs/reference/go/api/api-patch.mdx b/docs/reference/go/api/api-patch.mdx index 3f5059fb3..55b23fcf5 100644 --- a/docs/reference/go/api/api-patch.mdx +++ b/docs/reference/go/api/api-patch.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Register an API route and set # Go - Api.Patch() + + This is reference documentation for the Nitric Go SDK. To learn about APIs in + Nitric start with the [API docs](/apis). + + Register an API route and set a specific HTTP PATCH handler on that route. diff --git a/docs/reference/go/api/api-post.mdx b/docs/reference/go/api/api-post.mdx index 76c5c4aa0..30f176bf3 100644 --- a/docs/reference/go/api/api-post.mdx +++ b/docs/reference/go/api/api-post.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Register an API route and set # Go - Api.Post() + + This is reference documentation for the Nitric Go SDK. To learn about APIs in + Nitric start with the [API docs](/apis). + + Register an API route and set a specific HTTP POST handler on that route. diff --git a/docs/reference/go/api/api-put.mdx b/docs/reference/go/api/api-put.mdx index 195bfc712..75b48dc3a 100644 --- a/docs/reference/go/api/api-put.mdx +++ b/docs/reference/go/api/api-put.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Register an API route and set # Go - Api.Put() + + This is reference documentation for the Nitric Go SDK. To learn about APIs in + Nitric start with the [API docs](/apis). + + Register an API route and set a specific HTTP PUT handler on that route. diff --git a/docs/reference/go/api/api-route-all.mdx b/docs/reference/go/api/api-route-all.mdx index 443e83a35..6ec661b39 100644 --- a/docs/reference/go/api/api-route-all.mdx +++ b/docs/reference/go/api/api-route-all.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Register a single handler for # Go - Api.Route.All() + + This is reference documentation for the Nitric Go SDK. To learn about APIs in + Nitric start with the [API docs](/apis). + + Register a single handler for all HTTP Methods (GET, POST, PUT, DELETE, PATCH) on the route. ```go diff --git a/docs/reference/go/api/api-route-delete.mdx b/docs/reference/go/api/api-route-delete.mdx index 0e8445f5c..37e26b096 100644 --- a/docs/reference/go/api/api-route-delete.mdx +++ b/docs/reference/go/api/api-route-delete.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Register a handler for HTTP DE # Go - Api.Route.Delete() + + This is reference documentation for the Nitric Go SDK. To learn about APIs in + Nitric start with the [API docs](/apis). + + Register a handler for HTTP DELETE requests to the route. ```go diff --git a/docs/reference/go/api/api-route-get.mdx b/docs/reference/go/api/api-route-get.mdx index 037bfa359..08ed2d702 100644 --- a/docs/reference/go/api/api-route-get.mdx +++ b/docs/reference/go/api/api-route-get.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Register a handler for HTTP GE # Go - Api.Route.Get() + + This is reference documentation for the Nitric Go SDK. To learn about APIs in + Nitric start with the [API docs](/apis). + + Register a handler for HTTP GET requests to the route. ```go diff --git a/docs/reference/go/api/api-route-patch.mdx b/docs/reference/go/api/api-route-patch.mdx index 5f38ff6ae..06eafd11c 100644 --- a/docs/reference/go/api/api-route-patch.mdx +++ b/docs/reference/go/api/api-route-patch.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Register a handler for HTTP PA # Go - Api.Route.Patch() + + This is reference documentation for the Nitric Go SDK. To learn about APIs in + Nitric start with the [API docs](/apis). + + Register a handler for HTTP PATCH requests to the route. ```go diff --git a/docs/reference/go/api/api-route-post.mdx b/docs/reference/go/api/api-route-post.mdx index 1f542e9a0..f541b2158 100644 --- a/docs/reference/go/api/api-route-post.mdx +++ b/docs/reference/go/api/api-route-post.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Register a handler for HTTP PO # Go - Api.Route.Post() + + This is reference documentation for the Nitric Go SDK. To learn about APIs in + Nitric start with the [API docs](/apis). + + Register a handler for HTTP POST requests to the route. ```go diff --git a/docs/reference/go/api/api-route-put.mdx b/docs/reference/go/api/api-route-put.mdx index b5492a4ae..500d07b8f 100644 --- a/docs/reference/go/api/api-route-put.mdx +++ b/docs/reference/go/api/api-route-put.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Register a handler for HTTP PU # Go - Api.Route.Put() + + This is reference documentation for the Nitric Go SDK. To learn about APIs in + Nitric start with the [API docs](/apis). + + Register a handler for HTTP PUT requests to the route. ```go diff --git a/docs/reference/go/api/api-route.mdx b/docs/reference/go/api/api-route.mdx index d227a7e48..bc73f6fee 100644 --- a/docs/reference/go/api/api-route.mdx +++ b/docs/reference/go/api/api-route.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Creates a new route (path) wit # Go - Api.Route() + + This is reference documentation for the Nitric Go SDK. To learn about APIs in + Nitric start with the [API docs](/apis). + + Creates a new route (path) within an API. ```go diff --git a/docs/reference/go/api/api.mdx b/docs/reference/go/api/api.mdx index 044fbc90c..842d589e0 100644 --- a/docs/reference/go/api/api.mdx +++ b/docs/reference/go/api/api.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Create APIs with the Nitric Go # Go - NewApi() + + This is reference documentation for the Nitric Go SDK. To learn about APIs in + Nitric start with the [API docs](/apis). + + Creates a new HTTP API. ```go diff --git a/docs/reference/go/batch/job-handler.mdx b/docs/reference/go/batch/job-handler.mdx index 7c5f76c7d..b0b841a1d 100644 --- a/docs/reference/go/batch/job-handler.mdx +++ b/docs/reference/go/batch/job-handler.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Register a job handler to with # Go - Job.Handler() + + This is reference documentation for the Nitric Go SDK. To learn about Batch + Services in Nitric start with the [Batch Services docs](/batch). + + Job handlers are the code that is run when a job request is submitted. These handlers should be written in a separate file to your services. ```go diff --git a/docs/reference/go/batch/job-submit.mdx b/docs/reference/go/batch/job-submit.mdx index ccb217003..7683244f3 100644 --- a/docs/reference/go/batch/job-submit.mdx +++ b/docs/reference/go/batch/job-submit.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Submit a batch job request wit # Go - Job.Submit() + + This is reference documentation for the Nitric Go SDK. To learn about Batch + Services in Nitric start with the [Batch Services docs](/batch). + + Jobs may be submitted from Nitric `services` or other `batches` using the `submit` method on the job reference. When submitting a job you can provide a payload that will be passed to the job handler function. ```go diff --git a/docs/reference/go/batch/job.mdx b/docs/reference/go/batch/job.mdx index c994e02a4..c22dc29d0 100644 --- a/docs/reference/go/batch/job.mdx +++ b/docs/reference/go/batch/job.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Create Batch Jobs with the Nit # Go - NewJob() + + This is reference documentation for the Nitric Go SDK. To learn about Batch + Services in Nitric start with the [Batch Services docs](/batch). + + Creates a new Batch Job. ```go diff --git a/docs/reference/go/index.mdx b/docs/reference/go/index.mdx index f85b29601..33e3f75cd 100644 --- a/docs/reference/go/index.mdx +++ b/docs/reference/go/index.mdx @@ -8,6 +8,12 @@ This SDK reference provides documentation for the functions and methods in Nitri The library provides the ability to define and interact with cloud resources, as well as build application logic like functions/handlers. + + This is reference documentation for the Nitric Go SDK. If you're just learning + Nitric, we recommend starting with the [Quickstart](/get-started/quickstart) + guide. + + ## Installation If you used a Nitric starter template for Go to scaffold your project, then the `github.com/nitrictech/go-sdk` dependency will already be included in the dependencies in your `go.mod` file. Using starter templates is the recommended installation option since it ensures the other files and configuration needed are also set up. diff --git a/docs/reference/go/keyvalue/keyvalue-delete.mdx b/docs/reference/go/keyvalue/keyvalue-delete.mdx index 094cfab82..0ad4efcd0 100644 --- a/docs/reference/go/keyvalue/keyvalue-delete.mdx +++ b/docs/reference/go/keyvalue/keyvalue-delete.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Delete key from a key value st # Go - Kv.Delete() + + This is reference documentation for the Nitric Go SDK. To learn about + Key/Value Stores in Nitric start with the [Key/Value Store docs](/keyvalue). + + Delete key from a key value store. ```go diff --git a/docs/reference/go/keyvalue/keyvalue-get.mdx b/docs/reference/go/keyvalue/keyvalue-get.mdx index 84999c405..11c7b71d0 100644 --- a/docs/reference/go/keyvalue/keyvalue-get.mdx +++ b/docs/reference/go/keyvalue/keyvalue-get.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Get a value from a key value s # Go - Kv.Get() + + This is reference documentation for the Nitric Go SDK. To learn about + Key/Value Stores in Nitric start with the [Key/Value Store docs](/keyvalue). + + Get a value from a key value store. ```go diff --git a/docs/reference/go/keyvalue/keyvalue-keys.mdx b/docs/reference/go/keyvalue/keyvalue-keys.mdx index 1b202b70d..774f58dc2 100644 --- a/docs/reference/go/keyvalue/keyvalue-keys.mdx +++ b/docs/reference/go/keyvalue/keyvalue-keys.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Retrieve all or some of the ke # Go - Kv.Keys() + + This is reference documentation for the Nitric Go SDK. To learn about + Key/Value Stores in Nitric start with the [Key/Value Store docs](/keyvalue). + + Return an async iterable of keys in the store. ```go diff --git a/docs/reference/go/keyvalue/keyvalue-set.mdx b/docs/reference/go/keyvalue/keyvalue-set.mdx index 20607e7a5..2a6edb35d 100644 --- a/docs/reference/go/keyvalue/keyvalue-set.mdx +++ b/docs/reference/go/keyvalue/keyvalue-set.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Store a key value pair in a ke # Go - Kv.Set() + + This is reference documentation for the Nitric Go SDK. To learn about + Key/Value Stores in Nitric start with the [Key/Value Store docs](/keyvalue). + + Store a key value pair in a key value store. ```go diff --git a/docs/reference/go/keyvalue/keyvalue.mdx b/docs/reference/go/keyvalue/keyvalue.mdx index cf4a1b1bb..92d4ff58f 100644 --- a/docs/reference/go/keyvalue/keyvalue.mdx +++ b/docs/reference/go/keyvalue/keyvalue.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Creates a new key value store # Go - NewKv() + + This is reference documentation for the Nitric Go SDK. To learn about + Key/Value Stores in Nitric start with the [Key/Value Store docs](/keyvalue). + + Creates a new key value store to get, set, and delete key value pairs. ```go diff --git a/docs/reference/go/queues/queue-dequeue.mdx b/docs/reference/go/queues/queue-dequeue.mdx index 3f89f0768..e2e7a87f4 100644 --- a/docs/reference/go/queues/queue-dequeue.mdx +++ b/docs/reference/go/queues/queue-dequeue.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Dequeue messages." # Go - Queue.Dequeue() + + This is reference documentation for the Nitric Go SDK. To learn about Queues + in Nitric start with the [Async Messaging docs](/messaging#queues). + + Dequeue messages. ```go diff --git a/docs/reference/go/queues/queue-enqueue.mdx b/docs/reference/go/queues/queue-enqueue.mdx index 93dad74b6..9071304dd 100644 --- a/docs/reference/go/queues/queue-enqueue.mdx +++ b/docs/reference/go/queues/queue-enqueue.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Send messages to a queue." # Go - Queue.Enqueue() + + This is reference documentation for the Nitric Go SDK. To learn about Queues + in Nitric start with the [Async Messaging docs](/messaging#queues). + + Send messages to a queue. ```go diff --git a/docs/reference/go/queues/queue.mdx b/docs/reference/go/queues/queue.mdx index b5540b3fa..ea282ab38 100644 --- a/docs/reference/go/queues/queue.mdx +++ b/docs/reference/go/queues/queue.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Creates a new Queue to send an # Go - NewQueue() + + This is reference documentation for the Nitric Go SDK. To learn about Queues + in Nitric start with the [Async Messaging docs](/messaging#queues). + + Creates a new Queue to send and receive asynchronous tasks. ```go diff --git a/docs/reference/go/schedule/schedule-cron.mdx b/docs/reference/go/schedule/schedule-cron.mdx index cca049795..81d7f1eec 100644 --- a/docs/reference/go/schedule/schedule-cron.mdx +++ b/docs/reference/go/schedule/schedule-cron.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Sets the cron expression and o # Go - Schedule.Cron() + + This is reference documentation for the Nitric Go SDK. To learn about + Schedules in Nitric start with the [Schedule docs](/schedules). + + Sets the cron expressions that determines when the schedule triggers and a callback to be triggered. ```go diff --git a/docs/reference/go/schedule/schedule-every.mdx b/docs/reference/go/schedule/schedule-every.mdx index a9f4df34b..57c83a60f 100644 --- a/docs/reference/go/schedule/schedule-every.mdx +++ b/docs/reference/go/schedule/schedule-every.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Sets the frequency and one or # Go - Schedule.Every() + + This is reference documentation for the Nitric Go SDK. To learn about + Schedules in Nitric start with the [Schedule docs](/schedules). + + Sets the frequency and one or many handlers to be triggered. ```go diff --git a/docs/reference/go/schedule/schedule.mdx b/docs/reference/go/schedule/schedule.mdx index 1c5a9aa1e..3a6d32954 100644 --- a/docs/reference/go/schedule/schedule.mdx +++ b/docs/reference/go/schedule/schedule.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Creates a new Schedule to run # Go - NewSchedule() + + This is reference documentation for the Nitric Go SDK. To learn about + Schedules in Nitric start with the [Schedule docs](/schedules). + + Creates a new Schedule to run a function on a defined frequency. ```go diff --git a/docs/reference/go/secrets/secret-access-version.mdx b/docs/reference/go/secrets/secret-access-version.mdx index 3a024b727..51872c2e7 100644 --- a/docs/reference/go/secrets/secret-access-version.mdx +++ b/docs/reference/go/secrets/secret-access-version.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Retrieves the value from a ver # Go - Secret.AccessVersion() + + This is reference documentation for the Nitric Go SDK. To learn about Secrets + in Nitric start with the [Secrets docs](/secrets). + + Retrieves the value from a version of a secret. ```go diff --git a/docs/reference/go/secrets/secret-access.mdx b/docs/reference/go/secrets/secret-access.mdx index 03c60f64a..f3520ff1e 100644 --- a/docs/reference/go/secrets/secret-access.mdx +++ b/docs/reference/go/secrets/secret-access.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Returns a reference to the lat # Go - Secret.Access() + + This is reference documentation for the Nitric Go SDK. To learn about Secrets + in Nitric start with the [Secrets docs](/secrets). + + Returns a the value of the latest iteration of a secret. ```go diff --git a/docs/reference/go/secrets/secret-put.mdx b/docs/reference/go/secrets/secret-put.mdx index 29f8b55d0..f5b05b38f 100644 --- a/docs/reference/go/secrets/secret-put.mdx +++ b/docs/reference/go/secrets/secret-put.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Store a new secret value" # Go - Secret.Put() + + This is reference documentation for the Nitric Go SDK. To learn about Secrets + in Nitric start with the [Secrets docs](/secrets). + + Store a new secret value. ```go diff --git a/docs/reference/go/secrets/secret.mdx b/docs/reference/go/secrets/secret.mdx index 3a1521e05..f0525cd54 100644 --- a/docs/reference/go/secrets/secret.mdx +++ b/docs/reference/go/secrets/secret.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Creates a reference to a secre # Go - NewSecret() + + This is reference documentation for the Nitric Go SDK. To learn about Secrets + in Nitric start with the [Secrets docs](/secrets). + + Creates a reference to a secret in the secrets manager. ```go diff --git a/docs/reference/go/sql/sql-connection-string.mdx b/docs/reference/go/sql/sql-connection-string.mdx index 6025051ed..287de88b0 100644 --- a/docs/reference/go/sql/sql-connection-string.mdx +++ b/docs/reference/go/sql/sql-connection-string.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Returns the connection string # Go - SqlDatabase.ConnectionString() + + This is reference documentation for the Nitric Go SDK. To learn about SQL + Databases in Nitric start with the [SQL docs](/sql). + + Returns the connection string for a SQL database at runtime. ```go diff --git a/docs/reference/go/sql/sql.mdx b/docs/reference/go/sql/sql.mdx index 01c2c1b39..783bd5e8d 100644 --- a/docs/reference/go/sql/sql.mdx +++ b/docs/reference/go/sql/sql.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Creates a reference to a SQL d # Go - NewSqlDatabase() + + This is reference documentation for the Nitric Go SDK. To learn about SQL + Databases in Nitric start with the [SQL docs](/sql). + + Creates a reference to a SQL database. ```go diff --git a/docs/reference/go/storage/bucket-delete.mdx b/docs/reference/go/storage/bucket-delete.mdx index 0394a87eb..4c49fcd6b 100644 --- a/docs/reference/go/storage/bucket-delete.mdx +++ b/docs/reference/go/storage/bucket-delete.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Delete a file from a bucket." # Go - Bucket.File.Delete() + + This is reference documentation for the Nitric Go SDK. To learn about Storage + and Buckets in Nitric start with the [Storage docs](/storage). + + Delete a file from a bucket. ```go diff --git a/docs/reference/go/storage/bucket-downloadurl.mdx b/docs/reference/go/storage/bucket-downloadurl.mdx index 365576e4f..a732438c6 100644 --- a/docs/reference/go/storage/bucket-downloadurl.mdx +++ b/docs/reference/go/storage/bucket-downloadurl.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Get a download url for a file # Go - Bucket.DownloadUrl() + + This is reference documentation for the Nitric Go SDK. To learn about Storage + and Buckets in Nitric start with the [Storage docs](/storage). + + Create a download url for a file within a bucket. ```go diff --git a/docs/reference/go/storage/bucket-listfiles.mdx b/docs/reference/go/storage/bucket-listfiles.mdx index 3d9a7d36f..b69c3b772 100644 --- a/docs/reference/go/storage/bucket-listfiles.mdx +++ b/docs/reference/go/storage/bucket-listfiles.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Get a list of file references # Go - Bucket.ListFiles() + + This is reference documentation for the Nitric Go SDK. To learn about Storage + and Buckets in Nitric start with the [Storage docs](/storage). + + Get a list of file keys for files that exist in the bucket. ```go diff --git a/docs/reference/go/storage/bucket-on.mdx b/docs/reference/go/storage/bucket-on.mdx index a5e38b074..a77fbd50e 100644 --- a/docs/reference/go/storage/bucket-on.mdx +++ b/docs/reference/go/storage/bucket-on.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Create a new bucket notificati # Go - Bucket.On() + + This is reference documentation for the Nitric Go SDK. To learn about Storage + and Buckets in Nitric start with the [Storage docs](/storage). + + Create a new bucket notification trigger when certain files are created or deleted. ```go diff --git a/docs/reference/go/storage/bucket-read.mdx b/docs/reference/go/storage/bucket-read.mdx index d2cb8d7ef..8535414b6 100644 --- a/docs/reference/go/storage/bucket-read.mdx +++ b/docs/reference/go/storage/bucket-read.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Read the contents of a file fr # Go - Bucket.Read() + + This is reference documentation for the Nitric Go SDK. To learn about Storage + and Buckets in Nitric start with the [Storage docs](/storage). + + Read the contents of a file from a bucket. ```go diff --git a/docs/reference/go/storage/bucket-uploadurl.mdx b/docs/reference/go/storage/bucket-uploadurl.mdx index c68a755fe..15e1f997a 100644 --- a/docs/reference/go/storage/bucket-uploadurl.mdx +++ b/docs/reference/go/storage/bucket-uploadurl.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Get an upload URL for a file f # Go - Bucket.File.UploadUrl() + + This is reference documentation for the Nitric Go SDK. To learn about Storage + and Buckets in Nitric start with the [Storage docs](/storage). + + Create an upload URL for a file within a bucket. ```go diff --git a/docs/reference/go/storage/bucket-write.mdx b/docs/reference/go/storage/bucket-write.mdx index fa36f6bec..8f71a2038 100644 --- a/docs/reference/go/storage/bucket-write.mdx +++ b/docs/reference/go/storage/bucket-write.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Write a file to a bucket." # Go - Bucket.File.Write() + + This is reference documentation for the Nitric Go SDK. To learn about Storage + and Buckets in Nitric start with the [Storage docs](/storage). + + Write a file to a bucket. ```go diff --git a/docs/reference/go/storage/bucket.mdx b/docs/reference/go/storage/bucket.mdx index 25582b9e7..ac89ba619 100644 --- a/docs/reference/go/storage/bucket.mdx +++ b/docs/reference/go/storage/bucket.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Create a new bucket for storin # Go - NewBucket() + + This is reference documentation for the Nitric Go SDK. To learn about Storage + and Buckets in Nitric start with the [Storage docs](/storage). + + Create a new bucket for storing and retrieving files. ```go diff --git a/docs/reference/go/topic/topic-publish.mdx b/docs/reference/go/topic/topic-publish.mdx index 13fafc3b5..680598053 100644 --- a/docs/reference/go/topic/topic-publish.mdx +++ b/docs/reference/go/topic/topic-publish.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Publish new events to the topi # Go - Topic.Publish() + + This is reference documentation for the Nitric Go SDK. To learn about Topics + in Nitric start with the [Async Messaging docs](/messaging#topics). + + Publish an event (push based message) to a topic. ```go diff --git a/docs/reference/go/topic/topic-subscribe.mdx b/docs/reference/go/topic/topic-subscribe.mdx index 8f60d07bd..cea914691 100644 --- a/docs/reference/go/topic/topic-subscribe.mdx +++ b/docs/reference/go/topic/topic-subscribe.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Subscribe a handler to a topic # Go - Topic.Subscribe() + + This is reference documentation for the Nitric Go SDK. To learn about Topics + in Nitric start with the [Async Messaging docs](/messaging#topics). + + Subscribe a handler to a topic and receive new events for processing. ```go diff --git a/docs/reference/go/topic/topic.mdx b/docs/reference/go/topic/topic.mdx index e7cbe8390..a13e69784 100644 --- a/docs/reference/go/topic/topic.mdx +++ b/docs/reference/go/topic/topic.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Creates a new Topic." # Go - NewTopic() + + This is reference documentation for the Nitric Go SDK. To learn about Topics + in Nitric start with the [Async Messaging docs](/messaging#topics). + + Creates a new Topic. ```go diff --git a/docs/reference/go/websocket/websocket-close.mdx b/docs/reference/go/websocket/websocket-close.mdx index 92e29ccfe..a0d81427f 100644 --- a/docs/reference/go/websocket/websocket-close.mdx +++ b/docs/reference/go/websocket/websocket-close.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Close a connection to a websoc # Go - Websocket.Close() + + This is reference documentation for the Nitric Go SDK. To learn about + Websockets in Nitric start with the [Websockets docs](/websockets). + + Closes a connection to a websocket ```go diff --git a/docs/reference/go/websocket/websocket-on.mdx b/docs/reference/go/websocket/websocket-on.mdx index 5bc058565..bfde12215 100644 --- a/docs/reference/go/websocket/websocket-on.mdx +++ b/docs/reference/go/websocket/websocket-on.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Register a handler for connect # Go - Websocket.On() + + This is reference documentation for the Nitric Go SDK. To learn about + Websockets in Nitric start with the [Websockets docs](/websockets). + + Register a handler for connections, disconnections, or messages for the websocket. ```go diff --git a/docs/reference/go/websocket/websocket-send.mdx b/docs/reference/go/websocket/websocket-send.mdx index 5116abfb6..3dbc0db33 100644 --- a/docs/reference/go/websocket/websocket-send.mdx +++ b/docs/reference/go/websocket/websocket-send.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Send a message to the websocke # Go - Websocket.Send() + + This is reference documentation for the Nitric Go SDK. To learn about + Websockets in Nitric start with the [Websockets docs](/websockets). + + Send a message from the websocket to a connection. ```go diff --git a/docs/reference/go/websocket/websocket.mdx b/docs/reference/go/websocket/websocket.mdx index a12de735b..1c3ce1d95 100644 --- a/docs/reference/go/websocket/websocket.mdx +++ b/docs/reference/go/websocket/websocket.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Create Websockets with the Nit # Go - NewWebsocket() + + This is reference documentation for the Nitric Go SDK. To learn about + Websockets in Nitric start with the [Websockets docs](/websockets). + + Creates a new Websocket. ```go diff --git a/docs/reference/nodejs/api/api-delete.mdx b/docs/reference/nodejs/api/api-delete.mdx index 1fb243e9d..aefa835d0 100644 --- a/docs/reference/nodejs/api/api-delete.mdx +++ b/docs/reference/nodejs/api/api-delete.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Register an API route and # Node.js - api.delete() + + This is reference documentation for the Nitric Node.js SDK. To learn about + APIs in Nitric start with the [API docs](/apis). + + Register an API route and set a specific HTTP DELETE handler on that route. diff --git a/docs/reference/nodejs/api/api-get.mdx b/docs/reference/nodejs/api/api-get.mdx index 8a7fd336c..7fd289f90 100644 --- a/docs/reference/nodejs/api/api-get.mdx +++ b/docs/reference/nodejs/api/api-get.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Register an API route and # Node.js - api.get() + + This is reference documentation for the Nitric Node.js SDK. To learn about + APIs in Nitric start with the [API docs](/apis). + + Register an API route and set a specific HTTP GET handler on that route. diff --git a/docs/reference/nodejs/api/api-patch.mdx b/docs/reference/nodejs/api/api-patch.mdx index d84b1710c..b4970c7a0 100644 --- a/docs/reference/nodejs/api/api-patch.mdx +++ b/docs/reference/nodejs/api/api-patch.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Register an API route and # Node.js - api.patch() + + This is reference documentation for the Nitric Node.js SDK. To learn about + APIs in Nitric start with the [API docs](/apis). + + Register an API route and set a specific HTTP PATCH handler on that route. diff --git a/docs/reference/nodejs/api/api-post.mdx b/docs/reference/nodejs/api/api-post.mdx index 352fa2e50..c33dd2b0f 100644 --- a/docs/reference/nodejs/api/api-post.mdx +++ b/docs/reference/nodejs/api/api-post.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Register an API route and # Node.js - api.post() + + This is reference documentation for the Nitric Node.js SDK. To learn about + APIs in Nitric start with the [API docs](/apis). + + Register an API route and set a specific HTTP POST handler on that route. diff --git a/docs/reference/nodejs/api/api-put.mdx b/docs/reference/nodejs/api/api-put.mdx index c16190d40..5799a8405 100644 --- a/docs/reference/nodejs/api/api-put.mdx +++ b/docs/reference/nodejs/api/api-put.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Register an API route and # Node.js - api.put() + + This is reference documentation for the Nitric Node.js SDK. To learn about + APIs in Nitric start with the [API docs](/apis). + + Register an API route and set a specific HTTP PUT handler on that route. diff --git a/docs/reference/nodejs/api/api-route-all.mdx b/docs/reference/nodejs/api/api-route-all.mdx index 63ada9a05..fa2114969 100644 --- a/docs/reference/nodejs/api/api-route-all.mdx +++ b/docs/reference/nodejs/api/api-route-all.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Register a single handler # Node.js - api.route.all() + + This is reference documentation for the Nitric Node.js SDK. To learn about + APIs in Nitric start with the [API docs](/apis). + + Register a single handler for all HTTP Methods (GET, POST, PUT, DELETE, PATCH) on the route. ```javascript diff --git a/docs/reference/nodejs/api/api-route-delete.mdx b/docs/reference/nodejs/api/api-route-delete.mdx index 936888394..4f09036c5 100644 --- a/docs/reference/nodejs/api/api-route-delete.mdx +++ b/docs/reference/nodejs/api/api-route-delete.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Register a handler for HT # Node.js - api.route.delete() + + This is reference documentation for the Nitric Node.js SDK. To learn about + APIs in Nitric start with the [API docs](/apis). + + Register a handler for HTTP DELETE requests to the route. ```javascript diff --git a/docs/reference/nodejs/api/api-route-get.mdx b/docs/reference/nodejs/api/api-route-get.mdx index 795a5521a..4d1bd8c25 100644 --- a/docs/reference/nodejs/api/api-route-get.mdx +++ b/docs/reference/nodejs/api/api-route-get.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Register a handler for HT # Node.js - api.route.get() + + This is reference documentation for the Nitric Node.js SDK. To learn about + APIs in Nitric start with the [API docs](/apis). + + Register a handler for HTTP GET requests to the route. ```javascript diff --git a/docs/reference/nodejs/api/api-route-patch.mdx b/docs/reference/nodejs/api/api-route-patch.mdx index fae563d72..98813cab3 100644 --- a/docs/reference/nodejs/api/api-route-patch.mdx +++ b/docs/reference/nodejs/api/api-route-patch.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Register a handler for HT # Node.js - api.route.patch() + + This is reference documentation for the Nitric Node.js SDK. To learn about + APIs in Nitric start with the [API docs](/apis). + + Register a handler for HTTP PATCH requests to the route. ```javascript diff --git a/docs/reference/nodejs/api/api-route-post.mdx b/docs/reference/nodejs/api/api-route-post.mdx index f74d74ccf..f2b0594e1 100644 --- a/docs/reference/nodejs/api/api-route-post.mdx +++ b/docs/reference/nodejs/api/api-route-post.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Register a handler for HT # Node.js - api.route.post() + + This is reference documentation for the Nitric Node.js SDK. To learn about + APIs in Nitric start with the [API docs](/apis). + + Register a handler for HTTP POST requests to the route. ```javascript diff --git a/docs/reference/nodejs/api/api-route-put.mdx b/docs/reference/nodejs/api/api-route-put.mdx index 3b9c64996..09cdbab5c 100644 --- a/docs/reference/nodejs/api/api-route-put.mdx +++ b/docs/reference/nodejs/api/api-route-put.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Register a handler for HT # Node.js - api.route.put() + + This is reference documentation for the Nitric Node.js SDK. To learn about + APIs in Nitric start with the [API docs](/apis). + + Register a handler for HTTP PUT requests to the route. ```javascript diff --git a/docs/reference/nodejs/api/api-route.mdx b/docs/reference/nodejs/api/api-route.mdx index 30002496b..ee0f88074 100644 --- a/docs/reference/nodejs/api/api-route.mdx +++ b/docs/reference/nodejs/api/api-route.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Creates a new route (path # Node.js - api.route() + + This is reference documentation for the Nitric Node.js SDK. To learn about + APIs in Nitric start with the [API docs](/apis). + + Creates a new route (path) within an API. ```javascript diff --git a/docs/reference/nodejs/api/api.mdx b/docs/reference/nodejs/api/api.mdx index 0e42c8ba3..0153c424f 100644 --- a/docs/reference/nodejs/api/api.mdx +++ b/docs/reference/nodejs/api/api.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Create APIs with the Nitr # Node.js - api() + + This is reference documentation for the Nitric Node.js SDK. To learn about + APIs in Nitric start with the [API docs](/apis). + + Creates a new HTTP API. ```javascript diff --git a/docs/reference/nodejs/batch/job-handler.mdx b/docs/reference/nodejs/batch/job-handler.mdx index e8249ca42..6d5841258 100644 --- a/docs/reference/nodejs/batch/job-handler.mdx +++ b/docs/reference/nodejs/batch/job-handler.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Register a job handler" # Node.js - job.handler() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Batch Services in Nitric start with the [Batch docs](/batch). + + Job handlers are the code that is run when a job request is submitted. These handlers should be written in a separate file to your services. ```ts diff --git a/docs/reference/nodejs/batch/job-submit.mdx b/docs/reference/nodejs/batch/job-submit.mdx index ce0eb1c30..e5234e7f4 100644 --- a/docs/reference/nodejs/batch/job-submit.mdx +++ b/docs/reference/nodejs/batch/job-submit.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Submit a batch job reques # Node.js - job.submit() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Batch Services in Nitric start with the [Batch docs](/batch). + + Jobs may be submitted from Nitric `services` or other `batches` using the `submit` method on the job reference. When submitting a job you can provide a payload that will be passed to the job handler function. ```ts diff --git a/docs/reference/nodejs/batch/job.mdx b/docs/reference/nodejs/batch/job.mdx index e52bac105..a5cc7507a 100644 --- a/docs/reference/nodejs/batch/job.mdx +++ b/docs/reference/nodejs/batch/job.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Create Batch Jobs" # Node.js - job() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Batch Services in Nitric start with the [Batch docs](/batch). + + Creates a new Batch Job. ```ts diff --git a/docs/reference/nodejs/http/http.mdx b/docs/reference/nodejs/http/http.mdx index 9d9731c3a..c0068c9e5 100644 --- a/docs/reference/nodejs/http/http.mdx +++ b/docs/reference/nodejs/http/http.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Creates a HTTP proxy for # Node.js - http() + + This is reference documentation for the Nitric Node.js SDK. To learn about + HTTP Proxies in Nitric start with the [HTTP Proxy docs](/http). + + Creates a new HTTP proxy, which can be used for wrapping other web frameworks. The example below shows wrapping an express application. ```javascript diff --git a/docs/reference/nodejs/index.mdx b/docs/reference/nodejs/index.mdx index fe2e940da..de988456c 100644 --- a/docs/reference/nodejs/index.mdx +++ b/docs/reference/nodejs/index.mdx @@ -8,6 +8,12 @@ This SDK reference provides documentation for the services and methods in Nitric The library provides the ability to define and interact with cloud resources, as well as build application services. + + This is reference documentation for the Nitric Node.js SDK. If you're just + learning Nitric, we recommend starting with the + [Quickstart](/get-started/quickstart) guide. + + ## Installation If you used a Nitric starter template for JavaScript or TypeScript to scaffold your project, then `@nitric/sdk` will already be included in the dependencies in your `package.json` file. Using starter templates is the recommended installation option since it ensures the other files and configuration needed are also set up. diff --git a/docs/reference/nodejs/keyvalue/keyvalue-delete.mdx b/docs/reference/nodejs/keyvalue/keyvalue-delete.mdx index 6ce545bec..e44fd8934 100644 --- a/docs/reference/nodejs/keyvalue/keyvalue-delete.mdx +++ b/docs/reference/nodejs/keyvalue/keyvalue-delete.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Delete key from a key val # Node.js - kv.delete() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Key/Value Stores in Nitric start with the [Key/Value Stores docs](/keyvalue). + + Delete key from a key value store. ```javascript diff --git a/docs/reference/nodejs/keyvalue/keyvalue-get.mdx b/docs/reference/nodejs/keyvalue/keyvalue-get.mdx index 12f9f8aed..1946672f0 100644 --- a/docs/reference/nodejs/keyvalue/keyvalue-get.mdx +++ b/docs/reference/nodejs/keyvalue/keyvalue-get.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Get a value from a key va # Node.js - kv.get() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Key/Value Stores in Nitric start with the [Key/Value Stores docs](/keyvalue). + + Get a value from a key value store. ```javascript diff --git a/docs/reference/nodejs/keyvalue/keyvalue-keys.mdx b/docs/reference/nodejs/keyvalue/keyvalue-keys.mdx index 116d42eb8..14e6e4874 100644 --- a/docs/reference/nodejs/keyvalue/keyvalue-keys.mdx +++ b/docs/reference/nodejs/keyvalue/keyvalue-keys.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Retrieve all or some of t # Node.js - kv.keys() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Key/Value Stores in Nitric start with the [Key/Value Stores docs](/keyvalue). + + Return an async iterable of keys in the store. ```javascript diff --git a/docs/reference/nodejs/keyvalue/keyvalue-set.mdx b/docs/reference/nodejs/keyvalue/keyvalue-set.mdx index 29bc3ca1b..096b44026 100644 --- a/docs/reference/nodejs/keyvalue/keyvalue-set.mdx +++ b/docs/reference/nodejs/keyvalue/keyvalue-set.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Store a key value pair in # Node.js - kv.set() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Key/Value Stores in Nitric start with the [Key/Value Stores docs](/keyvalue). + + Store a key value pair in a key value store. ```javascript diff --git a/docs/reference/nodejs/keyvalue/keyvalue.mdx b/docs/reference/nodejs/keyvalue/keyvalue.mdx index 22ff9dc5a..b6b765229 100644 --- a/docs/reference/nodejs/keyvalue/keyvalue.mdx +++ b/docs/reference/nodejs/keyvalue/keyvalue.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Creates a new key value s # Node.js - kv() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Key/Value Stores in Nitric start with the [Key/Value Stores docs](/keyvalue). + + Creates a new key value store to get, set, and delete key value pairs. ```javascript diff --git a/docs/reference/nodejs/queues/queue-dequeue.mdx b/docs/reference/nodejs/queues/queue-dequeue.mdx index df20031b1..7525e8d02 100644 --- a/docs/reference/nodejs/queues/queue-dequeue.mdx +++ b/docs/reference/nodejs/queues/queue-dequeue.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Dequeue messages." # Node.js - queue.dequeue() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Queues in Nitric start with the [Async Messaging docs](/messaging#queues). + + Dequeue messages. ```javascript diff --git a/docs/reference/nodejs/queues/queue-enqueue.mdx b/docs/reference/nodejs/queues/queue-enqueue.mdx index b2b47c11e..421d46637 100644 --- a/docs/reference/nodejs/queues/queue-enqueue.mdx +++ b/docs/reference/nodejs/queues/queue-enqueue.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Send messages to a queue. # Node.js - queue.enqueue() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Queues in Nitric start with the [Async Messaging docs](/messaging#queues). + + Send messages to a queue. ```javascript diff --git a/docs/reference/nodejs/queues/queue.mdx b/docs/reference/nodejs/queues/queue.mdx index 4f5420453..a74ecd985 100644 --- a/docs/reference/nodejs/queues/queue.mdx +++ b/docs/reference/nodejs/queues/queue.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Creates a new Queue to pr # Node.js - queue() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Queues in Nitric start with the [Async Messaging docs](/messaging#queues). + + Creates a new Queue to process asynchronous messages. ```javascript diff --git a/docs/reference/nodejs/schedule/schedule-cron.mdx b/docs/reference/nodejs/schedule/schedule-cron.mdx index 90f3deae1..2c5ff5248 100644 --- a/docs/reference/nodejs/schedule/schedule-cron.mdx +++ b/docs/reference/nodejs/schedule/schedule-cron.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Sets the cron expression # Node.js - schedule.cron() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Schedules in Nitric start with the [Schedules docs](/schedules). + + Sets the cron expressions that determines when the schedule triggers and a callback to be triggered. ```javascript diff --git a/docs/reference/nodejs/schedule/schedule-every.mdx b/docs/reference/nodejs/schedule/schedule-every.mdx index 99d761234..037e80de7 100644 --- a/docs/reference/nodejs/schedule/schedule-every.mdx +++ b/docs/reference/nodejs/schedule/schedule-every.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Sets the frequency and on # Node.js - schedule.every() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Schedules in Nitric start with the [Schedules docs](/schedules). + + Sets the frequency and one or many handlers to be triggered. ```javascript diff --git a/docs/reference/nodejs/schedule/schedule.mdx b/docs/reference/nodejs/schedule/schedule.mdx index 7d1647aa3..61f523b7c 100644 --- a/docs/reference/nodejs/schedule/schedule.mdx +++ b/docs/reference/nodejs/schedule/schedule.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Creates a new Schedule to # Node.js - schedule() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Schedules in Nitric start with the [Schedules docs](/schedules). + + Creates a new Schedule to run a service on a defined frequency. ```javascript diff --git a/docs/reference/nodejs/secrets/secret-latest.mdx b/docs/reference/nodejs/secrets/secret-latest.mdx index c043b0ad6..bfa6b9c89 100644 --- a/docs/reference/nodejs/secrets/secret-latest.mdx +++ b/docs/reference/nodejs/secrets/secret-latest.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Returns a reference to th # Node.js - secret.latest() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Secrets in Nitric start with the [Secrets docs](/secrets). + + Returns a reference to the `latest` version of a secret, regardless of that version's ID. ```javascript diff --git a/docs/reference/nodejs/secrets/secret-put.mdx b/docs/reference/nodejs/secrets/secret-put.mdx index a26c78fef..66701f38a 100644 --- a/docs/reference/nodejs/secrets/secret-put.mdx +++ b/docs/reference/nodejs/secrets/secret-put.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Store a new secret value" # Node.js - secret.put() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Secrets in Nitric start with the [Secrets docs](/secrets). + + Store a new secret value, creating a new [version](./secret-version) to store the value. ```javascript diff --git a/docs/reference/nodejs/secrets/secret-version-access.mdx b/docs/reference/nodejs/secrets/secret-version-access.mdx index 10e3cdb74..a0ee8d77d 100644 --- a/docs/reference/nodejs/secrets/secret-version-access.mdx +++ b/docs/reference/nodejs/secrets/secret-version-access.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Retrieves the value from # Node.js - secret.version.access() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Secrets in Nitric start with the [Secrets docs](/secrets). + + Retrieves the value from a version of a secret. ```javascript diff --git a/docs/reference/nodejs/secrets/secret-version.mdx b/docs/reference/nodejs/secrets/secret-version.mdx index 4b5314ee7..4b77fe491 100644 --- a/docs/reference/nodejs/secrets/secret-version.mdx +++ b/docs/reference/nodejs/secrets/secret-version.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Returns a reference to a # Node.js - secret.version() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Secrets in Nitric start with the [Secrets docs](/secrets). + + Returns a reference to a known version of a secret. ```javascript diff --git a/docs/reference/nodejs/secrets/secret.mdx b/docs/reference/nodejs/secrets/secret.mdx index 1738a4012..cabd21d5a 100644 --- a/docs/reference/nodejs/secrets/secret.mdx +++ b/docs/reference/nodejs/secrets/secret.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Creates a reference to a # Node.js - secret() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Secrets in Nitric start with the [Secrets docs](/secrets). + + Creates a reference to a secret in the secrets manager. ```javascript diff --git a/docs/reference/nodejs/sql/sql-connection-string.mdx b/docs/reference/nodejs/sql/sql-connection-string.mdx index 358f65657..8fbe97f1f 100644 --- a/docs/reference/nodejs/sql/sql-connection-string.mdx +++ b/docs/reference/nodejs/sql/sql-connection-string.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Returns the connection st # Node.js - sql.connectionString() + + This is reference documentation for the Nitric Node.js SDK. To learn about SQL + Databases in Nitric start with the [SQL docs](/sql). + + Returns the connection string for a SQL database at runtime. ```javascript diff --git a/docs/reference/nodejs/sql/sql.mdx b/docs/reference/nodejs/sql/sql.mdx index 6a8121449..4338ec859 100644 --- a/docs/reference/nodejs/sql/sql.mdx +++ b/docs/reference/nodejs/sql/sql.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Creates a reference to a # Node.js - sql() + + This is reference documentation for the Nitric Node.js SDK. To learn about SQL + Databases in Nitric start with the [SQL docs](/sql). + + Creates a reference to a SQL database. ```javascript diff --git a/docs/reference/nodejs/storage/bucket-file-delete.mdx b/docs/reference/nodejs/storage/bucket-file-delete.mdx index 35bb25106..101a0298f 100644 --- a/docs/reference/nodejs/storage/bucket-file-delete.mdx +++ b/docs/reference/nodejs/storage/bucket-file-delete.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Delete a file from a buck # Node.js - bucket.file.delete() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Buckets and Storage in Nitric start with the [Storage docs](/storage). + + Delete a file from a bucket. ```javascript diff --git a/docs/reference/nodejs/storage/bucket-file-downloadurl.mdx b/docs/reference/nodejs/storage/bucket-file-downloadurl.mdx index 20457b492..4809df3c3 100644 --- a/docs/reference/nodejs/storage/bucket-file-downloadurl.mdx +++ b/docs/reference/nodejs/storage/bucket-file-downloadurl.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Get a download url for a # Node.js - bucket.file.getDownloadUrl() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Buckets and Storage in Nitric start with the [Storage docs](/storage). + + Create a download url for a file within a bucket. ```javascript diff --git a/docs/reference/nodejs/storage/bucket-file-exists.mdx b/docs/reference/nodejs/storage/bucket-file-exists.mdx index 34a21e6b4..f0a7b8a93 100644 --- a/docs/reference/nodejs/storage/bucket-file-exists.mdx +++ b/docs/reference/nodejs/storage/bucket-file-exists.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Determine if a file exist # Node.js - bucket.file.exists() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Buckets and Storage in Nitric start with the [Storage docs](/storage). + + Determine if a file exists in a bucket. ```javascript diff --git a/docs/reference/nodejs/storage/bucket-file-read.mdx b/docs/reference/nodejs/storage/bucket-file-read.mdx index 8c7452949..096131cab 100644 --- a/docs/reference/nodejs/storage/bucket-file-read.mdx +++ b/docs/reference/nodejs/storage/bucket-file-read.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Read the contents of a fi # Node.js - bucket.file.read() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Buckets and Storage in Nitric start with the [Storage docs](/storage). + + Read the contents of a file from a bucket. ```javascript diff --git a/docs/reference/nodejs/storage/bucket-file-uploadurl.mdx b/docs/reference/nodejs/storage/bucket-file-uploadurl.mdx index 9dddc0af8..defa7dc70 100644 --- a/docs/reference/nodejs/storage/bucket-file-uploadurl.mdx +++ b/docs/reference/nodejs/storage/bucket-file-uploadurl.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Get an upload URL for a f # Node.js - bucket.file.getUploadUrl() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Buckets and Storage in Nitric start with the [Storage docs](/storage). + + Create an upload URL for a file within a bucket. ```javascript diff --git a/docs/reference/nodejs/storage/bucket-file-write.mdx b/docs/reference/nodejs/storage/bucket-file-write.mdx index 3135eb877..0d307e3be 100644 --- a/docs/reference/nodejs/storage/bucket-file-write.mdx +++ b/docs/reference/nodejs/storage/bucket-file-write.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Write a file to a bucket. # Node.js - bucket.file.write() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Buckets and Storage in Nitric start with the [Storage docs](/storage). + + Write a file to a bucket. ```javascript diff --git a/docs/reference/nodejs/storage/bucket-file.mdx b/docs/reference/nodejs/storage/bucket-file.mdx index 778a54e5a..971560786 100644 --- a/docs/reference/nodejs/storage/bucket-file.mdx +++ b/docs/reference/nodejs/storage/bucket-file.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Create a reference to a f # Node.js - bucket.file() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Buckets and Storage in Nitric start with the [Storage docs](/storage). + + Create a reference to a file within a bucket. ```javascript diff --git a/docs/reference/nodejs/storage/bucket-files.mdx b/docs/reference/nodejs/storage/bucket-files.mdx index 0f331a670..507d53d07 100644 --- a/docs/reference/nodejs/storage/bucket-files.mdx +++ b/docs/reference/nodejs/storage/bucket-files.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Get a list of file refere # Node.js - bucket.files() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Buckets and Storage in Nitric start with the [Storage docs](/storage). + + Get a list of file references for files that exist in the bucket. ```javascript diff --git a/docs/reference/nodejs/storage/bucket-on.mdx b/docs/reference/nodejs/storage/bucket-on.mdx index 80181ba3f..4870dfab9 100644 --- a/docs/reference/nodejs/storage/bucket-on.mdx +++ b/docs/reference/nodejs/storage/bucket-on.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Create a new bucket notif # Node.js - bucket.on() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Buckets and Storage in Nitric start with the [Storage docs](/storage). + + Create a new bucket notification trigger when certain files are created or deleted. ```javascript diff --git a/docs/reference/nodejs/storage/bucket.mdx b/docs/reference/nodejs/storage/bucket.mdx index 33bce79a0..1add89c15 100644 --- a/docs/reference/nodejs/storage/bucket.mdx +++ b/docs/reference/nodejs/storage/bucket.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Create a new bucket for s # Node.js - bucket() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Buckets and Storage in Nitric start with the [Storage docs](/storage). + + Create a new bucket for storing and retrieving files. ```javascript diff --git a/docs/reference/nodejs/topic/topic-publish.mdx b/docs/reference/nodejs/topic/topic-publish.mdx index a8fc3fa7c..d97d6aa0b 100644 --- a/docs/reference/nodejs/topic/topic-publish.mdx +++ b/docs/reference/nodejs/topic/topic-publish.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Publish new events to the # Node.js - topic.publish() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Topics in Nitric start with the [Async Messaging docs](/messaging#topics). + + Publish an event (push based message) to a topic. ```javascript diff --git a/docs/reference/nodejs/topic/topic-subscribe.mdx b/docs/reference/nodejs/topic/topic-subscribe.mdx index 8ea24481e..67d380f65 100644 --- a/docs/reference/nodejs/topic/topic-subscribe.mdx +++ b/docs/reference/nodejs/topic/topic-subscribe.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Subscribe a handler to a # Node.js - topic.subscribe() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Topics in Nitric start with the [Async Messaging docs](/messaging#topics). + + Subscribe a handler to a topic and receive new events for processing. ```javascript diff --git a/docs/reference/nodejs/topic/topic.mdx b/docs/reference/nodejs/topic/topic.mdx index 9f24d5e46..70c6f0713 100644 --- a/docs/reference/nodejs/topic/topic.mdx +++ b/docs/reference/nodejs/topic/topic.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Creates a new Topic." # Node.js - topic() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Topics in Nitric start with the [Async Messaging docs](/messaging#topics). + + Creates a new Topic. ```javascript diff --git a/docs/reference/nodejs/websocket/websocket-close.mdx b/docs/reference/nodejs/websocket/websocket-close.mdx index f965a4f63..90aebe600 100644 --- a/docs/reference/nodejs/websocket/websocket-close.mdx +++ b/docs/reference/nodejs/websocket/websocket-close.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Close a connection to a w # Node.js - websocket.close() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Websockets in Nitric start with the [Websockets docs](/websockets). + + Closes a connection to a websocket ```javascript diff --git a/docs/reference/nodejs/websocket/websocket-on.mdx b/docs/reference/nodejs/websocket/websocket-on.mdx index db19e474c..f954ae573 100644 --- a/docs/reference/nodejs/websocket/websocket-on.mdx +++ b/docs/reference/nodejs/websocket/websocket-on.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Register a handler for co # Node.js - websocket.on() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Websockets in Nitric start with the [Websockets docs](/websockets). + + Register a handler for connections, disconnections, or messages for the websocket. ```javascript diff --git a/docs/reference/nodejs/websocket/websocket-send.mdx b/docs/reference/nodejs/websocket/websocket-send.mdx index fc3b31818..aafdd8def 100644 --- a/docs/reference/nodejs/websocket/websocket-send.mdx +++ b/docs/reference/nodejs/websocket/websocket-send.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Send a message to a conne # Node.js - websocket.send() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Websockets in Nitric start with the [Websockets docs](/websockets). + + Send a message to a connected websocket client. ```javascript diff --git a/docs/reference/nodejs/websocket/websocket.mdx b/docs/reference/nodejs/websocket/websocket.mdx index 4393c876d..32cf9dec9 100644 --- a/docs/reference/nodejs/websocket/websocket.mdx +++ b/docs/reference/nodejs/websocket/websocket.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Node.js library - Create Websockets with th # Node.js - websocket() + + This is reference documentation for the Nitric Node.js SDK. To learn about + Websockets in Nitric start with the [Websockets docs](/websockets). + + Creates a new Websocket. ```javascript diff --git a/docs/reference/python/api/api-all.mdx b/docs/reference/python/api/api-all.mdx index e871e1031..b9053d933 100644 --- a/docs/reference/python/api/api-all.mdx +++ b/docs/reference/python/api/api-all.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Register an API route that # Python - api.all() + + This is reference documentation for the Nitric Python SDK. To learn about APIs + in Nitric start with the [API docs](/apis). + + Register an API route that handles all HTTP verbs on that route. ```python diff --git a/docs/reference/python/api/api-delete.mdx b/docs/reference/python/api/api-delete.mdx index 74aeda625..1d32e8fc2 100644 --- a/docs/reference/python/api/api-delete.mdx +++ b/docs/reference/python/api/api-delete.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Register an API route and # Python - api.delete() + + This is reference documentation for the Nitric Python SDK. To learn about APIs + in Nitric start with the [API docs](/apis). + + Register an API route and set a specific HTTP DELETE handler on that route. ```python diff --git a/docs/reference/python/api/api-get.mdx b/docs/reference/python/api/api-get.mdx index b557d03fc..9d96cc61e 100644 --- a/docs/reference/python/api/api-get.mdx +++ b/docs/reference/python/api/api-get.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Register an API route and # Python - api.get() + + This is reference documentation for the Nitric Python SDK. To learn about APIs + in Nitric start with the [API docs](/apis). + + Register an API route and set a specific HTTP GET handler on that route. ```python diff --git a/docs/reference/python/api/api-methods.mdx b/docs/reference/python/api/api-methods.mdx index fc6b6ea39..502d421b2 100644 --- a/docs/reference/python/api/api-methods.mdx +++ b/docs/reference/python/api/api-methods.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Register an API route that # Python - api.methods() + + This is reference documentation for the Nitric Python SDK. To learn about APIs + in Nitric start with the [API docs](/apis). + + Register an API route that handles a set of specific HTTP verbs. ```python diff --git a/docs/reference/python/api/api-patch.mdx b/docs/reference/python/api/api-patch.mdx index 0ed10d9d7..3d36140f8 100644 --- a/docs/reference/python/api/api-patch.mdx +++ b/docs/reference/python/api/api-patch.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Register an API route and # Python - api.patch() + + This is reference documentation for the Nitric Python SDK. To learn about APIs + in Nitric start with the [API docs](/apis). + + Register an API route and set a specific HTTP PATCH handler on that route. ```python diff --git a/docs/reference/python/api/api-post.mdx b/docs/reference/python/api/api-post.mdx index a46fa83cd..5313c8318 100644 --- a/docs/reference/python/api/api-post.mdx +++ b/docs/reference/python/api/api-post.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Register a handler for HTT # Python - api.route.post() + + This is reference documentation for the Nitric Python SDK. To learn about APIs + in Nitric start with the [API docs](/apis). + + Register an API route and set a specific HTTP POST handler on that route. ```python diff --git a/docs/reference/python/api/api-put.mdx b/docs/reference/python/api/api-put.mdx index 529777b3e..c1445e185 100644 --- a/docs/reference/python/api/api-put.mdx +++ b/docs/reference/python/api/api-put.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Register a handler for HTT # Python - api.route.put() + + This is reference documentation for the Nitric Python SDK. To learn about APIs + in Nitric start with the [API docs](/apis). + + Register an API route and set a specific HTTP PUT handler on that route. ```python diff --git a/docs/reference/python/api/api.mdx b/docs/reference/python/api/api.mdx index 0a1f7e61c..3eddea233 100644 --- a/docs/reference/python/api/api.mdx +++ b/docs/reference/python/api/api.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Create APIs with the Nitri # Python - api() + + This is reference documentation for the Nitric Python SDK. To learn about APIs + in Nitric start with the [API docs](/apis). + + Creates a new HTTP API. ```python diff --git a/docs/reference/python/batch/job-handler.mdx b/docs/reference/python/batch/job-handler.mdx index 6a431ad4f..002af3df6 100644 --- a/docs/reference/python/batch/job-handler.mdx +++ b/docs/reference/python/batch/job-handler.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Register a job handler to # Python - job.handler() + + This is reference documentation for the Nitric Python SDK. To learn about + Batch Services in Nitric start with the [Batch docs](/batch). + + Job handlers are the code that is run when a job request is submitted. These handlers should be written in a separate file to your services. ```python diff --git a/docs/reference/python/batch/job-submit.mdx b/docs/reference/python/batch/job-submit.mdx index 17a23a9b8..9a1ac9d7d 100644 --- a/docs/reference/python/batch/job-submit.mdx +++ b/docs/reference/python/batch/job-submit.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Submit a batch job request w # Python - job.submit() + + This is reference documentation for the Nitric Python SDK. To learn about + Batch Services in Nitric start with the [Batch docs](/batch). + + Jobs may be submitted from Nitric `services` or other `batches` using the `submit` method on the job reference. When submitting a job you can provide a payload that will be passed to the job handler function. ```python diff --git a/docs/reference/python/batch/job.mdx b/docs/reference/python/batch/job.mdx index 018eceb3d..b17691876 100644 --- a/docs/reference/python/batch/job.mdx +++ b/docs/reference/python/batch/job.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Create Batch Jobs with the # Python - job() + + This is reference documentation for the Nitric Python SDK. To learn about + Batch Services in Nitric start with the [Batch docs](/batch). + + Creates a new Batch Job. ```python diff --git a/docs/reference/python/index.mdx b/docs/reference/python/index.mdx index 850e18c80..2aa6f1c28 100644 --- a/docs/reference/python/index.mdx +++ b/docs/reference/python/index.mdx @@ -8,6 +8,12 @@ This SDK reference provides documentation for the services and methods in Nitric The library provides the ability to define and interact with cloud resources, as well as build application logic like services/handlers. + + This is reference documentation for the Nitric Python SDK. If you're just + learning Nitric, we recommend starting with the + [Quickstart](/get-started/quickstart) guide. + + ## Installation If you used a Nitric starter template for Python to scaffold your project, then `nitric` will already be included in the dependencies in your `Pipfile`. Using starter templates is the recommended installation option since it ensures the other files and configuration needed are also set up. diff --git a/docs/reference/python/keyvalue/keyvalue-delete.mdx b/docs/reference/python/keyvalue/keyvalue-delete.mdx index 5caa7bbeb..ee18a738b 100644 --- a/docs/reference/python/keyvalue/keyvalue-delete.mdx +++ b/docs/reference/python/keyvalue/keyvalue-delete.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Delete key from a key valu # Python - kv.delete() + + This is reference documentation for the Nitric Python SDK. To learn about + Key/Value Stores in Nitric start with the [Key/Value Store docs](/keyvalue). + + Delete key from a key value store. ```python diff --git a/docs/reference/python/keyvalue/keyvalue-get.mdx b/docs/reference/python/keyvalue/keyvalue-get.mdx index 310d6ce64..dfb10c0e6 100644 --- a/docs/reference/python/keyvalue/keyvalue-get.mdx +++ b/docs/reference/python/keyvalue/keyvalue-get.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Get a value from a key val # Python - kv.get() + + This is reference documentation for the Nitric Python SDK. To learn about + Key/Value Stores in Nitric start with the [Key/Value Store docs](/keyvalue). + + Get a value from a key value store. ```python diff --git a/docs/reference/python/keyvalue/keyvalue-keys.mdx b/docs/reference/python/keyvalue/keyvalue-keys.mdx index c9b1f1f4c..4ea8c4fda 100644 --- a/docs/reference/python/keyvalue/keyvalue-keys.mdx +++ b/docs/reference/python/keyvalue/keyvalue-keys.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - List keys in a key value s # Python - kv.keys() + + This is reference documentation for the Nitric Python SDK. To learn about + Key/Value Stores in Nitric start with the [Key/Value Store docs](/keyvalue). + + Get a value from a key value store. ```python diff --git a/docs/reference/python/keyvalue/keyvalue-set.mdx b/docs/reference/python/keyvalue/keyvalue-set.mdx index 24ce97c82..aa1bd0b36 100644 --- a/docs/reference/python/keyvalue/keyvalue-set.mdx +++ b/docs/reference/python/keyvalue/keyvalue-set.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Store a key value pair in # Python - kv.set() + + This is reference documentation for the Nitric Python SDK. To learn about + Key/Value Stores in Nitric start with the [Key/Value Store docs](/keyvalue). + + Store a key value pair in a key value store. ```python diff --git a/docs/reference/python/keyvalue/keyvalue.mdx b/docs/reference/python/keyvalue/keyvalue.mdx index 33868d530..1958d9dad 100644 --- a/docs/reference/python/keyvalue/keyvalue.mdx +++ b/docs/reference/python/keyvalue/keyvalue.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Creates a new key value st # Python - kv() + + This is reference documentation for the Nitric Python SDK. To learn about + Key/Value Stores in Nitric start with the [Key/Value Store docs](/keyvalue). + + Creates a new key value store to get, set, and delete key value pairs. ```python diff --git a/docs/reference/python/queues/queue-dequeue.mdx b/docs/reference/python/queues/queue-dequeue.mdx index b30b3a8f5..27296836d 100644 --- a/docs/reference/python/queues/queue-dequeue.mdx +++ b/docs/reference/python/queues/queue-dequeue.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Dequeue messages." # Python - queue.dequeue() + + This is reference documentation for the Nitric Python SDK. To learn about + Queues in Nitric start with the [Async Messaging docs](/messaging#queues). + + Dequeue messages. ```python diff --git a/docs/reference/python/queues/queue-enqueue.mdx b/docs/reference/python/queues/queue-enqueue.mdx index c47a66076..63dd961fd 100644 --- a/docs/reference/python/queues/queue-enqueue.mdx +++ b/docs/reference/python/queues/queue-enqueue.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Send messages to a queue." # Python - queue.enqueue() + + This is reference documentation for the Nitric Python SDK. To learn about + Queues in Nitric start with the [Async Messaging docs](/messaging#queues). + + Sends messages to a queue. ```python diff --git a/docs/reference/python/queues/queue.mdx b/docs/reference/python/queues/queue.mdx index 1a47e230b..57f8ed09e 100644 --- a/docs/reference/python/queues/queue.mdx +++ b/docs/reference/python/queues/queue.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Creates a new Queue to pro # Python - queue() + + This is reference documentation for the Nitric Python SDK. To learn about + Queues in Nitric start with the [Async Messaging docs](/messaging#queues). + + Creates a new Queue to process asynchronous messages. ```python diff --git a/docs/reference/python/schedule/schedule.mdx b/docs/reference/python/schedule/schedule.mdx index 9ce696e0f..9297ef8db 100644 --- a/docs/reference/python/schedule/schedule.mdx +++ b/docs/reference/python/schedule/schedule.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Creates a new Schedule to # Python - schedule() + + This is reference documentation for the Nitric Python SDK. To learn about + Schedules in Nitric start with the [Schedule docs](/schedules). + + Creates a new Schedule to run a function on a defined frequency. ```python diff --git a/docs/reference/python/secrets/secret-latest.mdx b/docs/reference/python/secrets/secret-latest.mdx index cb1991b9e..72be62bb1 100644 --- a/docs/reference/python/secrets/secret-latest.mdx +++ b/docs/reference/python/secrets/secret-latest.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Returns a reference to the # Python - secret.latest() + + This is reference documentation for the Nitric Python SDK. To learn about + Secrets in Nitric start with the [Secrets docs](/secrets). + + Returns a reference to the `latest` version of a secret, regardless of that version's ID. ```python diff --git a/docs/reference/python/secrets/secret-put.mdx b/docs/reference/python/secrets/secret-put.mdx index 4eddd1561..e66912a42 100644 --- a/docs/reference/python/secrets/secret-put.mdx +++ b/docs/reference/python/secrets/secret-put.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Store a new secret value." # Python - secret.put() + + This is reference documentation for the Nitric Python SDK. To learn about + Secrets in Nitric start with the [Secrets docs](/secrets). + + Store a new secret value, creating a new [version](./secret-version) to store the value. ```python diff --git a/docs/reference/python/secrets/secret-version-access.mdx b/docs/reference/python/secrets/secret-version-access.mdx index 17106374f..e3f5632d1 100644 --- a/docs/reference/python/secrets/secret-version-access.mdx +++ b/docs/reference/python/secrets/secret-version-access.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Retrieves the value from a # Python - secret.version.access() + + This is reference documentation for the Nitric Python SDK. To learn about + Secrets in Nitric start with the [Secrets docs](/secrets). + + Retrieves the value from a version of a secret. ```python diff --git a/docs/reference/python/secrets/secret-version.mdx b/docs/reference/python/secrets/secret-version.mdx index 54a02b0cf..8220dbe5c 100644 --- a/docs/reference/python/secrets/secret-version.mdx +++ b/docs/reference/python/secrets/secret-version.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Returns a reference to a k # Python - secret.version() + + This is reference documentation for the Nitric Python SDK. To learn about + Secrets in Nitric start with the [Secrets docs](/secrets). + + Returns a reference to a known version of a secret. ```python diff --git a/docs/reference/python/secrets/secret.mdx b/docs/reference/python/secrets/secret.mdx index 764c41121..9b67a3986 100644 --- a/docs/reference/python/secrets/secret.mdx +++ b/docs/reference/python/secrets/secret.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Creates a reference to a s # Python - secret() + + This is reference documentation for the Nitric Python SDK. To learn about + Secrets in Nitric start with the [Secrets docs](/secrets). + + Creates a reference to a secret in the secrets manager. ```python diff --git a/docs/reference/python/sql/sql-connection-string.mdx b/docs/reference/python/sql/sql-connection-string.mdx index af0589c6d..e896963af 100644 --- a/docs/reference/python/sql/sql-connection-string.mdx +++ b/docs/reference/python/sql/sql-connection-string.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Returns the connection str # Python - sql.connection_string() + + This is reference documentation for the Nitric Python SDK. To learn about SQL + Databases in Nitric start with the [SQL docs](/sql). + + Returns the connection string for a SQL database at runtime. ```python diff --git a/docs/reference/python/sql/sql.mdx b/docs/reference/python/sql/sql.mdx index cd61c6258..c30379115 100644 --- a/docs/reference/python/sql/sql.mdx +++ b/docs/reference/python/sql/sql.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Creates a reference to a S # Python - sql() + + This is reference documentation for the Nitric Python SDK. To learn about SQL + Databases in Nitric start with the [SQL docs](/sql). + + Creates a reference to a SQL database. ```python diff --git a/docs/reference/python/storage/bucket-file-delete.mdx b/docs/reference/python/storage/bucket-file-delete.mdx index e6b834f87..afc0d1c24 100644 --- a/docs/reference/python/storage/bucket-file-delete.mdx +++ b/docs/reference/python/storage/bucket-file-delete.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Delete a file from a bucke # Python - bucket.file.delete() + + This is reference documentation for the Nitric Python SDK. To learn about + Buckets and Storage in Nitric start with the [Storage docs](/storage). + + Deletes a file within a bucket. ```python diff --git a/docs/reference/python/storage/bucket-file-downloadurl.mdx b/docs/reference/python/storage/bucket-file-downloadurl.mdx index 3e6d4ff82..e4f4f03aa 100644 --- a/docs/reference/python/storage/bucket-file-downloadurl.mdx +++ b/docs/reference/python/storage/bucket-file-downloadurl.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Create a signed URL for re # Python - bucket.file.download_url() + + This is reference documentation for the Nitric Python SDK. To learn about + Buckets and Storage in Nitric start with the [Storage docs](/storage). + + Create a signed url for read access to a file. ```python diff --git a/docs/reference/python/storage/bucket-file-read.mdx b/docs/reference/python/storage/bucket-file-read.mdx index ac79c186c..0180f0915 100644 --- a/docs/reference/python/storage/bucket-file-read.mdx +++ b/docs/reference/python/storage/bucket-file-read.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Read the contents of a fil # Python - bucket.file.read() + + This is reference documentation for the Nitric Python SDK. To learn about + Buckets and Storage in Nitric start with the [Storage docs](/storage). + + Read a file from a bucket. ```python diff --git a/docs/reference/python/storage/bucket-file-uploadurl.mdx b/docs/reference/python/storage/bucket-file-uploadurl.mdx index fb4998bfd..8812b5e5e 100644 --- a/docs/reference/python/storage/bucket-file-uploadurl.mdx +++ b/docs/reference/python/storage/bucket-file-uploadurl.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Create a signed URL for wr # Python - bucket.file.upload_url() + + This is reference documentation for the Nitric Python SDK. To learn about + Buckets and Storage in Nitric start with the [Storage docs](/storage). + + Create a signed url for write access to a file. ```python diff --git a/docs/reference/python/storage/bucket-file-write.mdx b/docs/reference/python/storage/bucket-file-write.mdx index d696f2319..4692f753f 100644 --- a/docs/reference/python/storage/bucket-file-write.mdx +++ b/docs/reference/python/storage/bucket-file-write.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Write a file to a bucket." # Python - bucket.file.write() + + This is reference documentation for the Nitric Python SDK. To learn about + Buckets and Storage in Nitric start with the [Storage docs](/storage). + + Write a file to a bucket. ```python diff --git a/docs/reference/python/storage/bucket-file.mdx b/docs/reference/python/storage/bucket-file.mdx index 4726acbfc..9d6adc360 100644 --- a/docs/reference/python/storage/bucket-file.mdx +++ b/docs/reference/python/storage/bucket-file.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Create a reference to a fi # Python - bucket.file() + + This is reference documentation for the Nitric Python SDK. To learn about + Buckets and Storage in Nitric start with the [Storage docs](/storage). + + Create a reference to a file within a bucket. ```python diff --git a/docs/reference/python/storage/bucket-files.mdx b/docs/reference/python/storage/bucket-files.mdx index d7867ba8e..3f709c754 100644 --- a/docs/reference/python/storage/bucket-files.mdx +++ b/docs/reference/python/storage/bucket-files.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Get a list of file referen # Python - bucket.files() + + This is reference documentation for the Nitric Python SDK. To learn about + Buckets and Storage in Nitric start with the [Storage docs](/storage). + + Get a list of file references for files that exist on the bucket. ```python diff --git a/docs/reference/python/storage/bucket-on.mdx b/docs/reference/python/storage/bucket-on.mdx index f7223d5f5..603427fc7 100644 --- a/docs/reference/python/storage/bucket-on.mdx +++ b/docs/reference/python/storage/bucket-on.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Create a new bucket notifi # Python - bucket.on() + + This is reference documentation for the Nitric Python SDK. To learn about + Buckets and Storage in Nitric start with the [Storage docs](/storage). + + Create a new bucket notification trigger when certain files are created or deleted. ```python diff --git a/docs/reference/python/storage/bucket.mdx b/docs/reference/python/storage/bucket.mdx index acfab46e6..eaf781757 100644 --- a/docs/reference/python/storage/bucket.mdx +++ b/docs/reference/python/storage/bucket.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Create a new bucket for st # Python - bucket() + + This is reference documentation for the Nitric Python SDK. To learn about + Buckets and Storage in Nitric start with the [Storage docs](/storage). + + Create a new bucket for storing and retrieving files. ```python diff --git a/docs/reference/python/topic/topic-publish.mdx b/docs/reference/python/topic/topic-publish.mdx index 61d73009c..d22d25dd8 100644 --- a/docs/reference/python/topic/topic-publish.mdx +++ b/docs/reference/python/topic/topic-publish.mdx @@ -4,6 +4,12 @@ description: "Reference for Nitric's Python library - Publish new events to the # Python - topic.publish() + + This is reference documentation for the Nitric Python SDK. To learn about + Topics and Pub/Sub in Nitric start with the [Async Messaging + docs](/messaging#topics). + + Publishes a topic. ```python diff --git a/docs/reference/python/topic/topic-subscribe.mdx b/docs/reference/python/topic/topic-subscribe.mdx index 61503930a..a4da003bd 100644 --- a/docs/reference/python/topic/topic-subscribe.mdx +++ b/docs/reference/python/topic/topic-subscribe.mdx @@ -4,6 +4,12 @@ description: "Reference for Nitric's Python library - Subscribe a handler to a t # Python - topic.subscribe() + + This is reference documentation for the Nitric Python SDK. To learn about + Topics and Pub/Sub in Nitric start with the [Async Messaging + docs](/messaging#topics). + + Subscribes to a topic. ```python diff --git a/docs/reference/python/topic/topic.mdx b/docs/reference/python/topic/topic.mdx index bda652cd7..99e38ebb3 100644 --- a/docs/reference/python/topic/topic.mdx +++ b/docs/reference/python/topic/topic.mdx @@ -4,6 +4,12 @@ description: "Reference for Nitric's Python library - Creates a new Topic." # Python - topic() + + This is reference documentation for the Nitric Python SDK. To learn about + Topics and Pub/Sub in Nitric start with the [Async Messaging + docs](/messaging#topics). + + Creates a new Topic. ```python diff --git a/docs/reference/python/websocket/websocket-on.mdx b/docs/reference/python/websocket/websocket-on.mdx index d3fc81e15..c95c7e5d9 100644 --- a/docs/reference/python/websocket/websocket-on.mdx +++ b/docs/reference/python/websocket/websocket-on.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Register a handler for Web # Python - websocket.on() + + This is reference documentation for the Nitric Python SDK. To learn about + Websockets in Nitric start with the [Websockets docs](/websockets). + + Register a handler for a specific websocket event. ```python diff --git a/docs/reference/python/websocket/websocket-send.mdx b/docs/reference/python/websocket/websocket-send.mdx index e0e8cf831..60a7cbaec 100644 --- a/docs/reference/python/websocket/websocket-send.mdx +++ b/docs/reference/python/websocket/websocket-send.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Send a message to a connec # Python - websocket.send() + + This is reference documentation for the Nitric Python SDK. To learn about + Websockets in Nitric start with the [Websockets docs](/websockets). + + Send a message to a connected websocket client. ```python diff --git a/docs/reference/python/websocket/websocket.mdx b/docs/reference/python/websocket/websocket.mdx index 865ecb740..0bc237c15 100644 --- a/docs/reference/python/websocket/websocket.mdx +++ b/docs/reference/python/websocket/websocket.mdx @@ -4,6 +4,11 @@ description: "Reference for Nitric's Python library - Create Websockets with the # Python - websocket() + + This is reference documentation for the Nitric Python SDK. To learn about + Websockets in Nitric start with the [Websockets docs](/websockets). + + Creates a new Websocket API. ```python diff --git a/next-env.d.ts b/next-env.d.ts index 40c3d6809..725dd6f24 100644 --- a/next-env.d.ts +++ b/next-env.d.ts @@ -1,5 +1,6 @@ /// /// +/// // NOTE: This file should not be edited // see https://nextjs.org/docs/app/building-your-application/configuring/typescript for more information.