docs: update api docs for queue-tx #40
Closed
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
Added Admin enpoint docs into the Open-API configuration
Added summarys and descriptions to all endpoints currently covered in Open-api docs.
added install-ytt.sh to gitattributes, added universal line to catch all .sh files and ensure proper line endings when cloned to windows machines.
djwhitt
requested changes
Aug 31, 2023
docs/openapi.yaml
Outdated
| summary: Prioritize a transaction in the queue. | ||
| description: Stage a specific TX ID as priority for your Gateway to locate and index. | ||
| summary: Prioritize a transaction or bundle in the queue. | ||
| description: Stage a specific TX ID as priority for your Gateway to locate and index. This can be any L1 transaction, or bundle if your Gateway is configured to unbundle and index. |
There was a problem hiding this comment.
I worry this will be confusing since you can't actually queue a nested bundle using this endpoint. Maybe we should keep the original wording, but add something like "this will trigger bundle processing if the transaction is a bundle".
docs/openapi.yaml
Outdated
| @@ -719,7 +719,7 @@ paths: | |||
| id: | |||
| type: string | |||
| pattern: '^[0-9a-zA-Z_-]{43}$' | |||
| description: TX ID of the transaction you would like to prioritize. | |||
| description: TX ID of the transaction or bundle you would like to prioritize. | |||
There was a problem hiding this comment.
We should keep the original wording on this one. It must be a TX ID. An ID for a nested bundle wouldn't work.
djwhitt
approved these changes
Aug 31, 2023
|
Looks like there are rebase conflicts. I'll sort those out and merge in a bit. |
|
Integrated this by cherry picking off the branch to avoid rebase conflicts. |
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.
No description provided.