Skip to content

Commit 863934d

Browse files
committed
fix some doc comments
1 parent e550365 commit 863934d

File tree

6 files changed

+25
-29
lines changed

6 files changed

+25
-29
lines changed

coderd/apidoc/docs.go

Lines changed: 4 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

coderd/apidoc/swagger.json

Lines changed: 5 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

codersdk/idpsync.go

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,10 @@ import (
1212
)
1313

1414
type GroupSyncSettings struct {
15-
// Field selects the claim field to be used as the created user's
16-
// groups. If the group field is the empty string, then no group updates
17-
// will ever come from the OIDC provider.
15+
// Field is the name of the claim field that specifies what groups a user
16+
// should be in. If empty, no groups will be synced.
1817
Field string `json:"field"`
19-
// Mapping maps from an OIDC group --> Coder group ID
18+
// Mapping is a map from OIDC groups to Coder group IDs
2019
Mapping map[string][]uuid.UUID `json:"mapping"`
2120
// RegexFilter is a regular expression that filters the groups returned by
2221
// the OIDC provider. Any group not matched by this regex will be ignored.
@@ -62,11 +61,10 @@ func (c *Client) PatchGroupIDPSyncSettings(ctx context.Context, orgID string, re
6261
}
6362

6463
type RoleSyncSettings struct {
65-
// Field selects the claim field to be used as the created user's
66-
// groups. If the group field is the empty string, then no group updates
67-
// will ever come from the OIDC provider.
64+
// Field is the name of the claim field that specifies what organization roles
65+
// a user should be given. If empty, no roles will be synced.
6866
Field string `json:"field"`
69-
// Mapping maps from an OIDC group --> Coder organization role
67+
// Mapping is a map from OIDC groups to Coder organization roles.
7068
Mapping map[string][]string `json:"mapping"`
7169
}
7270

codersdk/workspaces.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ const (
9393
// CreateWorkspaceBuildRequest provides options to update the latest workspace build.
9494
type CreateWorkspaceBuildRequest struct {
9595
TemplateVersionID uuid.UUID `json:"template_version_id,omitempty" format:"uuid"`
96-
Transition WorkspaceTransition `json:"transition" validate:"oneof=create start stop delete,required"`
96+
Transition WorkspaceTransition `json:"transition" validate:"oneof=start stop delete,required"`
9797
DryRun bool `json:"dry_run,omitempty"`
9898
ProvisionerState []byte `json:"state,omitempty"`
9999
// Orphan may be set for the Destroy transition.

docs/reference/api/builds.md

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/api/schemas.md

Lines changed: 8 additions & 9 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)