The API reference is generated from Swagger comments and struct tags, and several `enums:"..."` tags narrowed a named enum type, so the docs omitted values the server returns. For example, `User.status` listed only `active` and `suspended`, not `dormant`, and `TemplateVersion.warnings` listed `DEPRECATED_PARAMETERS`, which is not a value of the type. Remove 34 `enums` tags that narrow or duplicate a named type so the referenced type's full value list is used. Tags that describe an intentional subset stay: ACL role fields (which omit the `""` deleted sentinel used only in update requests), `APIKey.scope`, and plain-string fields. `Template.provisioner` keeps its tag because `.swaggo` replaces `ProvisionerType` with `string`. Also fix enum defects that break code generators: - The provisioner jobs and daemons `status` query parameters listed their enum twice (Swagger 2.0 requires unique `enum` items) or with the wrong type. Both are now `[]codersdk.ProvisionerJobStatus` and `[]codersdk.ProvisionerDaemonStatus`, matching what each handler parses, including comma-separated values. The daemons route previously documented job statuses, which the handler rejects with a 500. - Replace the `_` zero placeholder of `WatchErrorCode` with `iota + 1`, so the spec no longer lists 0 or `x-enum-varnames: ["_", ...]`. Wire values are unchanged. Where the narrowed tag hid values the server returns, the SDK type now includes them: `LoginTypeOAuth2ProviderApp`, `BuildReasonAutodelete`, and `MissingTemplateParameter` widen the generated TypeScript unions. The dashboard attributes `autodelete` builds to Coder like other system builds. `APIKey.login_type` and `AuthorizationCheck.action` set explicit examples so the generated samples stay representative. `TestSwaggerEnumsNotNarrowed` fails when a property's enum list drops values of its named type (other than the 15 allowlisted intentional subsets), lists a value the type lacks, or repeats a value. Part of DOCS-1122, split from #30121. --- 🤖 Built with AI assistance.
75 lines
2.9 KiB
Go
75 lines
2.9 KiB
Go
package codersdk
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"net/http"
|
|
)
|
|
|
|
// ShareableWorkspaceOwners controls whose workspaces can be shared
|
|
// within an organization.
|
|
type ShareableWorkspaceOwners string
|
|
|
|
const (
|
|
ShareableWorkspaceOwnersNone ShareableWorkspaceOwners = "none"
|
|
ShareableWorkspaceOwnersEveryone ShareableWorkspaceOwners = "everyone"
|
|
ShareableWorkspaceOwnersServiceAccounts ShareableWorkspaceOwners = "service_accounts"
|
|
)
|
|
|
|
// WorkspaceSharingSettings represents workspace sharing settings affecting an
|
|
// organization.
|
|
type WorkspaceSharingSettings struct {
|
|
// SharingGloballyDisabled is true if sharing has been disabled for this
|
|
// organization because of a deployment-wide setting.
|
|
SharingGloballyDisabled bool `json:"sharing_globally_disabled"`
|
|
// SharingDisabled is deprecated and left for backward compatibility
|
|
// purposes.
|
|
// Deprecated: use `ShareableWorkspaceOwners` instead
|
|
SharingDisabled bool `json:"sharing_disabled"`
|
|
// ShareableWorkspaceOwners controls whose workspaces can be shared
|
|
// within the organization.
|
|
ShareableWorkspaceOwners ShareableWorkspaceOwners `json:"shareable_workspace_owners"`
|
|
}
|
|
|
|
// UpdateWorkspaceSharingSettingsRequest represents workspace sharing settings
|
|
// that can be updated for an organization.
|
|
type UpdateWorkspaceSharingSettingsRequest struct {
|
|
// SharingDisabled is deprecated and left for backward compatibility
|
|
// purposes.
|
|
// Deprecated: use `ShareableWorkspaceOwners` instead
|
|
SharingDisabled bool `json:"sharing_disabled,omitempty"`
|
|
// ShareableWorkspaceOwners controls whose workspaces can be shared
|
|
// within the organization.
|
|
ShareableWorkspaceOwners ShareableWorkspaceOwners `json:"shareable_workspace_owners,omitempty"`
|
|
}
|
|
|
|
// WorkspaceSharingSettings retrieves the workspace sharing settings for an organization.
|
|
func (c *Client) WorkspaceSharingSettings(ctx context.Context, orgID string) (WorkspaceSharingSettings, error) {
|
|
res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/organizations/%s/settings/workspace-sharing", orgID), nil)
|
|
if err != nil {
|
|
return WorkspaceSharingSettings{}, err
|
|
}
|
|
defer res.Body.Close()
|
|
|
|
if res.StatusCode != http.StatusOK {
|
|
return WorkspaceSharingSettings{}, ReadBodyAsError(res)
|
|
}
|
|
var resp WorkspaceSharingSettings
|
|
return resp, ReadBodyAsJSON(res, &resp)
|
|
}
|
|
|
|
// PatchWorkspaceSharingSettings modifies the workspace sharing settings for an organization.
|
|
func (c *Client) PatchWorkspaceSharingSettings(ctx context.Context, orgID string, req UpdateWorkspaceSharingSettingsRequest) (WorkspaceSharingSettings, error) {
|
|
res, err := c.Request(ctx, http.MethodPatch, fmt.Sprintf("/api/v2/organizations/%s/settings/workspace-sharing", orgID), req)
|
|
if err != nil {
|
|
return WorkspaceSharingSettings{}, err
|
|
}
|
|
|
|
defer res.Body.Close()
|
|
if res.StatusCode != http.StatusOK {
|
|
return WorkspaceSharingSettings{}, ReadBodyAsError(res)
|
|
}
|
|
var resp WorkspaceSharingSettings
|
|
return resp, ReadBodyAsJSON(res, &resp)
|
|
}
|