Update schema docs

noqdev · May 19, 2023 · 95b9328 · 95b9328
1 parent a4a6725
commit 95b9328
Show file tree

Hide file tree

Showing 28 changed files with 221 additions and 136 deletions.
diff --git a/docs/web/docs/3-reference/3-schemas/aws_iam_group_template.json b/docs/web/docs/3-reference/3-schemas/aws_iam_group_template.json
@@ -62,7 +62,7 @@
     },
     "deleted": {
       "title": "Deleted",
-      "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.",
+      "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.",
       "default": false,
       "type": "boolean"
     },
@@ -187,7 +187,7 @@
         },
         "deleted": {
           "title": "Deleted",
-          "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.",
+          "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.",
           "default": false,
           "type": "boolean"
         },
@@ -333,7 +333,7 @@
         },
         "deleted": {
           "title": "Deleted",
-          "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.",
+          "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.",
           "default": false,
           "type": "boolean"
         },
@@ -505,7 +505,7 @@
         },
         "deleted": {
           "title": "Deleted",
-          "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.",
+          "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.",
           "default": false,
           "type": "boolean"
         },
@@ -561,10 +561,17 @@
         "statement": {
           "title": "Statement",
           "description": "List of policy statements",
-          "type": "array",
-          "items": {
-            "$ref": "#/definitions/PolicyStatement"
-          }
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/PolicyStatement"
+              }
+            },
+            {
+              "$ref": "#/definitions/PolicyStatement"
+            }
+          ]
         }
       },
       "required": [

diff --git a/docs/web/docs/3-reference/3-schemas/aws_iam_group_template.mdx b/docs/web/docs/3-reference/3-schemas/aws_iam_group_template.mdx
@@ -18,7 +18,7 @@ configurations for other models used in IAMbic.*
     - *string*
     - *string*
     - *string*
-- **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`.
+- **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`.
 - **`template_type`** *(string)*: Default: `"NOQ::AWS::IAM::Group"`.
 - **`owner`** *(string)*: Owner of the group.
 - **`iambic_managed`**: Controls the directionality of Iambic changes. Default: `"undefined"`.
@@ -57,7 +57,7 @@ configurations for other models used in IAMbic. Cannot contain additional proper
       - *string*
       - *string*
       - *string*
-  - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`.
+  - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`.
   - **`included_accounts`** *(array)*: A list of account ids and/or account names this statement applies to. Account ids/names can be represented as a regex and string. Default: `["*"]`.
     - **Items** *(string)*
   - **`excluded_accounts`** *(array)*: A list of account ids and/or account names this statement explicitly does not apply to. Account ids/names can be represented as a regex and string. Default: `[]`.
@@ -103,7 +103,7 @@ configurations for other models used in IAMbic. Cannot contain additional proper
       - *string*
       - *string*
       - *string*
-  - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`.
+  - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`.
   - **`included_accounts`** *(array)*: A list of account ids and/or account names this statement applies to. Account ids/names can be represented as a regex and string. Default: `["*"]`.
     - **Items** *(string)*
   - **`excluded_accounts`** *(array)*: A list of account ids and/or account names this statement explicitly does not apply to. Account ids/names can be represented as a regex and string. Default: `[]`.
@@ -153,7 +153,7 @@ configurations for other models used in IAMbic. Cannot contain additional proper
       - *string*
       - *string*
       - *string*
-  - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`.
+  - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`.
   - **`included_accounts`** *(array)*: A list of account ids and/or account names this statement applies to. Account ids/names can be represented as a regex and string. Default: `["*"]`.
     - **Items** *(string)*
   - **`excluded_accounts`** *(array)*: A list of account ids and/or account names this statement explicitly does not apply to. Account ids/names can be represented as a regex and string. Default: `[]`.
@@ -164,8 +164,11 @@ configurations for other models used in IAMbic. Cannot contain additional proper
     - **Items** *(string)*
   - **`policy_name`** *(string)*: The name of the policy.
   - **`version`** *(string)*
-  - **`statement`** *(array)*: List of policy statements.
-    - **Items**: Refer to *[#/definitions/PolicyStatement](#definitions/PolicyStatement)*.
+  - **`statement`**: List of policy statements.
+    - **Any of**
+      - *array*
+        - **Items**: Refer to *[#/definitions/PolicyStatement](#definitions/PolicyStatement)*.
+      - : Refer to *[#/definitions/PolicyStatement](#definitions/PolicyStatement)*.
 
 <a id="definitions/GroupProperties"></a>
 

diff --git a/docs/web/docs/3-reference/3-schemas/aws_iam_managed_policy_template.json b/docs/web/docs/3-reference/3-schemas/aws_iam_managed_policy_template.json
@@ -62,7 +62,7 @@
     },
     "deleted": {
       "title": "Deleted",
-      "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.",
+      "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.",
       "default": false,
       "type": "boolean"
     },
@@ -301,7 +301,7 @@
         },
         "deleted": {
           "title": "Deleted",
-          "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.",
+          "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.",
           "default": false,
           "type": "boolean"
         },
@@ -501,10 +501,17 @@
         "statement": {
           "title": "Statement",
           "description": "List of policy statements",
-          "type": "array",
-          "items": {
-            "$ref": "#/definitions/PolicyStatement"
-          }
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/PolicyStatement"
+              }
+            },
+            {
+              "$ref": "#/definitions/PolicyStatement"
+            }
+          ]
         }
       }
     },
