Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

incident_api: create module doc #3

Merged
merged 1 commit into from
May 8, 2024
Merged

incident_api: create module doc #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions lib/incident_api.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,28 @@
defmodule LogpointApi.IncidentApi do
@moduledoc """
This module provides an implementation of the Logpoint Incident API.

## Modules

- `TimeRange` : A struct used to represent a time range.
- `Incident` : A struct used to represent an incident.
- `IncidentComment` : A struct used to represent an incident comment.
- `IncidentCommentData` : A struct used to represent incident comment data.
- `IncidentIDs` : A struct used to represent incident IDs.

## Public Functions

- `get_incidents/3` : Retrieves incidents within a specified time range.
- `get_data_from_incident/3` : Retrieves data from a specific incident.
- `get_incident_states/3` : Retrieves incident states within a specified time range.
- `get_users/2` : Retrieves user data.
- `add_comments/3` : Adds comments to an incident.
- `assign_incidents/4` : Assigns incidents to a user.
- `resolve_incidents/3` : Resolves incidents.
- `reopen_incidents/3` : Reopens incidents.
- `close_incidents/3` : Closes incidents.
"""

alias LogpointApi.Credential
alias LogpointApi.IncidentApi.{Incident, IncidentComment, IncidentCommentData, IncidentIDs, TimeRange}

Expand Down
Loading