Aura.Model.HexAuditLog (Aura v0.9.1)

View Source

A struct describing a single auditable action from a Hex-compliant API.

💻 Examples

%Aura.Model.HexAuditLog{
    action: "user.create",
    params: %{id: 424, handles: nil, username: "jaqueline1935"},
    user_agent: "aura/0.9.0 (Elixir/1.18.3) (OTP/27.3.1) (test)"
}

👀 See Also

📖 Resources

Summary

Types

A short description of the action taken. (e.g "user.add", "key.generate")

A map of all the details of an audit_action/0

t()

Type describing an auditable action coming from a Hex-compliant API.

The User-Agent provided in the HTTP headers relevant to the audit_action/0

Functions

Builds a HexAuditLog from a map

Types

audit_action()

@type audit_action() :: String.t()

A short description of the action taken. (e.g "user.add", "key.generate")

💻 Examples

"docs.publish"
"release.publish"
"key.generate"
"email.public"
"email.primary"
"email.add"
"user.create"

👀 See Also

audit_params()

@type audit_params() :: map()

A map of all the details of an audit_action/0

💻 Examples

%{
  package: %{
    "id" => 445,
    "meta" => %{
      "description" => "Ea laborum odio eveniet in pariatur doloribus vel ullam aut.",
      "extra" => nil,
      "licenses" => ["Apache-2.0"],
      "links" => %{"GitHub" => "http://marquardt.com"},
      "maintainers" => nil
    },
    "name" => "zontrax_576460749439376791"
    },
    release: %{
    "has_docs" => false,
    "id" => 544,
    "meta" => %{
      "app" => "zontrax_576460749439376791",
      "build_tools" => ["mix"],
      "elixir" => "~> 1.12"
    },
    "package_id" => 445,
    "retirement" => nil,
    "version" => "0.9.0"
    }
}

👀 See Also

t()

@type t() :: %Aura.Model.HexAuditLog{
  action: audit_action(),
  params: audit_params(),
  user_agent: user_agent()
}

Type describing an auditable action coming from a Hex-compliant API.

🏷️ Keys

💻 Examples

%Aura.Model.HexAuditLog{
    action: "user.create",
    params: %{id: 424, handles: nil, username: "jaqueline1935"},
    user_agent: "aura/0.9.0 (Elixir/1.18.3) (OTP/27.3.1) (test)"
}

👀 See Also

user_agent()

@type user_agent() :: String.t()

The User-Agent provided in the HTTP headers relevant to the audit_action/0

💻 Examples

"aura/0.9.0 (Elixir/1.18.3) (OTP/27.3.1) (test)"

👀 See Also

Functions

build(m)

@spec build(m :: map()) :: t()

Builds a HexAuditLog from a map

🏷️ Params