Skip to content
This repository was archived by the owner on May 20, 2025. It is now read-only.

Commit 3339705

Browse files
committed
edits
1 parent a14af0d commit 3339705

File tree

11 files changed

+35
-35
lines changed

11 files changed

+35
-35
lines changed

docs/architecture/apis.mdx

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,24 @@
22
description: 'Nitric API'
33
---
44

5-
# APIS
5+
# APIs
66

77
## 1. System Context
88

9-
**Developers** use Nitric to declare APIs and routes within their application.
9+
**Developers** use Nitric to define required APIs and routes/methods within their application.
1010

11-
- App code uses the [API resource](/apis) through defined endpoints.
12-
- Developers define API specifications and implement backend logic to handle HTTP requests.
11+
- App code uses the [API resource](/apis) to define APIs and their routes/methods.
12+
- Developers define API(s) their application requires, including the specifications and implement logic to handle HTTP requests.
13+
- Authentication, authorization, and middleware can be added to API routes to secure and enhance functionality.
1314

14-
**Operations** use default or overridden Terraform modules to provision the necessary resources for their target cloud.
15+
**Operations** use default or overridden IaC (e.g Terraform modules) to provision the necessary resources for their target cloud(s), such as API Gateways.
1516

1617
<details>
1718
<summary>Example AWS Provider</summary>
1819

1920
- **AWS API Gateway v2** serves as the HTTP API management service.
2021
- **AWS Lambda** functions are deployed to handle API requests.
21-
- **AWS IAM** (implicitly assumed) provides roles and policies for secure interaction between API Gateway and Lambda functions.
22+
- **AWS IAM** (automated using IaC) provides roles and policies for secure interaction between API Gateway and Lambda functions.
2223
- **AWS ACM** manages TLS certificates for custom domain names.
2324

2425
```mermaid
@@ -118,7 +119,7 @@ sequenceDiagram
118119

119120
## 4. Code
120121

121-
**Developers** write application code that uses the [API resource](/apis) from the SDK, configures the api and implement HTTP routes and middleware.
122+
**Developers** write application code that uses the [API resource](/apis) from the SDK, defining the APIs routes, methods, middleware and auth.
122123

123124
SDK Reference by language -
124125

docs/architecture/buckets.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,25 @@
22
description: 'C4 Buckets'
33
---
44

5-
# Storage - Buckets
5+
# Storage (Buckets/Object Storage)
66

77
## 1. System Context
88

9-
**Developers** use Nitric to declare buckets within their application.
9+
**Developers** use Nitric to define required buckets within their application.
1010

1111
- App code uses the [Bucket resource](/storage) from the Nitric SDK.
12-
- Developers configure buckets and implement application logic to securely access and manipulate bucket data.
13-
- Developers request the level of access they require for the bucket in their application logic e.g. read, write, delete.
14-
- Developers can implement handlers for on events such as read, write or delete.
12+
- Developers define buckets their application requires and implement logic to securely store/retrieve/delete files.
13+
- Developers _request_ the level of access they require for the bucket in their application logic e.g. read, write, delete.
14+
- Developers can implement handlers for file change events such as write or delete.
1515

16-
**Operations** use default or overridden Terraform modules to provision the necessary resources for their target cloud.
16+
**Operations** use default or overridden IaC (e.g Terraform modules) to provision the necessary resources for their target cloud.
1717

1818
<details>
1919
<summary>Example AWS Provider</summary>
2020

2121
- **AWS S3** serves as the storage backend.
2222
- **AWS Lambda** functions are used to process events triggered by S3.
23-
- **AWS IAM** provides roles and policies for secure access to S3 buckets and Lambda functions, enforcing least priviledge access based on the developers request.
23+
- **AWS IAM** provides roles and policies for secure access to S3 buckets and Lambda functions, enforcing least privilege access based on the developers request.
2424

2525
```mermaid
2626
flowchart TD
@@ -113,8 +113,8 @@ sequenceDiagram
113113

114114
- Ensures storage buckets have unique names by appending a randomly generated identifier. This avoids naming conflicts and aligns with best practices for globally accessible cloud resources.
115115
- Supports the addition of metadata tags for resource identification, management, and tracking, enabling better governance.
116-
- Configures storage bucket notifications to trigger functions or message queues based on specified events (e.g., object creation, update, or deletion).
117-
- Implements least privilege access by dynamically assigning permissions to functions or services that interact with the storage bucket.
116+
- Configures storage bucket notifications to trigger functions or message queues based on specified events (e.g., object update or deletion).
117+
- Implements least privilege access by only assigning requested permissions to functions or services that interact with the storage bucket.
118118
- Uses templates or dynamic blocks to handle multiple notification targets, allowing scalability and flexibility for different workflows.
119119

120120
## 4. Code

docs/architecture/keyvalue.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ description: 'Nitric Key/Value Store'
66

77
## 1. System Context
88

9-
**Developers** use Nitric to declare key/value stores within their application.
9+
**Developers** use Nitric to define required key/value stores within their application.
1010

