Skip to content

Commit 737f563

Browse files
raksivHomelessDinosaur
authored andcommitted
add sdk docs back links
1 parent 53e82c9 commit 737f563

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+249
-0
lines changed

docs/reference/csharp/api/api-delete.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: "Reference for Nitric's .NET library - Register an API route and se
44

55
# .NET - Api.Delete()
66

7+
<Note>
8+
This is reference documentation for the Nitric .NET SDK. To learn about APIs
9+
in Nitric start with the [API docs](/api).
10+
</Note>
11+
712
Register an API route and set a specific HTTP DELETE handler on that route.
813

914
<Note>

docs/reference/csharp/api/api-get.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: "Reference for Nitric's .NET library - Register an API route and se
44

55
# .NET - Api.Get()
66

7+
<Note>
8+
This is reference documentation for the Nitric .NET SDK. To learn about APIs
9+
in Nitric start with the [API docs](/api).
10+
</Note>
11+
712
Register an API route and set a specific HTTP GET handler on that route.
813

914
<Note>

docs/reference/csharp/api/api-patch.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: "Reference for Nitric's .NET library - Register an API route and se
44

55
# .NET - Api.Patch()
66

7+
<Note>
8+
This is reference documentation for the Nitric .NET SDK. To learn about APIs
9+
in Nitric start with the [API docs](/api).
10+
</Note>
11+
712
Register an API route and set a specific HTTP PATCH handler on that route.
813

914
<Note>

docs/reference/csharp/api/api-post.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: "Reference for Nitric's .NET library - Register an API route and se
44

55
# .NET - Api.Post()
66

7+
<Note>
8+
This is reference documentation for the Nitric .NET SDK. To learn about APIs
9+
in Nitric start with the [API docs](/api).
10+
</Note>
11+
712
Register an API route and set a specific HTTP POST handler on that route.
813

914
<Note>

docs/reference/csharp/api/api-put.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: "Reference for Nitric's .NET library - Register an API route and se
44

55
# .NET - Api.Put()
66

7+
<Note>
8+
This is reference documentation for the Nitric .NET SDK. To learn about APIs
9+
in Nitric start with the [API docs](/api).
10+
</Note>
11+
712
Register an API route and set a specific HTTP PUT handler on that route.
813

914
<Note>

docs/reference/csharp/api/api-route-all.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: "Reference for Nitric's .NET library - Register a single handler fo
44

55
# .NET - Api.Route.All()
66

7+
<Note>
8+
This is reference documentation for the Nitric .NET SDK. To learn about APIs
9+
in Nitric start with the [API docs](/api).
10+
</Note>
11+
712
Register a single handler for all HTTP Methods (GET, POST, PUT, DELETE, PATCH) on the route.
813

914
```csharp

docs/reference/csharp/api/api-route-delete.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: "Reference for Nitric's v0 .NET library - Register a handler for HT
44

55
# .NET - api.route.delete()
66

7+
<Note>
8+
This is reference documentation for the Nitric .NET SDK. To learn about APIs
9+
in Nitric start with the [API docs](/api).
10+
</Note>
11+
712
Register a handler for HTTP DELETE requests to the route.
813

914
```csharp

docs/reference/csharp/api/api-route-get.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: "Reference for Nitric's .NET library - Register a handler for HTTP
44

55
# .NET - Api.Route.Get()
66

7+
<Note>
8+
This is reference documentation for the Nitric .NET SDK. To learn about APIs
9+
in Nitric start with the [API docs](/api).
10+
</Note>
11+
712
Register a handler for HTTP GET requests to the route.
813

914
```csharp

docs/reference/csharp/api/api-route-patch.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: "Reference for Nitric's .NET library - Register a handler for HTTP
44

55
# .NET - Api.Route.Patch()
66

7+
<Note>
8+
This is reference documentation for the Nitric .NET SDK. To learn about APIs
9+
in Nitric start with the [API docs](/api).
10+
</Note>
11+
712
Register a handler for HTTP PATCH requests to the route.
813

914
```csharp

docs/reference/csharp/api/api-route-post.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: "Reference for Nitric's .NET library - Register a handler for HTTP
44

55
# .NET - Api.Route.Post()
66

7+
<Note>
8+
This is reference documentation for the Nitric .NET SDK. To learn about APIs
9+
in Nitric start with the [API docs](/api).
10+
</Note>
11+
712
Register a handler for HTTP POST requests to the route.
813

914
```csharp

docs/reference/csharp/api/api-route-put.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: "Reference for Nitric's .NET library - Register a handler for HTTP
44

55
# .NET - Api.Route.Put()
66

7+
<Note>
8+
This is reference documentation for the Nitric .NET SDK. To learn about APIs
9+
in Nitric start with the [API docs](/api).
10+
</Note>
11+
712
Register a handler for HTTP PUT requests to the route.
813

914
```csharp

