Skip to content

Commit be34cd4

Browse files
sync docs (#538)
Co-authored-by: michaeljguarino <[email protected]>
1 parent 480b3ce commit be34cd4

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

pages/overview/management-api-reference.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Package v1alpha1 contains API Schema definitions for the deployments v1alpha1 AP
2424
- [GeneratedSecret](#generatedsecret)
2525
- [GitRepository](#gitrepository)
2626
- [GlobalService](#globalservice)
27+
- [Group](#group)
2728
- [HelmRepository](#helmrepository)
2829
- [InfrastructureStack](#infrastructurestack)
2930
- [MCPServer](#mcpserver)
@@ -1633,6 +1634,44 @@ _Appears in:_
16331634
| `elastic` _[ElasticsearchConnectionSettings](#elasticsearchconnectionsettings)_ | Elastic configuration for the graph store. | | Optional: \{\} <br /> |
16341635

16351636

1637+
#### Group
1638+
1639+
1640+
1641+
Group represents a group of users within the system, managed via the Console API.
1642+
It includes specifications for the group's name and description.
1643+
1644+
1645+
1646+
1647+
1648+
| Field | Description | Default | Validation |
1649+
| --- | --- | --- | --- |
1650+
| `apiVersion` _string_ | `deployments.plural.sh/v1alpha1` | | |
1651+
| `kind` _string_ | `Group` | | |
1652+
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | |
1653+
| `spec` _[GroupSpec](#groupspec)_ | Spec defines the desired state of the Group. | | |
1654+
1655+
1656+
#### GroupSpec
1657+
1658+
1659+
1660+
GroupSpec defines the desired state of Group.
1661+
1662+
1663+
1664+
_Appears in:_
1665+
- [Group](#group)
1666+
1667+
| Field | Description | Default | Validation |
1668+
| --- | --- | --- | --- |
1669+
| `name` _string_ | Name specifies the name for this Group.<br />If not provided, the name from the resource metadata will be used. | | Optional: \{\} <br /> |
1670+
| `description` _string_ | Description provides a detailed explanation of this Group's purpose. | | Optional: \{\} <br /> |
1671+
| `global` _boolean_ | Global indicates whether all users in the system are automatically added to this group. | false | Optional: \{\} <br /> |
1672+
| `reconciliation` _[Reconciliation](#reconciliation)_ | Reconciliation settings for this resource.<br />Controls drift detection and reconciliation intervals. | | Optional: \{\} <br /> |
1673+
1674+
16361675
#### HTTPConnection
16371676

16381677

@@ -3615,6 +3654,7 @@ _Appears in:_
36153654
- [GeneratedSecretSpec](#generatedsecretspec)
36163655
- [GitRepositorySpec](#gitrepositoryspec)
36173656
- [GlobalServiceSpec](#globalservicespec)
3657+
- [GroupSpec](#groupspec)
36183658
- [HelmRepositorySpec](#helmrepositoryspec)
36193659
- [InfrastructureStackSpec](#infrastructurestackspec)
36203660
- [MCPServerSpec](#mcpserverspec)

0 commit comments

Comments
 (0)