JSON schema documentation tool (#3070)

* wip

* wip

* wip

* generate schema docs

* formatting

* typo

* fix details

* fix details

* revert dp change

* tfdoc
This commit is contained in:
Ludovico Magnocavallo
2025-05-06 08:17:46 +02:00
committed by GitHub
parent 41b4cdef68
commit 30b390483e
69 changed files with 3817 additions and 304 deletions

View File

@@ -0,0 +1,43 @@
# VPC-SC access level
<!-- markdownlint-disable MD036 -->
## Properties
*additional properties: false*
- **combining_function**: *string*
- **conditions**: *array*
- items: *object*
<br>*additional properties: false*
- **device_policy**: *object*
<br>*additional properties: false*
- **allowed_device_management_levels**: *array*
- items: *string*
- **allowed_encryption_statuses**: *array*
- items: *string*
- ⁺**require_admin_approval**: *boolean*
- ⁺**require_corp_owned**: *boolean*
- **require_screen_lock**: *boolean*
- **os_constraints**: *array*
- items: *object*
<br>*additional properties: false*
- **os_type**: *string*
- **minimum_version**: *string*
- **require_verified_chrome_os**: *boolean*
- **ip_subnetworks**: *array*
- items: *string*
- **members**: *array*
- items: *string*
- **negate**: *boolean*
- **regions**: *array*
- items: *string*
- **required_access_levels**: *array*
- items: *string*
- **vpc_subnets**: *object*
<br>*additional properties: false*
- **`^//compute.googleapis.com/projects/[^/]+/global/networks/[^/]+$`**: *array*
- items: *string*
## Definitions

View File

@@ -22,6 +22,7 @@
}
},
"identity_type": {
"type": "string",
"enum": [
"IDENTITY_TYPE_UNSPECIFIED",
"ANY_IDENTITY",
@@ -97,4 +98,4 @@
}
}
}
}
}

View File

@@ -0,0 +1,38 @@
# VPC-SC egress policy
<!-- markdownlint-disable MD036 -->
## Properties
*additional properties: false*
- **title**: *string*
- ⁺**from**: *object*
<br>*additional properties: false*
- **access_levels**: *array*
- items: *string*
- **identity_type**: *string*
<br>*enum: ['IDENTITY_TYPE_UNSPECIFIED', 'ANY_IDENTITY', 'ANY_USER_ACCOUNT', 'ANY_SERVICE_ACCOUNT', '']*
- **identities**: *array*
- items: *string*
- **resources**: *array*
- items: *string*
- ⁺**to**: *object*
<br>*additional properties: false*
- **external_resources**: *array*
- items: *string*
- **operations**: *array*
- items: *object*
<br>*additional properties: false*
- **method_selectors**: *array*
- items: *string*
- **permission_selectors**: *array*
- items: *string*
- ⁺**service_name**: *string*
- **resources**: *array*
- items: *string*
- **roles**: *array*
- items: *string*
## Definitions

View File

@@ -22,6 +22,7 @@
}
},
"identity_type": {
"type": "string",
"enum": [
"IDENTITY_TYPE_UNSPECIFIED",
"ANY_IDENTITY",
@@ -89,4 +90,4 @@
}
}
}
}
}

View File

@@ -0,0 +1,34 @@
# VPC-SC ingress policy
<!-- markdownlint-disable MD036 -->
## Properties
*additional properties: false*
- **title**: *string*
- ⁺**from**: *object*
<br>*additional properties: false*
- **access_levels**: *array*
- items: *string*
- **identity_type**: *string*
<br>*enum: ['IDENTITY_TYPE_UNSPECIFIED', 'ANY_IDENTITY', 'ANY_USER_ACCOUNT', 'ANY_SERVICE_ACCOUNT', '']*
- **identities**: *array*
- items: *string*
- **resources**: *array*
- items: *string*
- ⁺**to**: *object*
<br>*additional properties: false*
- **operations**: *array*
- items: *object*
- **method_selectors**: *array*
- items: *string*
- **permission_selectors**: *array*
- items: *string*
- **resources**: *array*
- items: *string*
- **roles**: *array*
- items: *string*
## Definitions

View File

@@ -0,0 +1,45 @@
# perimeters
<!-- markdownlint-disable MD036 -->
## Properties
*additional properties: false*
- **description**: *string*
- **title**: *string*
- **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))*
- **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*