Fixed param description (#4076)

Azure · Oct 12, 2023 · f2448b2 · f2448b2
1 parent 5d110a6
commit f2448b2
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 24 deletions.
diff --git a/modules/web/static-site/custom-domain/README.md b/modules/web/static-site/custom-domain/README.md
@@ -17,11 +17,16 @@ This module deploys a Static Web App Site Custom Domain.
 
 ## Parameters
 
+**Required parameters**
+
+| Parameter Name | Type | Description |
+| :-- | :-- | :-- |
+| `name` | string | The custom domain name. |
+
 **Conditional parameters**
 
 | Parameter Name | Type | Description |
 | :-- | :-- | :-- |
-| `name` | string | The custom domain name. Required if the template is used in a standalone deployment. |
 | `staticSiteName` | string | The name of the parent Static Web App. Required if the template is used in a standalone deployment. |
 
 **Optional parameters**

diff --git a/modules/web/static-site/custom-domain/main.bicep b/modules/web/static-site/custom-domain/main.bicep
@@ -2,7 +2,7 @@ metadata name = 'Static Web App Site Custom Domains'
 metadata description = 'This module deploys a Static Web App Site Custom Domain.'
 metadata owner = 'Azure/module-maintainers'
 
-@description('Conditional. The custom domain name. Required if the template is used in a standalone deployment.')
+@description('Required. The custom domain name.')
 param name string
 
 @description('Conditional. The name of the parent Static Web App. Required if the template is used in a standalone deployment.')

diff --git a/modules/web/static-site/custom-domain/main.json b/modules/web/static-site/custom-domain/main.json
@@ -4,8 +4,8 @@
   "metadata": {
     "_generator": {
       "name": "bicep",
-      "version": "0.20.4.51522",
-      "templateHash": "12334533883169216576"
+      "version": "0.22.6.54827",
+      "templateHash": "13208835708722733896"
     },
     "name": "Static Web App Site Custom Domains",
     "description": "This module deploys a Static Web App Site Custom Domain.",
@@ -15,7 +15,7 @@
     "name": {
       "type": "string",
       "metadata": {
-        "description": "Conditional. The custom domain name. Required if the template is used in a standalone deployment."
+        "description": "Required. The custom domain name."
       }
     },
     "staticSiteName": {

diff --git a/modules/web/static-site/main.json b/modules/web/static-site/main.json
@@ -4,8 +4,8 @@
   "metadata": {
     "_generator": {
       "name": "bicep",
-      "version": "0.21.1.54444",
-      "templateHash": "18252581681683363361"
+      "version": "0.22.6.54827",
+      "templateHash": "12872096460250206815"
     },
     "name": "Static Web Apps",
     "description": "This module deploys a Static Web App.",
@@ -279,8 +279,8 @@
           "metadata": {
             "_generator": {
               "name": "bicep",
-              "version": "0.21.1.54444",
-              "templateHash": "16239200301217299333"
+              "version": "0.22.6.54827",
+              "templateHash": "13553590806488370796"
             },
             "name": "Static Web App Site Linked Backends",
             "description": "This module deploys a Custom Function App into a Static Web App Site using the Linked Backends property.",
@@ -412,8 +412,8 @@
           "metadata": {
             "_generator": {
               "name": "bicep",
-              "version": "0.21.1.54444",
-              "templateHash": "14542116541399181875"
+              "version": "0.22.6.54827",
+              "templateHash": "8340850851413090940"
             },
             "name": "Static Web App Site Config",
             "description": "This module deploys a Static Web App Site Config.",
@@ -538,8 +538,8 @@
           "metadata": {
             "_generator": {
               "name": "bicep",
-              "version": "0.21.1.54444",
-              "templateHash": "14542116541399181875"
+              "version": "0.22.6.54827",
+              "templateHash": "8340850851413090940"
             },
             "name": "Static Web App Site Config",
             "description": "This module deploys a Static Web App Site Config.",
@@ -665,8 +665,8 @@
           "metadata": {
             "_generator": {
               "name": "bicep",
-              "version": "0.21.1.54444",
-              "templateHash": "8695148534740362749"
+              "version": "0.22.6.54827",
+              "templateHash": "13208835708722733896"
             },
             "name": "Static Web App Site Custom Domains",
             "description": "This module deploys a Static Web App Site Custom Domain.",
@@ -676,7 +676,7 @@
             "name": {
               "type": "string",
               "metadata": {
-                "description": "Conditional. The custom domain name. Required if the template is used in a standalone deployment."
+                "description": "Required. The custom domain name."
               }
             },
             "staticSiteName": {
@@ -790,8 +790,8 @@
           "metadata": {
             "_generator": {
               "name": "bicep",
-              "version": "0.21.1.54444",
-              "templateHash": "10006606949676096242"
+              "version": "0.22.6.54827",
+              "templateHash": "3353684850635934919"
             }
           },
           "parameters": {
@@ -901,8 +901,8 @@
           "metadata": {
             "_generator": {
               "name": "bicep",
-              "version": "0.21.1.54444",
-              "templateHash": "14580007913383558904"
+              "version": "0.22.6.54827",
+              "templateHash": "2884140170473394983"
             },
             "name": "Private Endpoints",
             "description": "This module deploys a Private Endpoint.",
@@ -1101,8 +1101,8 @@
                   "metadata": {
                     "_generator": {
                       "name": "bicep",
-                      "version": "0.21.1.54444",
-                      "templateHash": "2469208411936339153"
+                      "version": "0.22.6.54827",
+                      "templateHash": "5610247137574346230"
                     },
                     "name": "Private Endpoint Private DNS Zone Groups",
                     "description": "This module deploys a Private Endpoint Private DNS Zone Group.",
@@ -1239,8 +1239,8 @@
                   "metadata": {
                     "_generator": {
                       "name": "bicep",
-                      "version": "0.21.1.54444",
-                      "templateHash": "13032708393704093995"
+                      "version": "0.22.6.54827",
+                      "templateHash": "14351187799927334028"
                     }
                   },
                   "parameters": {