+ Page not found +
+ +Sorry, but the page you were trying to get to, does not exist. You +may want to try searching this site using the sidebar + + or using our API Reference page + +to find what you were looking for.
+ +diff --git a/.gitignore b/.gitignore index 5270a57..5426429 100644 --- a/.gitignore +++ b/.gitignore @@ -8,7 +8,6 @@ /deps/ # Where third-party dependencies like ExDoc output generated docs. -/docs/ # Ignore .fetch files in case you like to edit your project deps locally. /.fetch diff --git a/docs/404.html b/docs/404.html new file mode 100644 index 0000000..ae361f4 --- /dev/null +++ b/docs/404.html @@ -0,0 +1,155 @@ + + +
+ + + + + + + + + +Sorry, but the page you were trying to get to, does not exist. You +may want to try searching this site using the sidebar + + or using our API Reference page + +to find what you were looking for.
+ +Struct representing credentials used for authorization.
+@type t() :: %LogpointApi.IncidentApi.Incident{ + incident_id: String.t(), + incident_obj_id: String.t() +}+ +
Struct used to fetch an incident.
+@type t() :: %LogpointApi.IncidentApi.IncidentComment{ + _id: String.t(), + comments: list() +}+ +
Struct to add comments to a particular incident.
+@type t() :: %LogpointApi.IncidentApi.IncidentCommentData{ + states: list(), + version: String.t() +}+ +
Struct to add comments to a list of incidents using the IncidentComment
struct.
@type t() :: %LogpointApi.IncidentApi.IncidentIDs{ + incident_ids: list(), + version: String.t() +}+ +
Struct that represents a list of incidents.
+@type t() :: %LogpointApi.IncidentApi.TimeRange{ + ts_from: Number.t(), + ts_to: Number.t(), + version: String.t() +}+ +
Struct representing a time range with timestamps in epoch.
+This module provides an implementation of the Logpoint Incident API.
+Add comments to a list of incidents.
Assign or re-assign a list of incidents.
Close a list of incidents.
Get a specific incident and its related data.
Get the states of incidents within a specific time range.
Get all incidents within a given time range.
Get users.
Reopen a list of incidents.
Resolve a list of incidents.
@spec add_comments( + String.t(), + LogpointApi.Credential.t(), + LogpointApi.IncidentApi.IncidentCommentData.t() +) :: {:ok, map()} | {:error, String.t()}+ +
Add comments to a list of incidents.
+@spec assign_incidents( + String.t(), + LogpointApi.Credential.t(), + LogpointApi.IncidentApi.IncidentIDs.t(), + String.t() +) :: {:ok, map()} | {:error, String.t()}+ +
Assign or re-assign a list of incidents.
+@spec close_incidents( + String.t(), + LogpointApi.Credential.t(), + LogpointApi.IncidentApi.IncidentIDs.t() +) :: + {:ok, map()} | {:error, String.t()}+ +
Close a list of incidents.
+@spec get_data_from_incident( + String.t(), + LogpointApi.Credential.t(), + LogpointApi.IncidentApi.Incident.t() +) :: {:ok, map()} | {:error, String.t()}+ +
Get a specific incident and its related data.
+@spec get_incident_states( + String.t(), + LogpointApi.Credential.t(), + LogpointApi.IncidentApi.TimeRange.t() +) :: + {:ok, map()} | {:error, String.t()}+ +
Get the states of incidents within a specific time range.
+@spec get_incidents( + String.t(), + LogpointApi.Credential.t(), + LogpointApi.IncidentApi.TimeRange.t() +) :: + {:ok, map()} | {:error, String.t()}+ +
Get all incidents within a given time range.
+@spec get_users(String.t(), LogpointApi.Credential.t()) :: + {:ok, map()} | {:error, String.t()}+ +
Get users.
+@spec reopen_incidents( + String.t(), + LogpointApi.Credential.t(), + LogpointApi.IncidentApi.IncidentIDs.t() +) :: + {:ok, map()} | {:error, String.t()}+ +
Reopen a list of incidents.
+@spec resolve_incidents( + String.t(), + LogpointApi.Credential.t(), + LogpointApi.IncidentApi.IncidentIDs.t() +) :: + {:ok, map()} | {:error, String.t()}+ +
Resolve a list of incidents.
+@type t() :: %LogpointApi.SearchApi.Query{ + limit: Number.t(), + query: String.t(), + repos: list(), + time_range: list() +}+ +
Struct representing a Logpoint search query.
+@type t() :: %LogpointApi.SearchApi.SearchID{search_id: String.t()}+ +
Struct representing a search id.
+This module provides an implementation of the Logpoint search API.
+Get the devices of the instance.
Get all live search on a machine.
Get all logpoints of a Logpoint instance.
Get the repos of an instance.
Create a search and get its search id.
Retrieve the search result of a specific search id.
Get the current users time zone information.
@spec get_devices(String.t(), LogpointApi.Credential.t()) :: + {:ok, map()} | {:error, String.t()}+ +
Get the devices of the instance.
+@spec get_livesearches(String.t(), LogpointApi.Credential.t()) :: + {:ok, map()} | {:error, String.t()}+ +
Get all live search on a machine.
+@spec get_logpoints(String.t(), LogpointApi.Credential.t()) :: + {:ok, map()} | {:error, String.t()}+ +
Get all logpoints of a Logpoint instance.
+@spec get_repos(String.t(), LogpointApi.Credential.t()) :: + {:ok, map()} | {:error, String.t()}+ +
Get the repos of an instance.
+@spec get_search_id( + String.t(), + LogpointApi.Credential.t(), + LogpointApi.SearchApi.Query.t() +) :: + {:ok, map()} | {:error, String.t()}+ +
Create a search and get its search id.
+@spec get_search_result( + String.t(), + LogpointApi.Credential.t(), + LogpointApi.SearchApi.SearchID.t() +) :: + {:ok, map()} | {:error, String.t()}+ +
Retrieve the search result of a specific search id.
+@spec get_user_timezone(String.t(), LogpointApi.Credential.t()) :: + {:ok, map()} | {:error, String.t()}+ +
Get the current users time zone information.
+This module provides an implementation of the Logpoint Incident API.
This module provides an implementation of the Logpoint search API.
'+((o=e.lambda(l,l))!=null?o:"")+`
+`},9:function(e,l,a,p,u){var o,n=e.lookupProperty||function(r,s){if(Object.prototype.hasOwnProperty.call(r,s))return r[s]};return((o=(n(a,"isArray")||l&&n(l,"isArray")||e.hooks.helperMissing).call(l??(e.nullContext||{}),l!=null?n(l,"results"):l,{name:"isArray",hash:{},fn:e.program(10,u,0),inverse:e.program(12,u,0),data:u,loc:{start:{line:23,column:2},end:{line:29,column:14}}}))!=null?o:"")+` +The search functionality is full-text based. Here are some tips:
+ +foo bar
) are searched as OR
*
anywhere (such as fo*
) as wildcard+
before a word (such as +foo
) to make its presence required-
before a word (such as -foo
) to make its absence required:
to search on a particular field (such as field:word
). The available fields are title
, doc
and type
WORD^NUMBER
(such as foo^2
) to boost the given wordWORD~NUMBER
(such as foo~2
) to do a search with edit distance on wordTo quickly go to a module, type, or function, use the autocompletion feature in the sidebar search.
+`},10:function(e,l,a,p,u){var o,n=e.lookupProperty||function(r,s){if(Object.prototype.hasOwnProperty.call(r,s))return r[s]};return"Sorry, we couldn't find anything for "+e.escapeExpression((o=(o=n(a,"value")||(l!=null?n(l,"value"):l))!=null?o:e.hooks.helperMissing,typeof o=="function"?o.call(l??(e.nullContext||{}),{name:"value",hash:{},data:u,loc:{start:{line:24,column:48},end:{line:24,column:57}}}):o))+`.
+`},12:function(e,l,a,p,u){var o,n=e.lookupProperty||function(r,s){if(Object.prototype.hasOwnProperty.call(r,s))return r[s]};return(o=n(a,"if").call(l??(e.nullContext||{}),l!=null?n(l,"value"):l,{name:"if",hash:{},fn:e.program(13,u,0),inverse:e.program(15,u,0),data:u,loc:{start:{line:25,column:2},end:{line:29,column:2}}}))!=null?o:""},13:function(e,l,a,p,u){var o,n=e.lookupProperty||function(r,s){if(Object.prototype.hasOwnProperty.call(r,s))return r[s]};return"Invalid search: "+e.escapeExpression((o=(o=n(a,"errorMessage")||(l!=null?n(l,"errorMessage"):l))!=null?o:e.hooks.helperMissing,typeof o=="function"?o.call(l??(e.nullContext||{}),{name:"errorMessage",hash:{},data:u,loc:{start:{line:26,column:23},end:{line:26,column:39}}}):o))+`.
+`},15:function(e,l,a,p,u){return`Please type something into the search bar to perform a search.
+ `},compiler:[8,">= 4.3.0"],main:function(e,l,a,p,u){var o,n=l??(e.nullContext||{}),r=e.lookupProperty||function(s,i){if(Object.prototype.hasOwnProperty.call(s,i))return s[i]};return`