@@ -572,7 +579,7 @@
         },
         "deleted": {
           "title": "Deleted",
-          "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.",
+          "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.",
           "default": false,
           "type": "boolean"
         },

diff --git a/docs/web/docs/3-reference/3-schemas/aws_iam_managed_policy_template.mdx b/docs/web/docs/3-reference/3-schemas/aws_iam_managed_policy_template.mdx
@@ -18,7 +18,7 @@ configurations for other models used in IAMbic.*
     - *string*
     - *string*
     - *string*
-- **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`.
+- **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`.
 - **`template_type`** *(string)*: Default: `"NOQ::AWS::IAM::ManagedPolicy"`.
 - **`owner`** *(string)*
 - **`iambic_managed`**: Controls the directionality of Iambic changes. Default: `"undefined"`.
@@ -96,7 +96,7 @@ configurations for other models used in IAMbic. Cannot contain additional proper
       - *string*
       - *string*
       - *string*
-  - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`.
+  - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`.
   - **`included_accounts`** *(array)*: A list of account ids and/or account names this statement applies to. Account ids/names can be represented as a regex and string. Default: `["*"]`.
     - **Items** *(string)*
   - **`excluded_accounts`** *(array)*: A list of account ids and/or account names this statement explicitly does not apply to. Account ids/names can be represented as a regex and string. Default: `[]`.
@@ -150,8 +150,11 @@ configurations for other models used in IAMbic.
   - **`excluded_orgs`** *(array)*: A list of AWS organization ids this statement explicitly does not apply to. Org ids can be represented as a regex and string. Default: `[]`.
     - **Items** *(string)*
   - **`version`** *(string)*
-  - **`statement`** *(array)*: List of policy statements.
-    - **Items**: Refer to *[#/definitions/PolicyStatement](#definitions/PolicyStatement)*.
+  - **`statement`**: List of policy statements.
+    - **Any of**
+      - *array*
+        - **Items**: Refer to *[#/definitions/PolicyStatement](#definitions/PolicyStatement)*.
+      - : Refer to *[#/definitions/PolicyStatement](#definitions/PolicyStatement)*.
 
 <a id="definitions/Tag"></a>
 
@@ -170,7 +173,7 @@ configurations for other models used in IAMbic. Cannot contain additional proper
       - *string*
       - *string*
       - *string*
-  - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run. Default: `false`.
+  - **`deleted`** *(boolean)*: Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: `false`.
   - **`key`** *(string)*
   - **`value`** *(string)*
 

diff --git a/docs/web/docs/3-reference/3-schemas/aws_iam_role_template.json b/docs/web/docs/3-reference/3-schemas/aws_iam_role_template.json
@@ -62,7 +62,7 @@
     },
     "deleted": {
       "title": "Deleted",
-      "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.",
+      "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.",
       "default": false,
       "type": "boolean"
     },
@@ -342,7 +342,7 @@
         },
         "deleted": {
           "title": "Deleted",
-          "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.",
+          "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.",
           "default": false,
           "type": "boolean"
         },
@@ -448,7 +448,7 @@
         },
         "deleted": {
           "title": "Deleted",
-          "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.",
+          "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.",
           "default": false,
           "type": "boolean"
         },
@@ -648,10 +648,17 @@
         },
         "statement": {
           "title": "Statement",
-          "type": "array",
-          "items": {
-            "$ref": "#/definitions/PolicyStatement"
-          }
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/PolicyStatement"
+              }
+            },
+            {
+              "$ref": "#/definitions/PolicyStatement"
+            }
+          ]
         }
       }
     },
@@ -719,7 +726,7 @@
         },
         "deleted": {
           "title": "Deleted",
-          "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.",
+          "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.",
           "default": false,
           "type": "boolean"
         },
@@ -762,7 +769,7 @@
         },
         "deleted": {
           "title": "Deleted",
-          "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.",
+          "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.",
           "default": false,
           "type": "boolean"
         },
@@ -845,7 +852,7 @@
         },
         "deleted": {
           "title": "Deleted",
-          "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.",
+          "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.",
           "default": false,
           "type": "boolean"
         },
@@ -901,10 +908,17 @@
         "statement": {
           "title": "Statement",
           "description": "List of policy statements",
-          "type": "array",
-          "items": {
-            "$ref": "#/definitions/PolicyStatement"
-          }
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/PolicyStatement"
+              }
+            },
+            {
+              "$ref": "#/definitions/PolicyStatement"
+            }
+          ]
         }
       },
       "required": [
@@ -1094,7 +1108,7 @@
         },
         "deleted": {
           "title": "Deleted",
-          "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is run.",
+          "description": "Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran.",
           "default": false,
           "type": "boolean"
         },