Aura.Model.HexAuditLog (Aura v0.9.3)
View SourceA 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)"
}
📖 Resources
- 🐝 Hex
- 💬 Contact the maintainer (he's happy to help!)
👀 See Also
Summary
Types
A short description of the action taken.
A map of all the details of an audit_action/0
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
Types
@type audit_action() :: String.t()
A short description of the action taken.
💻 Examples
"docs.publish"
"release.publish"
"key.generate"
"email.public"
"email.primary"
"email.add"
"user.create"
👀 See Also
@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
@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
- params ::
Aura.Model.HexAuditLog.audit_params/0
- action ::
Aura.Model.HexAuditLog.audit_action/0
- user_agent ::
Aura.Model.HexAuditLog.user_agent/0
💻 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
@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
Builds a HexAuditLog
from a map
🏷️ Params
- m :: A map to build into a
Aura.Model.HexAuditLog.t/0