MishkaDocument.SectionBookmark (Mishka Document v0.0.1)

Copy Markdown View Source

Manages user bookmarks for documentation sections.

This resource represents bookmarks that users create to save documentation sections for later reading or reference. Each bookmark links a user to a specific section, creating a personal documentation reference list.

A bookmark keeps the section it was made for. To bookmark another section, remove this one (:remove) and create a new one (:create).

Summary

Functions

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

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

Types

t()

@type t() :: %MishkaDocument.SectionBookmark{
  __lateral_join_source__: term(),
  __meta__: term(),
  __metadata__: term(),
  __order__: term(),
  aggregates: term(),
  calculations: term(),
  id: term(),
  inserted_at: term(),
  owning_section: term(),
  section: term(),
  section_id: term(),
  updated_at: term(),
  user: term(),
  user_id: term()
}

Functions

default_short_name()

input(opts)

@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

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

input(opts, action)

@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?(left, right)