Bourse.Unified.Descriptor (bourse v0.1.0)

Copy Markdown View Source

Authored unified-method descriptors for Descripex api() hints.

Merges endpoints.descriptors from runtime venue specs at compile time. Bourse uses build_api_opts/2 to enrich hints (slot 5) while keeping hand-authored Elixir arg shape and curated @doc descriptions.

Summary

Functions

build_api_opts(js_name, required_params)

Builds Descripex api() opts from authored descriptor data and Elixir arg shape.

descriptors()

Returns the merged JS-name → descriptor map from runtime venue specs.

Functions

build_api_opts(js_name, required_params)

@spec build_api_opts(String.t(), [atom()]) :: keyword()

Builds Descripex api() opts from authored descriptor data and Elixir arg shape.

required_params is the hand-authored positional tail (after exchange). Falls back to structural hints when no descriptor exists for js_name.

descriptors()

@spec descriptors() :: %{required(String.t()) => map()}

Returns the merged JS-name → descriptor map from runtime venue specs.