Update JSON-API & Recursive documentation #3984

cryptoni9n · 2024-10-06T21:22:54Z

fixes #3742

draft mode for now while I look for typos and test the links and menus

I'm not confident I have all of the endpoints captured here yet. Please comment if you see any missing.

…into api-documentation

cryptoni9n · 2024-10-13T21:05:13Z

I think this may be ready for a first review now.

raphjaph · 2024-10-16T22:40:18Z

This looks good so far!

I made some changes so that the examples can be expanded underneath. It's based on this. If you could transform the other things into that format, that would be great!

cryptoni9n · 2024-10-17T18:33:56Z

thanks Raph - I've used your examples to apply that format throughout. Is this more what you had in mind?

raphjaph · 2024-10-18T23:05:10Z

Yes, this looks great!

I've made some tweaks to the first two endpoints, if you could apply those to the rest as well.

Also could you apply the same template to the Recursion section of the docs and update the examples as well? I think we're missing some. Thanks!

EDIT: Just putting down some ideas here, not need to do this for now:

show required flags for this endpoint to be active
add recursive endpoints to API section as well (by reference, not copy)

cryptoni9n · 2024-10-19T16:16:45Z

Yes, this looks great!

I've made some tweaks to the first two endpoints, if you could apply those to the rest as well.

sure, I've applied those changes throughout.

Also could you apply the same template to the Recursion section of the docs and update the examples as well? I think we're missing some. Thanks!

ok - should I make a new PR or would you like it in this one?

cryptoni9n · 2024-10-19T16:23:09Z

close/reopen to restart faulty tests

raphjaph · 2024-10-19T17:02:27Z

ok - should I make a new PR or would you like it in this one?

You can put it in this one

raphjaph

Looking sweet!

Could you capitalize the the first word in all of the descriptions in recursion.md.

While we're at it maybe also add the required flags for endpoint to be active just somewhere in the description. If it doesn't require any specific flags then it doesn't have to say anything. The basic config flags I can think about are --index-addresses, --index-sats and --index-runes.

docs/src/SUMMARY.md

docs/src/inscriptions/recursion.md

raphjaph

This looks sweet!

Made some small tweaks so that it include the recursive endpoints on the API page as well. Let me know if it looks good and then I'll merge.

removed required flag section since we're using Description for it.

cryptoni9n · 2024-10-24T20:32:02Z

thanks Raph! I think it looks good, but when I do the rich diff display, the include doesn't look like it is rendering correctly. Perhaps the viewer isn't capable? Not sure...

Also, I saw one other thing that needed to be removed so I took it out.

raphjaph · 2024-10-24T20:38:38Z

The include statement is for the mdbook builder. You can run it and display the docs with just serve-docs

