docs: complete public API endpoint index with curl examples#111
Closed
liu971227-sys wants to merge 1 commit intoScottcjn:mainfrom
Closed
docs: complete public API endpoint index with curl examples#111liu971227-sys wants to merge 1 commit intoScottcjn:mainfrom
liu971227-sys wants to merge 1 commit intoScottcjn:mainfrom
Conversation
5 tasks
Owner
|
Closing for now: docs rewrite introduces encoding/format regressions and overlaps with existing API docs work. Please keep participating. To be payout-eligible on resubmission:
Good active options right now: #99 (challenge), #100 (discovery), #102 (capability), #103 (social), #124 (profile micro-bounty). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary\n- expand docs/API.md into a complete public endpoint index\n- add curl examples for read/write endpoints, including signed and admin-protected routes\n- keep links to PROTOCOL.md, GLOSSARY.md, okenomics_v1.md, and OpenAPI spec\n- update docs/README.md quick links to include OpenAPI schema and the expanded API reference\n\n## Why\nThis addresses bounty #8 acceptance criteria around API documentation coverage and runnable examples for developers and agents.\n\n## Notes\n- docs-only change\n- no runtime code changes\n- examples use -k because the node may present a self-signed TLS certificate\n