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

bug: openrpc.json has output line in file, breaking node-rpc-docs.celestia.org #2815

Closed
jcstein opened this issue Oct 6, 2023 · 6 comments
Closed

bug: openrpc.json has output line in file, breaking node-rpc-docs.celestia.org #2815

jcstein opened this issue Oct 6, 2023 · 6 comments
Assignees
@jcstein
Labels
external Issues created by non node team members needs:triage

Comments

@jcstein
Copy link
Member

jcstein commented Oct 6, 2023

I cloned the old version of RPC docs to evaluate which one to use (either using a component like is in the docs now or improving site @distractedm1nd made) and noticed that the openrpc.json spec that is referenced on the open-rpc docs has extra output in the json file:

--> Generating OpenRPC spec
{
    "openrpc": "1.2.6",
@github-actions github-actions bot added needs:triage external Issues created by non node team members labels Oct 6, 2023
jcstein added a commit to jcstein/celestia-node that referenced this issue Oct 6, 2023
@jcstein
fix: openrpc.json remove output line from generation of json
88c0543 
resolves celestiaorg#2815
@jcstein jcstein mentioned this issue Oct 6, 2023
Merged
5 tasks
@jcstein jcstein self-assigned this Oct 6, 2023
@jcstein jcstein mentioned this issue Oct 6, 2023
Merged
11 tasks
@ramin
Copy link
Contributor

ramin commented Oct 6, 2023

@jcstein this was removed in the branch openrpc-spec with last set of commits:

9e43c63#diff-76ed074a9305c04054cdebb9e9aad2d818052b07091de1f20cad0bbac34ffb52L153

@vgonkivs @distractedm1nd what is the plan with this branch?

@jcstein
Copy link
Member Author

jcstein commented Oct 6, 2023 •
edited
Loading

hey @ramin - it looks like it's still there?

celestia-node/openrpc.json

Line 1 in 9e43c63

--> Generating OpenRPC spec

ah, i understand now. I see that it was removed from the makefile, but it is still in the exported json on the openrpc-spec branch

i don't think we need this anymore though as until they are stored with releases on main #2611 , i will be manually generating them

ramin pushed a commit that referenced this issue Oct 9, 2023
@jcstein
fix: openrpc.json remove output line from generation of json (#2816)
d05dd09 
resolves #2815

<!--
Please read and fill out this form before submitting your PR.

Please make sure you have reviewed our contributors guide before
submitting your
first PR.
-->

## Overview

<!-- 
Please provide an explanation of the PR, including the appropriate
context,
background, goal, and rationale. If there is an issue with this
information,
please provide a tl;dr and link the issue. 
-->

## Checklist

<!-- 
Please complete the checklist to ensure that the PR is ready to be
reviewed.

IMPORTANT:
PRs should be left in Draft until the below checklist is completed.
-->

- [x] New and updated code has appropriate documentation
- [x] New and updated code has new and/or updated testing
- [ ] Required CI checks are passing
- [x] Visual proof for any user facing features like CLI or
documentation updates
- [x] Linked issues closed with keywords
@ramin
Copy link
Contributor

ramin commented Oct 9, 2023

@jcstein merged to the feature branch. Yes we removed but didn't commit a fixed openrpc.json, sorry!

@ramin ramin closed this as completed Oct 9, 2023
@jcstein
Copy link
Member Author

jcstein commented Oct 10, 2023

all good! thank you!

@vgonkivs
Copy link
Member

Should we close this one #2611 ?

@jcstein
Copy link
Member Author

jcstein commented Oct 10, 2023

i don't think so. i don't see on the release or in main?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jcstein jcstein

Labels
external Issues created by non node team members needs:triage
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@ramin @vgonkivs @jcstein