* Change test-bitcoincore-rpc to mockcore in README.md (ordinals#3842) * Commit twice to work around redb off-by-one bug (ordinals#3856) * Release 0.19.1 (ordinals#3864) - Bump version: 0.19.0 → 0.19.1 - Update changelog - Update changelog contributor credits - Update dependencies * Update Portuguese Translation pt.po (ordinals#3837) * Updated Chinese translation (ordinals#3881) * Fix rune links for runes with no symbol (ordinals#3849) * Suppress printing sat_ranges by default (ordinals#3867) * Re-enter beta (ordinals#3884) * Update pointer specification (ordinals#3861) * Clarify that unused runes tags should not be used (ordinals#3885) * Migrate object.rs to snafu error handling (ordinals#3858) * Make index settings harder to misuse (ordinals#3893) * Don't unnecessarily insert into utxo cache when indexing addresses (ordinals#3894) * Remove trailing space from runes specification (ordinals#3896) * Serve responses with cross origin isolation headers (ordinals#3898) * List all Bitcoin Core wallets (ordinals#3902) * Make first first and last sat in range clickable (ordinals#3903) * Migrate Outgoing to SnafuError (ordinals#3854) * Update Bitcoin Core deploy to 27.1 (ordinals#3912) * Add sat_balance to address API (ordinals#3905) Co-authored-by: raph <raphjaph@protonmail.com> * Add Dutch translation to Ordinals Handbook (ordinals#3907) * Migrate chain.rs to snafu error (ordinals#3904) * Bump version to 0.20.0-dev (ordinals#3916) * Revert "Serve responses with cross origin isolation headers" (ordinals#3920) * Remove inscription content type counts from /status page (ordinals#3922) * Unified OUTPOINT_TO_UTXO_ENTRY table (ordinals#3915) - Upgrade `redb` to 2.1.1 - Remove `--index-spent-sats` - Remove redundant pointer handling in `index_inscriptions()` - Fix incorrect `is_output_spent()` results when not using `--index-sats` - Unify UTXO index data in `OUTPOINT_TO_UTXO_ENTRY` table - Read addresses from index when exporting * Add address field to `/r/inscription/:id` (ordinals#3891) * Add inscriptions and runes details to address API endpoint (ordinals#3924) * Release 0.20.0 (ordinals#3928) - Bump ord version: 0.19.1 → 0.20.0 - Bump ordinals version: 0.0.9 → 0.0.10 - Update changelog - Update changelog contributor credits - Update dependencies * Bump version to 0.20.0-dev (ordinals#3929) * Add test to remind us to fix the UtxoEntry redb type name (ordinals#3934) * Put AddressInfo into api module (ordinals#3933) * Fix clippy lint (ordinals#3937) * Add inscription index to /status (ordinals#3938) * Remove unnecessary symbols in docs/src/guides/testing.md (ordinals#3945) * Add inscription examples to handbook (ordinals#3769) * Allow scrolling in iframe (ordinals#3947) * Skip serializing None in batch::File (ordinals#3943) * Fix /output page (ordinals#3948) * Add `/satpoint/<SATPOINT>` endpoint (ordinals#3949) * Don't log RPC connections to bitcoind (ordinals#3952) * Start indexing at correct block height (ordinals#3956) * Fix output API struct (ordinals#3957) * Remove dependency on `ord-bitcoincore-rpc` crate (ordinals#3959) * Keep sat ranges in low-level format (ordinals#3963) * Implement burn for wallet command (ordinals#3437) * Add multi parent support to wallet (ordinals#3228) * Get parents using `as_slice` instead of converting to `Vec` (ordinals#3972) * Rename parents_values -> parent_values (ordinals#3973) * Fix non-existant output lookup (ordinals#3968) * Release 0.20.1 (ordinals#3975) * Refactor burn command (ordinals#3976) * Remove regtest.ordinals.net just recipes (ordinals#3978) * Add `ord verify` (ordinals#3906) * Release 0.21.0 (ordinals#3997) - Bump version: 0.20.1 → 0.21.0 - Update changelog - Update changelog contributor credits - Update dependencies * Remove /runes/balances API endpoint (ordinals#3980) * Update rust-bitcoin in ord (ordinals#3962) * Revert redb to 2.1.3 (ordinals#4003) * Release 0.21.1 (ordinals#4006) * Update Bitcoin Core install script (ordinals#4007) * Remove pre-alpha warning from ord help (ordinals#4011) * Change mint progress to `mints / terms.cap` (ordinals#4012) * Only show rune mint progress during mint (ordinals#4013) * Show if JSON API is enabled on /status (ordinals#4014) * Update JSON-API & Recursive documentation (ordinals#3984) * Document POST method for /inscriptions (ordinals#4017) * Add authors to Handbook (ordinals#4018) * Add more info to `wallet outputs` (ordinals#4019) * Add `wallet addresses` (ordinals#4005) * Add BIP322 `wallet sign` (ordinals#3988) * Add `/r/undelegated-content/<INSCRIPTION_ID>` (ordinals#3932) * Show total child count (ordinals#4009) * Create change output when inputs containing non-outgoing runes are selected (ordinals#4028) * Release 0.21.2 (ordinals#4029) - Bump version: 0.21.1 → 0.21.2 - Update changelog - Update changelog contributor credits * Allow fallback for satpoints and addresses (ordinals#4033) * Un-pin redb dependency and update to 2.2.0 (ordinals#4032) * Add `ord wallet split` command for splitting utxos (ordinals#4030) * Hide image preview and thumbnail scrollbars (ordinals#4042) * Rescan wallet on restore (ordinals#4041) * Do not chunk runestone data pushes (ordinals#4036) * Add simple taproot HD wallet to mockcore (ordinals#4038) * Collapse long strings in HTML (ordinals#4053) * BIP322 sign file (ordinals#4026) * Identify collapsible nodes with class=collapse (ordinals#4055) * Add assert_html function (ordinals#4058) * Allow including metadata when burning inscriptions (ordinals#4045) * Get output information by address (ordinals#4056) * Document split command (ordinals#4062) * Add palindrome charm (ordinals#4064) * Allow restoring wallet with custom timestamp (ordinals#4065) * Release 0.21.3 (ordinals#4059) - Bump version: 0.21.2 → 0.21.3 - Update changelog - Update changelog contributor credits - Update dependencies - Pin `bitcoin` to 0.32.3 - Downgrade `bip322` to 0.0.8 * Add Cargo.lock --------- Co-authored-by: Anchor <49644098+TheHeBoy@users.noreply.github.com> Co-authored-by: Casey Rodarmor <casey@rodarmor.com> Co-authored-by: 0xArtur <metaverseartur@gmail.com> Co-authored-by: Dr.JingLee <95461562+DrJingLee@users.noreply.github.com> Co-authored-by: nine <118634361+cryptoni9n@users.noreply.github.com> Co-authored-by: Bohdan Cryptolions <37701692+ansigroup@users.noreply.github.com> Co-authored-by: raph <raphjaph@protonmail.com> Co-authored-by: Patrick Collins <patrick@collinatorstudios.com> Co-authored-by: Tibebtc <tibedekock@live.nl> Co-authored-by: partialord <178683722+partialord@users.noreply.github.com> Co-authored-by: Eloc <42568538+elocremarc@users.noreply.github.com> Co-authored-by: twosatsmaxi <vashalpesh@gmail.com> Co-authored-by: tiaoxizhan <tiaoxizhan@outlook.com> Co-authored-by: onchainguy <1436535+onchainguy-btc@users.noreply.github.com> Co-authored-by: lifofifo <134870335+lifofifoX@users.noreply.github.com> Co-authored-by: Arik <arik-so@users.noreply.github.com>

cryptoni9n and others added 6 commits October 6, 2024 17:16

adding guides/api.md

620b45f

fixing link to api.md

64d1445

Merge branch 'master' into api-documentation

e5cdcf9

Merge branch 'api-documentation' of https://github.com/cryptoni9n/ord …

ffbf3de

…into api-documentation

adding navigation to api.md; general cleanup

fb9e603

corrections

aeb4c35

cryptoni9n marked this pull request as ready for review October 13, 2024 21:04

cryptoni9n requested a review from raphjaph October 14, 2024 12:53

raphjaph added enhancement documentation labels Oct 16, 2024

format transformation

5c03538

cryptoni9n force-pushed the api-documentation branch from 47b4b82 to 5c03538 Compare October 17, 2024 18:22

further formatting fixes

4977255

cryptoni9n force-pushed the api-documentation branch from a3f9a3a to 4977255 Compare October 19, 2024 16:04

cryptoni9n closed this Oct 19, 2024

cryptoni9n reopened this Oct 19, 2024

cryptoni9n changed the title ~~Update JSON-API documentation~~ Update JSON-API & Recursive documentation Oct 19, 2024

modifying recursion.md

cf20fa1

cryptoni9n force-pushed the api-documentation branch from 74bdf22 to cf20fa1 Compare October 19, 2024 21:17

raphjaph requested changes Oct 20, 2024

View reviewed changes

docs/src/SUMMARY.md Outdated Show resolved Hide resolved

docs/src/inscriptions/recursion.md Outdated Show resolved Hide resolved

docs/src/inscriptions/recursion.md Outdated Show resolved Hide resolved

cryptoni9n added 2 commits October 22, 2024 13:43

adjusting order of guides

1f38d2e

Capitalization and required flag inclusion.

546983f

cryptoni9n force-pushed the api-documentation branch from 11fc14c to 546983f Compare October 23, 2024 19:01

cryptoni9n and others added 2 commits October 23, 2024 15:15

Merge branch 'master' into api-documentation

7be6c10

Include Recursive Endpoints in API page

658f15f

raphjaph approved these changes Oct 24, 2024

View reviewed changes

Update api.md

e6d19a2

removed required flag section since we're using Description for it.

Small fixes

5130196

raphjaph merged commit 441f94a into ordinals:master Oct 24, 2024
5 checks passed

cryptoni9n deleted the api-documentation branch October 24, 2024 20:53

BrewTestBot mentioned this pull request Oct 27, 2024

ord 0.21.2 Homebrew/homebrew-core#195714

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update JSON-API & Recursive documentation #3984

Update JSON-API & Recursive documentation #3984

cryptoni9n commented Oct 6, 2024

cryptoni9n commented Oct 13, 2024

raphjaph commented Oct 16, 2024 •

edited

Loading

cryptoni9n commented Oct 17, 2024

raphjaph commented Oct 18, 2024 •

edited

Loading

cryptoni9n commented Oct 19, 2024

cryptoni9n commented Oct 19, 2024

raphjaph commented Oct 19, 2024

raphjaph left a comment

raphjaph left a comment

cryptoni9n commented Oct 24, 2024

raphjaph commented Oct 24, 2024

Update JSON-API & Recursive documentation #3984

Update JSON-API & Recursive documentation #3984

Conversation

cryptoni9n commented Oct 6, 2024

cryptoni9n commented Oct 13, 2024

raphjaph commented Oct 16, 2024 • edited Loading

cryptoni9n commented Oct 17, 2024

raphjaph commented Oct 18, 2024 • edited Loading

cryptoni9n commented Oct 19, 2024

cryptoni9n commented Oct 19, 2024

raphjaph commented Oct 19, 2024

raphjaph left a comment

Choose a reason for hiding this comment

raphjaph left a comment

Choose a reason for hiding this comment

cryptoni9n commented Oct 24, 2024

raphjaph commented Oct 24, 2024

raphjaph commented Oct 16, 2024 •

edited

Loading

raphjaph commented Oct 18, 2024 •

edited

Loading