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

Manages user follows for documentation workspaces.

This resource represents follow relationships where users can follow workspaces to
stay updated with the workspace's documentation updates. Each follow links a user
to a specific workspace and tracks when the follow occurred and notification preferences.

The unique constraint on follower_user_id and workspace_id ensures each user can
only follow a specific workspace once. The notification_enabled field allows users
to control whether they receive notifications about the workspace's new content,
updates, or new versions.

This resource has no multitenancy of its own, so a follow may only name a workspace of the site it
is made for — see `MishkaCmsCore.Runtime.Resources.Validations.TenantIsolation`. Database-level
constraints ensure data integrity with cascade deletes when workspaces or users are removed.

# `t`

```elixir
@type t() :: %MishkaDocument.WorkspaceFollower{
  __lateral_join_source__: term(),
  __meta__: term(),
  __metadata__: term(),
  __order__: term(),
  aggregates: term(),
  calculations: term(),
  followed_at: term(),
  follower_user: term(),
  follower_user_id: term(),
  id: term(),
  inserted_at: term(),
  notification_enabled: term(),
  owning_workspace: term(),
  updated_at: term(),
  workspace: term(),
  workspace_id: 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`

# `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*