fix schema doc tool, fix schema errors, regenerate schema docs (#3524)

2025-11-12 08:50:52 +01:00
parent e44b23111e
commit 5270586a8e
47 changed files with 3474 additions and 341 deletions
--- a/modules/net-vpc/schemas/internal-range.schema.md
+++ b/modules/net-vpc/schemas/internal-range.schema.md
@@ -0,0 +1,39 @@
+# InternalRange
+
+<!-- markdownlint-disable MD036 -->
+
+## Properties
+
+*additional properties: false*
+
+- **name**: *string*
+- **description**: *string*
+- **labels**: *object*
+  <br>*additional properties: string*
+- **ip_cidr_range**: *string*
+- ⁺**usage**: *string*
+  <br>*enum: ['FOR_VPC', 'EXTERNAL_TO_VPC', 'FOR_MIGRATION']*
+- ⁺**peering**: *string*
+  <br>*enum: ['FOR_SELF', 'FOR_PEER', 'NOT_SHARED']*
+- **prefix_length**: *integer*
+- **target_cidr_range**: *array*
+  - items: *string*
+- **exclude_cidr_ranges**: *array*
+  - items: *string*
+- **allocation_options**: *object*
+  <br>*additional properties: false*
+  - **allocation_strategy**: *string*
+    <br>*enum: ['RANDOM', 'FIRST_AVAILABLE', 'RANDOM_FIRST_N_AVAILABLE', 'FIRST_SMALLEST_FITTING']*
+  - **first_available_ranges_lookup_size**: *integer*
+- **overlaps**: *array*
+  - items: *string*
+    <br>*enum: ['OVERLAP_ROUTE_RANGE', 'OVERLAP_EXISTING_SUBNET_RANGE']*
+- **migration**: *object*
+  <br>*additional properties: false*
+  - ⁺**source**: *string*
+  - ⁺**target**: *string*
+- **immutable**: *boolean*
+
+## Definitions
+
+
--- a/modules/net-vpc/schemas/subnet.schema.md
+++ b/modules/net-vpc/schemas/subnet.schema.md
@@ -19,7 +19,8 @@
  - **metadata_fields**: *array*
    - items: *string*
 - **global**: *boolean*
- ⁺**ip_cidr_range**: *string*
+- **ip_cidr_range**: *string*
+- **reserved_internal_range**: *string*
 - **ipv6**: *object*
  <br>*additional properties: false*
  - **access_type**: *string*
@@ -30,7 +31,12 @@
 - **psc**: *boolean*
 - **proxy_only**: *boolean*
 - **secondary_ip_ranges**: *object*
-  *additional properties: String*
+  <br>*additional properties: oneof*
+  - *string*
+  - *object*
+    <br>*additional properties: false*
+    - **ip_cidr_range**: *string*
+    - **reserved_internal_range**: *string*
 - **iam**: *reference([iam](#refs-iam))*
 - **iam_bindings**: *reference([iam_bindings](#refs-iam_bindings))*
 - **iam_bindings_additive**: *reference([iam_bindings_additive](#refs-iam_bindings_additive))*
--- a/modules/organization/schemas/tags.schema.md
+++ b/modules/organization/schemas/tags.schema.md
@@ -15,7 +15,7 @@
 - **iam_bindings_additive**: *reference([iam_bindings_additive](#refs-iam_bindings_additive))*
 - **values**: *object*
  <br>*additional properties: false*
-  - **`^[a-z-][a-z0-9-]+$`**: *object*
+  - **`^[a-z-][^\\'"/]+$`**: *object*
    <br>*additional properties: false*
    - **name**: *string*
    - **description**: *string*
--- a/modules/project-factory/schemas/folder.schema.md
+++ b/modules/project-factory/schemas/folder.schema.md
@@ -25,6 +25,31 @@
      - **iam_project_roles**: *reference([iam_project_roles](#refs-iam_project_roles))*
      - **iam_sa_roles**: *reference([iam_sa_roles](#refs-iam_sa_roles))*
      - **iam_storage_roles**: *reference([iam_storage_roles](#refs-iam_storage_roles))*
+- **autokey_config**: *object*
+  <br>*additional properties: false*
+  - **project**: *string*
+    <br>*pattern: ^(projects/|\$project_ids:|\$project_numbers:)*
+- **contacts**: *object*
+  <br>*additional properties: false*
+  - **`^(\S+@\S+\.\S+|\$email_addresses:\S+)$`**: *array*
+    - items: *string*
+      <br>*enum: ['ALL', 'BILLING', 'LEGAL', 'SECURITY', 'PRODUCT_UPDATES', 'SUSPENSION', 'TECHNICAL']*
+- **data_access_logs**: *object*
+  <br>*additional properties: false*
+  - **`^([a-z][a-z-]+\.googleapis\.com|allServices)$`**: *object*
+    <br>*additional properties: false*
+    - **ADMIN_READ**: *object*
+      <br>*additional properties: false*
+      - **exempted_members**: *array*
+        - items: *string*
+    - **DATA_READ**: *object*
+      <br>*additional properties: false*
+      - **exempted_members**: *array*
+        - items: *string*
+    - **DATA_WRITE**: *object*
+      <br>*additional properties: false*
+      - **exempted_members**: *array*
+        - items: *string*
 - **factories_config**: *object*
  <br>*additional properties: false*
  - **org_policies**: *string*
@@ -78,7 +103,7 @@
  - **iam_bindings_additive**: *reference([iam_bindings_additive](#refs-iam_bindings_additive))*
  - **force_destroy**: *boolean*
  - **labels**: *object*
-    *additional properties: String*
+    <br>*additional properties: string*
  - **location**: *string*
  - **managed_folders**: *object*
    <br>*additional properties: false*
--- a/modules/project-factory/schemas/project.schema.json
+++ b/modules/project-factory/schemas/project.schema.json
@@ -267,52 +267,56 @@
                  "additionalProperties": false,
                  "patternProperties": {
                    "^[a-z][a-z0-9-]+[a-z0-9]$": {
-                      "destroy_scheduled_duration": {
-                        "type": "string"
-                      },
-                      "rotation_period": {
-                        "type": "string"
-                      },
-                      "iam": {
-                        "$ref": "#/$defs/iam"
-                      },
-                      "iam_bindings": {
-                        "$ref": "#/$defs/iam_bindings"
-                      },
-                      "iam_bindings_additive": {
-                        "$ref": "#/$defs/iam_bindings_additive"
-                      },
-                      "purpose": {
-                        "type": "string",
-                        "default": "ENCRYPT_DECRYPT",
-                        "enum": [
-                          "CRYPTO_KEY_PURPOSE_UNSPECIFIED",
-                          "ENCRYPT_DECRYPT",
-                          "ASYMMETRIC_SIGN",
-                          "ASYMMETRIC_DECRYPT",
-                          "RAW_ENCRYPT_DECRYPT",
-                          "MAC"
-                        ]
-                      },
-                      "version_template": {
-                        "type": "object",
-                        "additionalProperties": false,
-                        "required": [
-                          "algorithm"
-                        ],
-                        "properties": {
-                          "algorithm": {
-                            "type": "string"
-                          },
-                          "protection_level": {
-                            "type": "string",
-                            "default": "SOFTWARE",
-                            "enum": [
-                              "SOFTWARE",
-                              "HSM",
-                              "EXTERNAL",
-                              "EXTERNAL_VPC"
-                            ]
+                      "type": "object",
+                      "additionalProperties": false,
+                      "properties": {
+                        "destroy_scheduled_duration": {
+                          "type": "string"
+                        },
+                        "rotation_period": {
+                          "type": "string"
+                        },
+                        "iam": {
+                          "$ref": "#/$defs/iam"
+                        },
+                        "iam_bindings": {
+                          "$ref": "#/$defs/iam_bindings"
+                        },
+                        "iam_bindings_additive": {
+                          "$ref": "#/$defs/iam_bindings_additive"
+                        },
+                        "purpose": {
+                          "type": "string",
+                          "default": "ENCRYPT_DECRYPT",
+                          "enum": [
+                            "CRYPTO_KEY_PURPOSE_UNSPECIFIED",
+                            "ENCRYPT_DECRYPT",
+                            "ASYMMETRIC_SIGN",
+                            "ASYMMETRIC_DECRYPT",
+                            "RAW_ENCRYPT_DECRYPT",
+                            "MAC"
+                          ]
+                        },
+                        "version_template": {
+                          "type": "object",
+                          "additionalProperties": false,
+                          "required": [
+                            "algorithm"
+                          ],
+                          "properties": {
+                            "algorithm": {
+                              "type": "string"
+                            },
+                            "protection_level": {
+                              "type": "string",
+                              "default": "SOFTWARE",
+                              "enum": [
+                                "SOFTWARE",
+                                "HSM",
+                                "EXTERNAL",
+                                "EXTERNAL_VPC"
+                              ]
+                            }
                          }
                        }
                      }
--- a/modules/project-factory/schemas/project.schema.md
+++ b/modules/project-factory/schemas/project.schema.md
@@ -31,8 +31,31 @@
 - **buckets**: *reference([buckets](#refs-buckets))*
 - **contacts**: *object*
  <br>*additional properties: false*
-  - **`^[a-z0-9_-]+$`**: *array*
+  - **`^(\S+@\S+\.\S+|\$email_addresses:\S+)$`**: *array*
    - items: *string*
+      <br>*enum: ['ALL', 'BILLING', 'LEGAL', 'SECURITY', 'PRODUCT_UPDATES', 'SUSPENSION', 'TECHNICAL']*
+- **data_access_logs**: *object*
+  <br>*additional properties: false*
+  - **`^([a-z][a-z-]+\.googleapis\.com|allServices)$`**: *object*
+    <br>*additional properties: false*
+    - **ADMIN_READ**: *object*
+      <br>*additional properties: false*
+      - **exempted_members**: *array*
+        - items: *string*
+    - **DATA_READ**: *object*
+      <br>*additional properties: false*
+      - **exempted_members**: *array*
+        - items: *string*
+    - **DATA_WRITE**: *object*
+      <br>*additional properties: false*
+      - **exempted_members**: *array*
+        - items: *string*
+- **datasets**: *object*
+  <br>*additional properties: false*
+  - **`^[a-z0-9_]+$`**: *object*
+    <br>*additional properties: false*
+    - **friendly_name**: *string*
+    - **location**: *string*
 - **deletion_policy**: *string*
  <br>*enum: ['PREVENT', 'DELETE', 'ABANDON']*
 - **factories_config**: *object*
@@ -47,6 +70,39 @@
 - **iam_bindings**: *reference([iam_bindings](#refs-iam_bindings))*
 - **iam_bindings_additive**: *reference([iam_bindings_additive](#refs-iam_bindings_additive))*
 - **iam_by_principals**: *reference([iam_by_principals](#refs-iam_by_principals))*
+- **iam_by_principals_additive**: *reference([iam_by_principals](#refs-iam_by_principals))*
+- **kms**: *object*
+  <br>*additional properties: false*
+  - **autokeys**: *object*
+    <br>*additional properties: false*
+    - **`^[a-z][a-z0-9-]+[a-z0-9]$`**: *object*
+      <br>*additional properties: false*
+      - ⁺**location**: *string*
+      - ⁺**resource_type_selector**: *string*
+  - **keyrings**: *object*
+    <br>*additional properties: false*
+    - **`^[a-z][a-z0-9-]+[a-z0-9]$`**: *object*
+      <br>*additional properties: false*
+      - ⁺**location**: *string*
+      - **iam**: *reference([iam](#refs-iam))*
+      - **iam_bindings**: *reference([iam_bindings](#refs-iam_bindings))*
+      - **iam_bindings_additive**: *reference([iam_bindings_additive](#refs-iam_bindings_additive))*
+      - **keys**: *object*
+        <br>*additional properties: false*
+        - **`^[a-z][a-z0-9-]+[a-z0-9]$`**: *object*
+          <br>*additional properties: false*
+          - **destroy_scheduled_duration**: *string*
+          - **rotation_period**: *string*
+          - **iam**: *reference([iam](#refs-iam))*
+          - **iam_bindings**: *reference([iam_bindings](#refs-iam_bindings))*
+          - **iam_bindings_additive**: *reference([iam_bindings_additive](#refs-iam_bindings_additive))*
+          - **purpose**: *string*
+            <br>*default: ENCRYPT_DECRYPT*, *enum: ['CRYPTO_KEY_PURPOSE_UNSPECIFIED', 'ENCRYPT_DECRYPT', 'ASYMMETRIC_SIGN', 'ASYMMETRIC_DECRYPT', 'RAW_ENCRYPT_DECRYPT', 'MAC']*
+          - **version_template**: *object*
+            <br>*additional properties: false*
+            - ⁺**algorithm**: *string*
+            - **protection_level**: *string*
+              <br>*default: SOFTWARE*, *enum: ['SOFTWARE', 'HSM', 'EXTERNAL', 'EXTERNAL_VPC']*
 - **labels**: *object*
 - **pam_entitlements**: *reference([pam_entitlements](#refs-pam_entitlements))*
 - **log_buckets**: *object*
@@ -88,11 +144,11 @@
    - ⁺**quota_id**: *string*
    - ⁺**preferred_value**: *number*
    - **dimensions**: *object*
-      *additional properties: String*
+      <br>*additional properties: string*
    - **justification**: *string*
    - **contact_email**: *string*
    - **annotations**: *object*
-      *additional properties: String*
+      <br>*additional properties: string*
    - **ignore_safety_checks**: *string*
      <br>*enum: ['QUOTA_DECREASE_BELOW_USAGE', 'QUOTA_DECREASE_PERCENTAGE_TOO_HIGH', 'QUOTA_SAFETY_CHECK_UNSPECIFIED']*
 - **parent**: *string*
@@ -149,7 +205,7 @@
  <br>*additional properties: false*
  - **`^[a-z0-9_-]+$`**: *string*
 - **tags**: *object*
-  *additional properties: Object*
+  <br>*additional properties: object*
 - **universe**: *object*
  <br>*additional properties: false*
  - **prefix**: *string*
@@ -162,12 +218,6 @@
 - **vpc_sc**: *object*
  - ⁺**perimeter_name**: *string*
  - **is_dry_run**: *boolean*
- **datasets**: *object*
-  <br>*additional properties: false*
-  - **`^[a-z0-9_]+$`**: *object*
-    <br>*additional properties: false*
-    - **friendly_name**: *string*
-    - **location**: *string*

 ## Definitions

@@ -176,12 +226,13 @@
  - **name**: *string*
  - **create**: *boolean*
  - **description**: *string*
+  - **encryption_key**: *string*
  - **iam**: *reference([iam](#refs-iam))*
  - **iam_bindings**: *reference([iam_bindings](#refs-iam_bindings))*
  - **iam_bindings_additive**: *reference([iam_bindings_additive](#refs-iam_bindings_additive))*
  - **force_destroy**: *boolean*
  - **labels**: *object*
-    *additional properties: String*
+    <br>*additional properties: string*
  - **location**: *string*
  - **managed_folders**: *object*
    <br>*additional properties: false*
--- a/modules/project/schemas/observability.schema.md
+++ b/modules/project/schemas/observability.schema.md
@@ -23,7 +23,7 @@
      - items: *string*
    - **severity**: *string*
    - **user_labels**: *object*
-      *additional properties: String*
+      <br>*additional properties: string*
    - **alert_strategy**: *object*
      <br>*additional properties: false*
      - **auto_close**: *string*
@@ -57,7 +57,7 @@
    - **description**: *string*
    - **disabled**: *boolean*
    - **label_extractors**: *object*
-      *additional properties: String*
+      <br>*additional properties: string*
    - **value_extractor**: *string*
    - **bucket_options**: *object*
      <br>*additional properties: false*
@@ -96,9 +96,9 @@
    - **display_name**: *string*
    - **enabled**: *boolean*
    - **labels**: *object*
-      *additional properties: String*
+      <br>*additional properties: string*
    - **user_labels**: *object*
-      *additional properties: String*
+      <br>*additional properties: string*
    - **sensitive_labels**: *object*
      <br>*additional properties: false*
      - **auth_token**: *string*
@@ -122,7 +122,7 @@
  <br>*additional properties: false*
  - ⁺**filter**: *string*
  - **label_extractors**: *object*
-    *additional properties: String*
+    <br>*additional properties: string*
 - **monitoring_query_condition**<a name="refs-monitoring_query_condition"></a>: *object*
  <br>*additional properties: false*
  - ⁺**duration**: *string*
@@ -137,7 +137,7 @@
  - **duration**: *string*
  - **evaluation_interval**: *string*
  - **labels**: *object*
-    *additional properties: String*
+    <br>*additional properties: string*
  - **rule_group**: *string*
 - **threshold_condition**<a name="refs-threshold_condition"></a>: *object*
  <br>*additional properties: false*
--- a/modules/project/schemas/quotas.schema.md
+++ b/modules/project/schemas/quotas.schema.md
@@ -12,11 +12,11 @@
  - ⁺**quota_id**: *string*
  - ⁺**preferred_value**: *number*
  - **dimensions**: *object*
-    *additional properties: String*
+    <br>*additional properties: string*
  - **justification**: *string*
  - **contact_email**: *string*
  - **annotations**: *object*
-    *additional properties: String*
+    <br>*additional properties: string*
  - **ignore_safety_checks**: *string*
    <br>*enum: ['QUOTA_DECREASE_BELOW_USAGE', 'QUOTA_DECREASE_PERCENTAGE_TOO_HIGH', 'QUOTA_SAFETY_CHECK_UNSPECIFIED']*

--- a/modules/project/schemas/tags.schema.md
+++ b/modules/project/schemas/tags.schema.md
@@ -15,7 +15,7 @@
 - **iam_bindings_additive**: *reference([iam_bindings_additive](#refs-iam_bindings_additive))*
 - **values**: *object*
  <br>*additional properties: false*
-  - **`^[a-z-][a-z0-9-]+$`**: *object*
+  - **`^[a-z-][^\\'"/]+$`**: *object*
    <br>*additional properties: false*
    - **name**: *string*
    - **description**: *string*
@@ -30,14 +30,14 @@
  <br>*additional properties: false*
  - **`^roles/`**: *array*
    - items: *string*
-      <br>*pattern: ^(?:domain:|group:|serviceAccount:|user:|principal:|principalSet:|[a-z])*
+      <br>*pattern: ^(?:domain:|group:|serviceAccount:|user:|principal:|principalSet:|\$iam_principals:[a-z0-9_-]+)*
 - **iam_bindings**<a name="refs-iam_bindings"></a>: *object*
  <br>*additional properties: false*
  - **`^[a-z0-9_-]+$`**: *object*
    <br>*additional properties: false*
    - **members**: *array*
      - items: *string*
-        <br>*pattern: ^(?:domain:|group:|serviceAccount:|user:|principal:|principalSet:|[a-z])*
+        <br>*pattern: ^(?:domain:|group:|serviceAccount:|user:|principal:|principalSet:|\$iam_principals:[a-z0-9_-]+)*
    - **role**: *string*
      <br>*pattern: ^roles/*
    - **condition**: *object*
@@ -50,7 +50,7 @@
  - **`^[a-z0-9_-]+$`**: *object*
    <br>*additional properties: false*
    - **member**: *string*
-      <br>*pattern: ^(?:domain:|group:|serviceAccount:|user:|principal:|principalSet:|[a-z])*
+      <br>*pattern: ^(?:domain:|group:|serviceAccount:|user:|principal:|principalSet:|\$iam_principals:[a-z0-9_-]+)*
    - **role**: *string*
      <br>*pattern: ^[a-zA-Z0-9_/]+$*
    - **condition**: *object*
--- a/modules/vpc-sc/schemas/perimeter.schema.md
+++ b/modules/vpc-sc/schemas/perimeter.schema.md
@@ -0,0 +1,46 @@
+# perimeters
+
+<!-- markdownlint-disable MD036 -->
+
+## Properties
+
+*additional properties: false*
+
+- **description**: *string*
+- **ignore_resource_changes**: *boolean*
+- **spec**: *object*
+  <br>*additional properties: false*
+  - **access_levels**: *array*
+    - items: *string*
+  - **egress_policies**: *array*
+    - items: *string*
+  - **ingress_policies**: *array*
+    - items: *string*
+  - **restricted_services**: *array*
+    - items: *string*
+  - **resources**: *array*
+    - items: *string*
+  - **vpc_accessible_services**: *reference([VpcAccessibleServices](#refs-VpcAccessibleServices))*
+- **status**: *object*
+  <br>*additional properties: false*
+  - **access_levels**: *array*
+    - items: *string*
+  - **egress_policies**: *array*
+    - items: *string*
+  - **ingress_policies**: *array*
+    - items: *string*
+  - **resources**: *array*
+    - items: *string*
+  - **restricted_services**: *array*
+    - items: *string*
+  - **vpc_accessible_services**: *reference([VpcAccessibleServices](#refs-VpcAccessibleServices))*
+- **title**: *string*
+- **use_explicit_dry_run_spec**: *boolean*
+
+## Definitions
+
+- **VpcAccessibleServices**<a name="refs-VpcAccessibleServices"></a>: *object*
+  <br>*additional properties: false*
+  - ⁺**allowed_services**: *array*
+    - items: *string*
+  - **enable_restriction**: *boolean*
--- a/modules/workstation-cluster/schemas/workstation-config.schema.md
+++ b/modules/workstation-cluster/schemas/workstation-config.schema.md
@@ -0,0 +1,83 @@
+# Workstation Config
+
+<!-- markdownlint-disable MD036 -->
+
+## Properties
+
+*additional properties: false*
+
+- **annotations**: *object*
+  <br>*additional properties: false*
+  - **`^[a-z0-9-]+$`**: *string*
+- **container**: *object*
+  <br>*additional properties: false*
+  - **args**: *array*
+    - items: *string*
+  - **command**: *array*
+    - items: *string*
+  - **env**: *object*
+    <br>*additional properties: string*
+  - **image**: *string*
+  - **run_as_user**: *string*
+  - **working_dir**: *string*
+- **display_name**: *string*
+- **enable_audit_agent**: *boolean*
+- **encryption_key**: *object*
+  <br>*additional properties: false*
+  - ⁺**kms_key**: *string*
+  - ⁺**kms_key_service_account**: *string*
+- **gce_instance**: *object*
+  <br>*additional properties: false*
+  - **machine_type**: *string*
+  - **service_account**: *string*
+  - **service_account_scopes**: *array*
+    - items: *string*
+  - **pool_size**: *number*
+  - **boot_disk_size_gb**: *number*
+  - **tags**: *array*
+    - items: *string*
+  - **disable_public_ip_addresses**: *boolean*
+  - **enable_nested_virtualization**: *boolean*
+  - **shielded_instance_config**: *object*
+    <br>*additional properties: false*
+    - **enable_secure_boot**: *boolean*
+    - **enable_vtpm**: *boolean*
+    - **enable_integrity_monitoring**: *boolean*
+  - **enable_confidential_compute**: *boolean*
+  - **accelerators**: *array*
+    - items: *object*
+      <br>*additional properties: false*
+      - **type**: *string*
+      - **count**: *number*
+- **iam**: *object*
+  <br>*additional properties: array*
+- **iam_bindings**: *object*
+  <br>*additional properties: object*
+- **iam_bindings_additive**: *object*
+  <br>*additional properties: object*
+- **labels**: *object*
+  <br>*additional properties: string*
+- **max_workstations**: *number*
+- **persistent_directories**: *array*
+  - items: *object*
+    <br>*additional properties: false*
+    - **mount_path**: *string*
+    - **gce_pd**: *object*
+      <br>*additional properties: false*
+      - **size_gb**: *number*
+      - **fs_type**: *string*
+      - **disk_type**: *string*
+      - **source_snapshot**: *string*
+      - **reclaim_policy**: *string*
+- **replica_zones**: *array*
+  - items: *string*
+- **timeouts**: *object*
+  <br>*additional properties: false*
+  - **idle**: *number*
+  - **running**: *number*
+- **workstations**: *object*
+  <br>*additional properties: object*
+
+## Definitions
+
+