# `MishkaDocument.Workspace`
[🔗](https://github.com/mishka-group/mishka_document/blob/v0.0.1/lib/mishka_document/resources/workspace.ex#L5)

Manages document workspaces in the MishkaDocument plugin.

This resource represents workspaces that can organize documents and notes.
Each workspace belongs to a specific site and supports various statuses (active, archived, draft)
with metadata tracking including SEO tags, Schema.org structured data, and display ordering.

The resource implements soft deletion via archival and provides comprehensive metadata management
including SEO optimization and structured data support.

Database-level constraints ensure data integrity with slug validation and prevention
of modifications to archived workspaces. Multi-tenant isolation ensures workspaces
are properly segregated between sites. The resource provides extensive API actions
for external integrations.

# `t`

```elixir
@type t() :: %MishkaDocument.Workspace{
  __lateral_join_source__: term(),
  __meta__: term(),
  __metadata__: term(),
  __order__: term(),
  aggregates: term(),
  archived_at: term(),
  calculations: term(),
  current_version_id: term(),
  current_version_number: term(),
  current_version_published_at: term(),
  description: term(),
  display_order: term(),
  edition_languages: term(),
  editions: term(),
  featured: term(),
  health_metrics: term(),
  id: term(),
  inserted_at: term(),
  language: term(),
  language_group_id: term(),
  language_variants: term(),
  maintainers_info: term(),
  master_language_variants: term(),
  master_tag_names: term(),
  master_versions: term(),
  master_versions_count: term(),
  name: term(),
  path: term(),
  permissions: term(),
  schema: term(),
  seo_tags: term(),
  site: term(),
  site_id: term(),
  slug: term(),
  status: term(),
  tag_names: term(),
  tenant_versions: term(),
  updated_at: term(),
  versions: term(),
  versions_count: term()
}
```

# `__guarded_change__`

Apply the full GuardedStruct pipeline (sanitize → validate → derive →
main_validator) to `attrs` and return either `{:ok, transformed_attrs}`
or `{:error, errors}`. Wire this into an `Ash.Resource.Change` to plug
guardedstruct rules into Ash's changeset pipeline.

The function is named `__guarded_change__` because it does more than
validate — it can also transform values (trim, downcase, slugify,
auto-fill, etc.) before they reach the data layer.

# `__guarded_field_meta__`

O(1) lookup of a field's compile-time metadata by name. Returns
`nil` for unknown fields.

# `__guarded_field_name_set__`

Compile-time-baked `MapSet` of every field name owned by the
`guardedstruct` block. Used by `GuardedStruct.AshResource.Change`
to decide, in O(1), whether a key in `changeset.atomics`
belongs to the pipeline.

# `default_short_name`

# `for_viewer`

```elixir
@spec for_viewer(map() | nil, Ash.UUID.t()) :: struct() | nil
```

The workspace `id` as `user` may read it, or `nil` when there is none or `user` may not read it.

A master (a user whose `site_id` is nil) reads it through `:master_get`; a user of a site through
`:read` under that site.

# `input`

```elixir
@spec input(values :: map() | Keyword.t()) :: map() | no_return()
```

Validates that the keys in the provided input are valid for at least one action on the resource.

Raises a KeyError error at compile time if not. This exists because generally a struct should only ever
be created by Ash as a result of a successful action. You should not be creating records manually in code,
e.g `%MyResource{value: 1, value: 2}`. Generally that is fine, but often with embedded resources it is nice
to be able to validate the keys that are being provided, e.g

```elixir
Resource
|> Ash.Changeset.for_create(:create, %{embedded: EmbeddedResource.input(foo: 1, bar: 2)})
|> Ash.create()
```

# `input`

```elixir
@spec input(values :: map() | Keyword.t(), action :: atom()) :: map() | no_return()
```

Same as `input/1`, except restricts the keys to values accepted by the action provided.

# `json_api_match_route`

# `primary_key_matches?`

---

*Consult [api-reference.md](api-reference.md) for complete listing*