1111
- App code uses the [Key/Value resource](/keyvalue) from the Nitric SDK.
12-
- Developers configure key/value stores and implement application logic to securely access and manipulate data.
12+
- Developers define key/value stores their application requires and implement logic to securely read/write/delete values with unique keys.
1313

14-
**Operations** use default or overridden Terraform modules to provision the necessary resources for their target cloud.
14+
**Operations** use default or overridden IaC (e.g Terraform modules) to provision the necessary resources for their target cloud.
1515

1616
<details>
1717
<summary>Example AWS Provider</summary>

docs/architecture/queues.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ description: 'Nitric Queue'
66

77
## 1. System Context
88

9-
**Developers** use Nitric to declare message queues within their application.
9+
**Developers** use Nitric to define required message queues within their application.
1010

1111
- App code uses the [Queue resource](/messaging#queues) from the Nitric SDK.
12-
- Developers configure queues and implement application logic to send and receive messages.
12+
- Developers define queues their application requires and implement application logic to send or receive messages.
1313

14-
**Operations** use default or overridden Terraform modules to provision the necessary resources for their target cloud.
14+
**Operations** use default or overridden IaC (e.g Terraform modules) to provision the necessary resources for their target cloud.
1515

1616
<details>
1717
<summary>Example AWS Provider</summary>

docs/architecture/schedules.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: 'Nitric Schedule'
66

77
## 1. System Context
88

9-
**Developers** use Nitric to declare scheduled tasks within their application.
9+
**Developers** use Nitric to defined scheduled tasks within their application.
1010

1111
- App code uses the [Schedule resource](/schedules) from the Nitric SDK.
1212
- Developers configure the schedule with CRON or rate expressions like '7 days' and implement application logic to be executed when triggered.

docs/architecture/secrets.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ description: 'Nitric Secret'
66

77
## 1. System Context
88

9-
**Developers** use Nitric to declare secrets within their application.
9+
**Developers** use Nitric to define required secrets within their application.
1010

1111
- App code uses the [Secrets resource](/secrets) from the Nitric SDK.
12-
- Developers configure secrets and implement application logic to securely access and manage these secrets.
12+
- Developers define secrets their application requires and implement logic to securely access and/or update secret values.
1313

14-
**Operations** use default or overridden Terraform modules to provision the necessary resources for their target cloud.
14+
**Operations** use default or overridden IaC (e.g Terraform modules) to provision the necessary resources for their target cloud.
1515

1616
<details>
1717
<summary>Example AWS Provider</summary>

docs/architecture/services.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ description: 'Service Deployment'
66

77
## 1. System Context
88

9-
**Developers** use Nitric to deploy services or functions within their application.
9+
**Developers** use Nitric to create services or functions within their application.
1010

1111
- Application code is written in files that matches the pattern(s) in the nitric.yaml config file.
1212
- The **Nitric CLI** builds container images for their Lambda functions and push them to a container registry.
1313

14-
**Operations** use default or overridden Terraform modules to provision the necessary resources for their target cloud.
14+
**Operations** use default or overridden IaC (e.g Terraform modules) to provision the necessary resources for their target cloud.
1515

1616
<details>
1717
<summary>Example AWS Provider</summary>

docs/architecture/sql.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: 'Nitric SQL'
66

77
## 1. System Context
88

9-
**Developers** use Nitric to declare databases within their application (e.g., referencing a Postgres or MySQL database).
9+
**Developers** use Nitric to define required databases within their application (e.g., referencing a Postgres or MySQL database).
1010

1111
- App code uses the [SQL database resources](/sql) from the Nitric SDK.
1212
- Developers can use any language specific client or ORM to interact with the databases.

docs/architecture/topics.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ description: 'Nitric Topic'
66

77
## 1. System Context
88

9-
**Developers** use Nitric to declare topics to enable event-driven communication within their application.
9+
**Developers** use Nitric to define required topics to enable event-driven communication within their application.
1010

1111
- App code interacts with the [Topic resource](/messaging#topics) through defined topics and subscriptions.
12-
- Developers configure topics and implement application logic to publish and consume messages.
12+
- Developers define topics their application requires and implement application logic to publish or subscribe to messages.
1313

14-
**Operations** use default or overridden Terraform modules to provision the necessary resources for their target cloud.
14+
**Operations** use default or overridden IaC (e.g Terraform modules) to provision the necessary resources for their target cloud.
1515

1616
<details>
1717
<summary>Example AWS Provider</summary>

docs/architecture/websockets.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ description: 'Nitric WebSocket API'
66

77
## 1. System Context
88

9-
**Developers** use Nitric to declare WebSocket APIs within their application.
9+
**Developers** use Nitric to define required WebSocket APIs within their application.
1010

1111
- App code interacts with the [WebSocket resource](/websocket) through defined routes and integrations.
1212
- Developers implement backend logic to handle WebSocket connections, messages, and disconnections.
1313

14-
**Operations** use default or overridden Terraform modules to provision the necessary resources for their target cloud.
14+
**Operations** use default or overridden IaC (e.g Terraform modules) to provision the necessary resources for their target cloud.
1515

1616
<details>
1717
<summary>Example AWS Provider</summary>

0 commit comments

Comments
 (0)