-
Notifications
You must be signed in to change notification settings - Fork 106
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(openapi): Remove trailing characters in descriptions #8597
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
oxarbitrage
added
A-docs
Area: Documentation
A-rpc
Area: Remote Procedure Call interfaces
P-Medium ⚡
labels
Jun 7, 2024
github-actions
bot
added
the
extra-reviews
This PR needs at least 2 reviews to merge
label
Jun 7, 2024
github-actions
bot
added
the
C-trivial
Category: A trivial change that is not worth mentioning in the CHANGELOG
label
Jun 7, 2024
arya2
previously approved these changes
Jun 7, 2024
FYI, this is not merging because of https://github.com/ZcashFoundation/zebra/actions/runs/9467963278/job/26083250170 |
Yes, i will rebase when this gets merged: #8602 |
mpguerra
approved these changes
Jun 13, 2024
@Mergifyio refresh |
✅ Pull request refreshed |
github-actions
bot
added
the
extra-reviews
This PR needs at least 2 reviews to merge
label
Jun 14, 2024
@Mergifyio refresh |
✅ Pull request refreshed |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
A-docs
Area: Documentation
A-rpc
Area: Remote Procedure Call interfaces
C-trivial
Category: A trivial change that is not worth mentioning in the CHANGELOG
P-Medium ⚡
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.
Motivation
The openapi spec has trailing
"]
on each method description, for example:PR Author Checklist
Check before marking the PR as ready for review:
Solution
Use
trim_end_matches()
in the description to fix the issue. Regenerate spec.Review
Anyone can review.
Reviewer Checklist
Check before approving the PR:
PR blockers can be dealt with in new tickets or PRs.
And check the PR Author checklist is complete.
Follow Up Work