Update AccessList.Spec.Type docs (#57132)

This commit is contained in:
Pawel Kopiczko
2025-07-24 13:11:03 +00:00
committed by GitHub
parent 70b128e10b
commit a448f8ecf5
10 changed files with 22 additions and 24 deletions
@@ -412,9 +412,9 @@ type AccessListSpec struct {
Title string `protobuf:"bytes,8,opt,name=title,proto3" json:"title,omitempty"`
// owner_grants describes the access granted by owners to this Access List.
OwnerGrants *AccessListGrants `protobuf:"bytes,11,opt,name=owner_grants,json=ownerGrants,proto3" json:"owner_grants,omitempty"`
// type can be currently "dynamic" (the default if empty string) which denotes a regular Access
// List, "scim" which represents an Access List created from SCIM group or "static" for Access
// Lists managed by IaC tools.
// type can be an empty string which denotes a regular Access List, "scim" which represents
// an Access List created from SCIM group or "static" for Access Lists managed by IaC
// tools.
Type string `protobuf:"bytes,12,opt,name=type,proto3" json:"type,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -72,9 +72,9 @@ message AccessListSpec {
// owner_grants describes the access granted by owners to this Access List.
AccessListGrants owner_grants = 11;
// type can be currently "dynamic" (the default if empty string) which denotes a regular Access
// List, "scim" which represents an Access List created from SCIM group or "static" for Access
// Lists managed by IaC tools.
// type can be an empty string which denotes a regular Access List, "scim" which represents
// an Access List created from SCIM group or "static" for Access Lists managed by IaC
// tools.
string type = 12;
}
+3 -3
View File
@@ -141,9 +141,9 @@ type AccessList struct {
// Spec is the specification for an access list.
type Spec struct {
// Type can be currently "dynamic" (the default if empty string) which denotes a regular
// Access List, "scim" which represents an Access List created from SCIM group or "static"
// for Access Lists managed by IaC tools.
// Type can be an empty string which denotes a regular Access List, "scim" which represents
// an Access List created from SCIM group or "static" for Access Lists managed by IaC
// tools.
Type Type `json:"type" yaml:"type"`
// Title is a plaintext short description of the access list.
@@ -37,7 +37,7 @@ resource, which you can apply after installing the Teleport Kubernetes operator.
|owners|[][object](#specowners-items)|owners is a list of owners of the Access List.|
|ownership_requires|[object](#specownership_requires)|ownership_requires describes the requirements for a user to be an owner of the Access List. For ownership of an Access List to be effective, the user must meet the requirements of ownership_requires and must be in the owners list.|
|title|string|title is a plaintext short description of the Access List.|
|type|string|type can be currently "dynamic" (the default if empty string) which denotes a regular Access List, "scim" which represents an Access List created from SCIM group or "static" for Access Lists managed by IaC tools.|
|type|string|type can be an empty string which denotes a regular Access List, "scim" which represents an Access List created from SCIM group or "static" for Access Lists managed by IaC tools.|
### spec.audit
@@ -65,7 +65,7 @@ Optional:
- `owner_grants` (Attributes) owner_grants describes the access granted by owners to this Access List. (see [below for nested schema](#nested-schema-for-specowner_grants))
- `ownership_requires` (Attributes) ownership_requires describes the requirements for a user to be an owner of the Access List. For ownership of an Access List to be effective, the user must meet the requirements of ownership_requires and must be in the owners list. (see [below for nested schema](#nested-schema-for-specownership_requires))
- `title` (String) title is a plaintext short description of the Access List.
- `type` (String) type can be currently "dynamic" (the default if empty string) which denotes a regular Access List, "scim" which represents an Access List created from SCIM group or "static" for Access Lists managed by IaC tools.
- `type` (String) type can be an empty string which denotes a regular Access List, "scim" which represents an Access List created from SCIM group or "static" for Access Lists managed by IaC tools.
### Nested Schema for `spec.audit`
@@ -110,7 +110,7 @@ Optional:
- `owner_grants` (Attributes) owner_grants describes the access granted by owners to this Access List. (see [below for nested schema](#nested-schema-for-specowner_grants))
- `ownership_requires` (Attributes) ownership_requires describes the requirements for a user to be an owner of the Access List. For ownership of an Access List to be effective, the user must meet the requirements of ownership_requires and must be in the owners list. (see [below for nested schema](#nested-schema-for-specownership_requires))
- `title` (String) title is a plaintext short description of the Access List.
- `type` (String) type can be currently "dynamic" (the default if empty string) which denotes a regular Access List, "scim" which represents an Access List created from SCIM group or "static" for Access Lists managed by IaC tools.
- `type` (String) type can be an empty string which denotes a regular Access List, "scim" which represents an Access List created from SCIM group or "static" for Access Lists managed by IaC tools.
### Nested Schema for `spec.audit`
@@ -191,10 +191,9 @@ spec:
List.
type: string
type:
description: type can be currently "dynamic" (the default if empty
string) which denotes a regular Access List, "scim" which represents
an Access List created from SCIM group or "static" for Access Lists
managed by IaC tools.
description: type can be an empty string which denotes a regular Access
List, "scim" which represents an Access List created from SCIM group
or "static" for Access Lists managed by IaC tools.
type: string
type: object
status:
+3 -3
View File
@@ -119,9 +119,9 @@ export interface AccessListSpec {
*/
ownerGrants?: AccessListGrants;
/**
* type can be currently "dynamic" (the default if empty string) which denotes a regular Access
* List, "scim" which represents an Access List created from SCIM group or "static" for Access
* Lists managed by IaC tools.
* type can be an empty string which denotes a regular Access List, "scim" which represents
* an Access List created from SCIM group or "static" for Access Lists managed by IaC
* tools.
*
* @generated from protobuf field: string type = 12;
*/
@@ -191,10 +191,9 @@ spec:
List.
type: string
type:
description: type can be currently "dynamic" (the default if empty
string) which denotes a regular Access List, "scim" which represents
an Access List created from SCIM group or "static" for Access Lists
managed by IaC tools.
description: type can be an empty string which denotes a regular Access
List, "scim" which represents an Access List created from SCIM group
or "static" for Access Lists managed by IaC tools.
type: string
type: object
status:
@@ -298,7 +298,7 @@ func GenSchemaAccessList(ctx context.Context) (github_com_hashicorp_terraform_pl
Type: github_com_hashicorp_terraform_plugin_framework_types.StringType,
},
"type": {
Description: "type can be currently \"dynamic\" (the default if empty string) which denotes a regular Access List, \"scim\" which represents an Access List created from SCIM group or \"static\" for Access Lists managed by IaC tools.",
Description: "type can be an empty string which denotes a regular Access List, \"scim\" which represents an Access List created from SCIM group or \"static\" for Access Lists managed by IaC tools.",
Optional: true,
Type: github_com_hashicorp_terraform_plugin_framework_types.StringType,
},