docs/reference/csharp/api/api-route.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: "Reference for Nitric's .NET library - Creates a new route (path) w
44

55
# .NET - Api.Route()
66

7+
<Note>
8+
This is reference documentation for the Nitric .NET SDK. To learn about APIs
9+
in Nitric start with the [API docs](/api).
10+
</Note>
11+
712
Creates a new route (path) within an API.
813

914
```csharp

docs/reference/csharp/api/api.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: "Reference for Nitric's .NET library - Create APIs with the Nitric
44

55
# .NET - Api()
66

7+
<Note>
8+
This is reference documentation for the Nitric .NET SDK. To learn about APIs
9+
in Nitric start with the [API docs](/api).
10+
</Note>
11+
712
Creates a new HTTP API.
813

914
```csharp

docs/reference/csharp/batch/job-handler.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: "Reference for Nitric's .NET library - Register a job handler"
44

55
# .NET - Job.Handler()
66

7+
<Note>
8+
This is reference documentation for the Nitric .NET SDK. To learn about Batch
9+
Services in Nitric start with the [Batch docs](/batch).
10+
</Note>
11+
712
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.
813

914
```csharp

docs/reference/csharp/batch/job-submit.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: "Reference for Nitric's .NET library - Submit a batch job request w
44

55
# .NET - Job.Submit()
66

7+
<Note>
8+
This is reference documentation for the Nitric .NET SDK. To learn about Batch
9+
Services in Nitric start with the [Batch docs](/batch).
10+
</Note>
11+
712
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.
813

914
```csharp

docs/reference/csharp/batch/job.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: "Reference for Nitric's .NET library - Create Batch Jobs"
44

55
# .NET - Job()
66

7+
<Note>
8+
This is reference documentation for the Nitric .NET SDK. To learn about Batch
9+
Services in Nitric start with the [Batch docs](/batch).
10+
</Note>
11+
712
Creates a new Batch Job.
813

914
```csharp

docs/reference/csharp/index.mdx

+6
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ This SDK reference provides documentation for the functions and methods in Nitri
88

99
The library provides the ability to define and interact with cloud resources, as well as build application logic like functions/handlers.
1010

11+
<Note>
12+
This is reference documentation for the Nitric .NET SDK. If you're just
13+
learning Nitric, we recommend starting with the
14+
[Quickstart](/get-started/quickstart) guide.
15+
</Note>
16+
1117
## Installation
1218

1319
If you used a Nitric starter template for .NET to scaffold your project, then the `Nitric.Sdk` package will already be included in the dependencies in your `.csproj` file. Using starter templates is the recommended installation option since it ensures the other files and configuration needed are also set up.

docs/reference/csharp/keyvalue/keyvalue-delete.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: "Reference for Nitric's .NET library - Delete key from a key value
44

55
# .NET - Kv.Delete()
66

7+
<Note>
8+
This is reference documentation for the Nitric .NET SDK. To learn about
9+
Key/Value Stores in Nitric start with the [Key/Value Store docs](/keyvalue).
10+
</Note>
11+
712
Delete key from a key value store.
813

914
```csharp

docs/reference/csharp/keyvalue/keyvalue-get.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: "Reference for Nitric's .NET library - Get a value from a key value
44

55
# .NET - Kv.Get()
66

7+
<Note>
8+
This is reference documentation for the Nitric .NET SDK. To learn about
9+
Key/Value Stores in Nitric start with the [Key/Value Store docs](/keyvalue).
10+
</Note>
11+
712
Get a value from a key value store.
813

914
```csharp

docs/reference/csharp/keyvalue/keyvalue-keys.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: "Reference for Nitric's .NET library - Retrieve all or some of the
44

55
# .NET - Kv.Keys()
66

7+
<Note>
8+
This is reference documentation for the Nitric .NET SDK. To learn about
9+
Key/Value Stores in Nitric start with the [Key/Value Store docs](/keyvalue).
10+
</Note>
11+
712
Return an async iterable of keys in the store.
813

914
```csharp

docs/reference/csharp/keyvalue/keyvalue-set.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: "Reference for Nitric's .NET library - Store a key value pair in a
44

55
# .NET - Kv.Set()
66

7+
<Note>
8+
This is reference documentation for the Nitric .NET SDK. To learn about
9+
Key/Value Stores in Nitric start with the [Key/Value Store docs](/keyvalue).
10+
</Note>
11+
712
Store a key value pair in a key value store.
813

914
```csharp

docs/reference/csharp/keyvalue/keyvalue.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: "Reference for Nitric's .NET library - Creates a new key value stor
44

55
# .NET - KV()
66

7+
<Note>
8+
This is reference documentation for the Nitric .NET SDK. To learn about
9+
Key/Value Stores in Nitric start with the [Key/Value Store docs](/keyvalue).
10+
</Note>
11+
712
Creates a new key value store to get, set, and delete key value pairs.
813

914
```csharp

