improve/update documentation in api/oas_schemas.py #1244
Merged
Conversation
This file contains 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
Specify that the amount of the invoice sent in `update_invoice` should take into consideration `routing_budget_ppm`. Specify that the signed messages should be signed with SHA512. Remove the warning that in the future canceling not taken orders might result in losing the bond. Fix a broken link. Specify that the PGP key should be ed25519/cert,sign+cv25519/encr.
jerryfletcher21
changed the title
|
Thank you for catching these issues and improving our API docs for all future developers. Please post an invoice for 15K Sats with a long expiration time for a small DevFund tip. |
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.
What does this PR do?
Some improvements in the documentation that I noticed while writing roboauto in https://learn.robosats.com/docs/api.
Specify that the amount of the invoice sent in
update_invoiceshould take into considerationrouting_budget_ppm.Specify that the signed messages should be signed with SHA512.
Fix a repetition and a broken link.
Specify that the PGP key should be ed25519/cert,sign+cv25519/encr.
Remove the warning that in the future canceling not taken orders might result in losing the bond.
In roboauto I have an action
recreate-orderthat updates an online order by canceling and recreating withsome parameters changed. Obviously if the bond is lost when canceling an order I will have to remove this feature.
I spoke with @Reckless-Satoshi and he confirmed that the bond will not be lost in the future.
Checklist before merging
pip install pre-commit, thenpre-commit install. Pre-commit installs git hooks that automatically check the codebase. If pre-commit fails when you commit your changes, please fix the problems it points out.