Skip to content

Documented registry v2 API changes. - #699

Open
Randy808 wants to merge 1 commit into
Blockstream:masterfrom
Randy808:update-api-doc-with-registry-changes-20261116
Open

Randy808 wants to merge 1 commit into
Blockstream:masterfrom
Randy808:update-api-doc-with-registry-changes-20261116

Conversation

@Randy808

Copy link
Copy Markdown
Collaborator

No description provided.

Comment thread API.md
- `burned_reissuance_tokens`: the number of reissuance tokens burned

If the asset is available on the registry, the following fields are returned as well:
If the asset is available on the configured [asset registry](README.md#liquid-asset-registry), the following fields are returned as well:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this anchor doesn't exist (yet)

Comment thread API.md

- `available`: fresh registry metadata is included.
- `not_found`: the registry has no entry for the asset; only local asset data is returned.
- `stale`: expired metadata is included while a background refresh runs.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there are 3 cases where stale is returned,

  1. refresh in flight
  2. refresh failed
  3. cache at capacity
    (maybe want t update this doc here?)

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants