Overviewerlang logo

Module r3_hex_api_package

Hex HTTP API - Packages.

Description

Hex HTTP API - Packages.

Function Index

get/2 Gets a package.
search/3 Searches packages.

Function Details

get/2

get(Config::r3_hex_core:config(), Name::binary()) -> r3_hex_api:response()

Gets a package.

Examples:

  > r3_hex_api_package:get(r3_hex_core:default_config(), <<"package">>).
  {ok, {200, ..., #{
      <<"name">> => <<"package1">>,
      <<"meta">> => #{
          <<"description">> => ...,
          <<"licenses">> => ...,
          <<"links">> => ...,
          <<"maintainers">> => ...
      },
      ...,
      <<"releases">> => [
          #{<<"url">> => ..., <<"version">> => <<"0.5.0">>}],
          #{<<"url">> => ..., <<"version">> => <<"1.0.0">>}],
          ...
      ]}}}

search/3

search(Config::r3_hex_core:config(), Query::binary(), SearchParams::[{term(), term()}]) -> r3_hex_api:response()

Searches packages.

Examples:

  > r3_hex_api_package:search(r3_hex_core:default_config(), <<"package">>, [{page, 1}]).
  {ok, {200, ..., [
      #{<<"name">> => <<"package1">>, ...},
      ...
  ]}}

Overviewerlang logo

Generated by EDoc