gira

gira v0.3.0 Gira

This module defines the Gira contract/interface for clients to use.

Link to this section Summary

Types

t()

Functions

close_issue(client, map)
create_issue_with_basic_info(client, payload)
get_issue_basic_info_by_query(client, filter)

returns basic information of an existent Jira issue when running with a jql query

new(base_url, auth_token)

initialization of Gira by setting the necessary properties to a successful connection.

Link to this section Types

Link to this type

t()

t() :: %Gira{authorization_token: String.t(), base_url: String.t()}

Link to this section Functions

Link to this function

close_issue(client, map)

close_issue(String.t(), %{jira_id: String.t(), transition_id: String.t()}) ::
  {atom(), %{status: number(), payload: %{}}}
Link to this function

create_issue_with_basic_info(client, payload)

create_issue_with_basic_info(%{}, %{}) ::
  {atom(), %{status: number(), payload: %{}}}
Link to this function

get_issue_basic_info_by_query(client, filter)

get_issue_basic_info_by_query(%{}, String.t()) ::
  {atom(), %{status: number(), payload: %{}}}

returns basic information of an existent Jira issue when running with a jql query

Parameters

  • client: a client information that would support the establishment of a HTTP connection
  • filter: jql query

Examples:

  • Gira.get_issue_basic_info_by_query(client, "labels%3DGithub-1210") { :ok, %{ status: 200, payload: % {} }}
Link to this function

new(base_url, auth_token)

new(String.t(), String.t()) ::
  {atom(), %Gira{authorization_token: term(), base_url: term()}}

initialization of Gira by setting the necessary properties to a successful connection.

Parameters

  • base_url: Jira server url to connect
  • auth_token: authorization token to be set at the HTTP header

Examples

iex> Gira.new("https://myserver.jira.com/rest/api/2", "Basic ajUHHJ9898hdhdsdsd434jh==") {:ok, %Gira{ authorization_token: "Basic ajUHHJ9898hdhdsdsd434jh==", base_url: "https://myserver.jira.com/rest/api/2" }}