docs/reference/csharp/queues/queue-dequeue.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: "Reference for Nitric's .NET library - Receive tasks from a queue."
44

55
# .NET - Queue.Receive()
66

7+
<Note>
8+
This is reference documentation for the Nitric .NET SDK. To learn about Queues
9+
in Nitric start with the [Async Messaging docs](/messaging#queues).
10+
</Note>
11+
712
Receive tasks from a queue.
813

914
```csharp

docs/reference/csharp/queues/queue-enqueue.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: "Reference for Nitric's v0 .NET library - Send tasks to a queue."
44

55
# .NET - Queue.Send()
66

7+
<Note>
8+
This is reference documentation for the Nitric .NET SDK. To learn about Queues
9+
in Nitric start with the [Async Messaging docs](/messaging#queues).
10+
</Note>
11+
712
Send tasks to a queue.
813

914
```csharp

docs/reference/csharp/queues/queue.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: "Reference for Nitric's .NET library - Creates a new Queue to send
44

55
# .NET - Queue()
66

7+
<Note>
8+
This is reference documentation for the Nitric .NET SDK. To learn about Queues
9+
in Nitric start with the [Async Messaging docs](/messaging#queues).
10+
</Note>
11+
712
Creates a new Queue to send and receive asynchronous tasks.
813

914
```csharp

docs/reference/csharp/secrets/secret-latest.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: "Reference for Nitric's .NET library - Returns a reference to the l
44

55
# .NET - Secret.Latest()
66

7+
<Note>
8+
This is reference documentation for the Nitric .NET SDK. To learn about
9+
Secrets in Nitric start with the [Secrets docs](/secrets).
10+
</Note>
11+
712
Returns a reference to the `latest` version of a secret, regardless of that version's ID.
813

914
```csharp

docs/reference/csharp/secrets/secret-put.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: "Reference for Nitric's .NET library - Store a new secret value"
44

55
# .NET - Secret.Put()
66

7+
<Note>
8+
This is reference documentation for the Nitric .NET SDK. To learn about
9+
Secrets in Nitric start with the [Secrets docs](/secrets).
10+
</Note>
11+
712
Store a new secret value, creating a new [version](./secret-version) to store the value.
813

914
```csharp

docs/reference/csharp/secrets/secret-version-access.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: "Reference for Nitric's .NET library - Retrieves the value from a v
44

55
# .NET - Secret.Version.Access()
66

7+
<Note>
8+
This is reference documentation for the Nitric .NET SDK. To learn about
9+
Secrets in Nitric start with the [Secrets docs](/secrets).
10+
</Note>
11+
712
Retrieves the value from a version of a secret.
813

914
```csharp

docs/reference/csharp/secrets/secret-version.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: "Reference for Nitric's .NET library - Returns a reference to a kno
44

55
# .NET - Secret.Version()
66

7+
<Note>
8+
This is reference documentation for the Nitric .NET SDK. To learn about
9+
Secrets in Nitric start with the [Secrets docs](/secrets).
10+
</Note>
11+
712
Returns a reference to a known version of a secret.
813

914
```csharp

docs/reference/csharp/secrets/secret.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: "Reference for Nitric's .NET library - Creates a reference to a sec
44

55
# .NET - Secret()
66

7+
<Note>
8+
This is reference documentation for the Nitric .NET SDK. To learn about
9+
Secrets in Nitric start with the [Secrets docs](/secrets).
10+
</Note>
11+
712
Creates a reference to a secret in the secrets manager.
813

914
```csharp

docs/reference/csharp/sql/sql-connection-string.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: "Reference for Nitric's .NET library - Returns the connection strin
44

55
# .NET - Sql.ConnectionString()
66

7+
<Note>
8+
This is reference documentation for the Nitric .NET SDK. To learn about SQL
9+
Databases in Nitric start with the [SQL docs](/sql).
10+
</Note>
11+
712
Returns the connection string for a SQL database at runtime.
813

914
```csharp

docs/reference/csharp/sql/sql.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: "Reference for Nitric's .NET library - Creates a reference to a SQL
44

55
# .NET - Sql()
66

7+
<Note>
8+
This is reference documentation for the Nitric .NET SDK. To learn about SQL
9+
Databases in Nitric start with the [SQL docs](/sql).
10+
</Note>
11+
712
Creates a reference to a SQL database.
813

914
```csharp

docs/reference/csharp/storage/bucket-file-delete.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: "Reference for Nitric's .NET library - Delete a file from a bucket.
44

55
# .NET - Bucket.File.Delete()
66

7+
<Note>
8+
This is reference documentation for the Nitric .NET SDK. To learn about
9+
Buckets and Storage in Nitric start with the [Storage docs](/storage).
10+
</Note>
11+
712
Delete a file from a bucket.
813

914
```csharp

0 commit comments

Comments
 (0)