View Source ProdopsEx.Project (ProdopsEx v0.1.0)

Handles project operations for the ProdOps API.

A Project is used for organization, and likely represents some real-world project, such as development of an application. Some resources can be Project-scoped. A Team may have multiple Projects.

Summary

Functions

list(config \\ [])

Returns a list of all projects for a given team

Functions

Link to this function

list(config \\ [])

View Source 
@spec list(Keyword.t()) :: {:ok, map()} | {:error, any()}

Returns a list of all projects for a given team

Parameters

  • config (optional): a configuration map used to override default config values

Examples 

iex> ProdopsEx.Project.list()
{:ok,
  %{
    status: "ok",
    response: %{
      "projects" => [
        %{
          "id" => 1,
          "name" => "Project Name",
          "overview" => "Project Overview"
        },
        %{
          "id" => 2,
          "name" => "Second Project",
          "overview" => "Second Project Overview"
        }
      ]
    }
  }
}