Reworked documentation of Soroban RPC methods using open-rpc-docs-react component to be consistent with Anchor API #603
Conversation
…ct component to be consistent with Anchor API
|
Preview is available here: |
|
Hi, @MazurakIhor Thanks SO much for putting this PR together! I've been really interested in getting our RPC spec into OpenRPC format recently, working to get the spec generated from the source code itself. This PR is a really good step toward integrating the OpenRPC document(s) into our docusaurus site! We've had some other PRs merged in lately that have presented some conflicts on your branch. Could you resolve those for me, and push you changes back to your main branch? |
# Conflicts: # api/methods/getEvents.mdx # package-lock.json # src/dev-server-plugin.js # yarn.lock
|
Preview is available here: |
|
Hi, @ElliotFriend. |
src/components/RpcMethod.tsx
Outdated
|
|
||
| const CodeBlock = require('@theme/CodeBlock').default; | ||
|
|
||
| export const RpcMethod = ({ method }) => { |
There was a problem hiding this comment.
TypeScript is giving me an error about method being implicitly any type. Can you add the string here, since we're in a TS component?
| "schema": { | ||
| "type": "object", | ||
| "properties": { | ||
| "entries": { |
There was a problem hiding this comment.
Looks like the return object has been updated again (sorry for more conflicts to fix lol). The newest changes are from this commit: 7506f2b
# Conflicts: # api/methods/getLedgerEntries.mdx
|
Preview is available here: |
|
@ElliotFriend Regarding styles: will try to adjust styles mentioned in your last comment, however in such case Soroban docs will differ from Stellar docs which were released recently. |
I'm a dummy! I didn't know that the Stellar docs had incorporated this. No worries about the styles then. I think it's likely better to leave it as is. Thanks! |
There was a problem hiding this comment.
Thanks again for the updates @MazurakIhor
This is a great step toward automating the spec even more!
No description provided.