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

Commit 1bbfede

Browse files
add description config
1 parent dfc6ea5 commit 1bbfede

File tree

4 files changed

+64
-16
lines changed

4 files changed

+64
-16
lines changed

src/pages/apis.mdx

Lines changed: 46 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -766,8 +766,7 @@ By default APIs deployed by Nitric will be assigned a domain by the target cloud
766766

767767
<CodeGroup>
768768

769-
```yaml {{ title: "AWS", tag: "nitric-prod.yaml (stack file)" }}
770-
name: my-aws-stack
769+
```yaml {{ title: "AWS", tag: "nitric.prod.yaml" }}
771770
provider: nitric/[email protected]
772771
region: ap-southeast-2
773772

@@ -780,14 +779,57 @@ apis:
780779
- test.example.com
781780
```
782781
783-
```yaml {{ title: "Azure", tag: "nitric-prod.yaml (stack file)" }}
782+
```yaml {{ title: "Azure", tag: "nitric.prod.yaml (stack file)" }}
784783
# currently unsupported - request support here: https://github.com/nitrictech/nitric/issues
785784
```
786785

787-
```yaml {{ title: "Google Cloud", tag: "nitric-prod.yaml (stack file)" }}
786+
```yaml {{ title: "Google Cloud", tag: "nitric.prod.yaml (stack file)" }}
788787
# currently unsupported - request support here: https://github.com/nitrictech/nitric/issues
789788
```
790789

790+
## Custom Descriptions
791+
792+
By default, APIs will not be deployed with a description. You can add a description using the following configuration in your stack file.
793+
794+
<CodeGroup>
795+
796+
```yaml {{ title: "AWS", tag: "nitric.prod.yaml" }}
797+
provider: nitric/[email protected]
798+
region: ap-southeast-2
799+
800+
# Add a key for configuring apis
801+
apis:
802+
# Target an API by its nitric name
803+
my-api-name:
804+
# provide domains to be used for the api
805+
description: An AWS API
806+
```
807+
808+
```yaml {{ title: "Azure", tag: "nitric.prod.yaml" }}
809+
provider: nitric/[email protected]
810+
region: Australia East
811+
org: example-org
812+
adminemail: [email protected]
813+
814+
apis:
815+
# Target an API by its nitric name
816+
my-api-name:
817+
# provide domains to be used for the api
818+
description: An Azure API
819+
```
820+
821+
```yaml {{ title: "Google Cloud", tag: "nitric.prod.yaml" }}
822+
provider: nitric/[email protected]
823+
region: australia-southeast1
824+
825+
# Add a key for configuring apis
826+
apis:
827+
# Target an API by its nitric name
828+
my-api-name:
829+
# provide domains to be used for the api
830+
description: A GCP API
831+
```
832+
791833
</CodeGroup>
792834
793835
### AWS Custom Domain Prerequisites

src/pages/reference/providers/aws/configuration.mdx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,10 @@ export const description = 'Configuring your AWS stacks'
77
<CodeGroup>
88

99
```yaml {{ title: "Pulumi" }}
10-
# The name of your AWS stack
11-
name: my-aws-stack-name
12-
1310
# The provider to use and it's published version
1411
# See releases:
1512
# https://github.com/nitrictech/nitric/tags
16-
provider: nitric/aws@1.1.0
13+
provider: nitric/aws@1.12.4
1714

1815
# The target aws region to deploy to
1916
# See available regions:
@@ -47,6 +44,7 @@ apis:
4744
# The domain or parent domain must have a hosted zone already in Route53
4845
domains:
4946
- api.example.com
47+
description: An AWS API
5048

5149
# Configure your deployed services
5250
config:

src/pages/reference/providers/azure/configuration.mdx

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,10 @@ export const description = 'Configuring your Azure stacks'
55
# Complete Example with comments
66

77
```yaml
8-
# The name of your Azure stack
9-
name: my-azure-stack-name
10-
118
# The provider to use and it's published version
129
# See releases:
1310
# https://github.com/nitrictech/nitric/tags
14-
provider: nitric/azure@1.0.0
11+
provider: nitric/azure@1.12.4
1512

1613
# The target Azure region to deploy to
1714
# See available regions:
@@ -31,6 +28,13 @@ adminemail: [email protected]
3128

3229
# All configuration below is optional
3330

31+
# Apply configuration to nitric APIs
32+
apis:
33+
# Target an API by its nitric name
34+
my-api:
35+
# provide domains to be used for the api
36+
description: An Azure API
37+
3438
# Configure your deployed services
3539
config:
3640
# How services without a type will be deployed

src/pages/reference/providers/gcp/configuration.mdx

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,10 @@ export const description = 'Configuring your Google Cloud stacks'
77
<CodeGroup>
88

99
```yaml {{ title: "Pulumi" }}
10-
# The name of your GCP stack
11-
name: my-gcp-stack-name
12-
1310
# The provider to use and it's published version
1411
# See releases:
1512
# https://github.com/nitrictech/nitric/tags
16-
provider: nitric/gcp@1.10.0
13+
provider: nitric/gcp@1.12.4
1714

1815
# The target GCP region to deploy to
1916
# See available regions:
@@ -41,6 +38,13 @@ import:
4138
# const mySecret = secret('my-secret');
4239
my-secret: existing-secret
4340

41+
# Apply configuration to nitric APIs
42+
apis:
43+
# Target an API by its nitric name
44+
my-api:
45+
# provide domains to be used for the api
46+
description: An Azure API
47+
4448
# Configure your deployed services
4549
config:
4650
# How services without a type will be deployed

0 commit comments

Comments
 (0)