Skip to content
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.

Sign up for GitHub

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

Jump to bottom

fix(openapi): Remove trailing characters in descriptions #8597

Merged
merged 6 commits into from
Jun 15, 2024
Merged

fix(openapi): Remove trailing characters in descriptions #8597

merged 6 commits into from
Jun 15, 2024

Conversation

oxarbitrage
Copy link
Contributor

Motivation

The openapi spec has trailing "] on each method description, for example:

Submits block to the node to be validated and committed."]

PR Author Checklist

Check before marking the PR as ready for review:

  • Will the PR name make sense to users?
  • Does the PR have a priority label?
  • Have you added or updated tests?
  • Is the documentation up to date?

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:

  • Does the PR scope match the ticket?
  • Are there enough tests to make sure it works? Do the tests cover the PR motivation?
  • Are all the PR blockers dealt with?
    PR blockers can be dealt with in new tickets or PRs.

And check the PR Author checklist is complete.

Follow Up Work

@oxarbitrage oxarbitrage added A-docs Area: Documentation A-rpc Area: Remote Procedure Call interfaces P-Medium ⚡ labels Jun 7, 2024
@oxarbitrage oxarbitrage requested a review from a team as a code owner June 7, 2024 13:50
@oxarbitrage oxarbitrage requested review from arya2 and removed request for a team June 7, 2024 13:50
@github-actions github-actions bot added the extra-reviews This PR needs at least 2 reviews to merge label Jun 7, 2024
@github-actions github-actions bot added the C-trivial Category: A trivial change that is not worth mentioning in the CHANGELOG label Jun 7, 2024
arya2
arya2 previously approved these changes Jun 7, 2024
View reviewed changes
@gustavovalverde
Copy link
Member

gustavovalverde commented Jun 11, 2024 •
edited
Loading

FYI, this is not merging because of https://github.com/ZcashFoundation/zebra/actions/runs/9467963278/job/26083250170

@oxarbitrage
Copy link
Contributor Author

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
Copy link
Contributor

@Mergifyio refresh

@mergify Mergify
Copy link
Contributor

mergify bot commented Jun 13, 2024

refresh

✅ Pull request refreshed

@oxarbitrage oxarbitrage removed the extra-reviews This PR needs at least 2 reviews to merge label Jun 14, 2024
@github-actions github-actions bot added the extra-reviews This PR needs at least 2 reviews to merge label Jun 14, 2024
@oxarbitrage oxarbitrage removed the extra-reviews This PR needs at least 2 reviews to merge label Jun 15, 2024
@oxarbitrage
Copy link
Contributor Author

@Mergifyio refresh

@mergify Mergify
Copy link
Contributor

mergify bot commented Jun 15, 2024

refresh

✅ Pull request refreshed

@mergify mergify bot merged commit 791e863 into main Jun 15, 2024
140 checks passed
@mergify mergify bot deleted the openapi-fix-descriptions branch June 15, 2024 12:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mpguerra mpguerra mpguerra approved these changes

@arya2 arya2 arya2 left review comments

Assignees
No one assigned
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 ⚡
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@oxarbitrage @gustavovalverde @mpguerra @arya2