Skip to content

feat: Use tags for chains in OpenRPC specs #229

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

stanleyjones
Copy link
Collaborator

Description

We'd like to use tags at the method level to nest them by chain, to accomplish a navigation like this:

Screenshot 2025-05-27 at 2 56 02 PM

Related Issues

Changes Made

Testing

  • I have tested these changes locally
  • I have run the validation scripts (pnpm run validate)
  • I have checked that the documentation builds correctly

Copy link

github-actions bot commented May 27, 2025

🌿 Documentation Preview

Name Status Preview Updated (UTC)
Alchemy Docs ❌ Failed May 27, 2025, 9:56 PM

Comment on lines +2474 to +2477
- api: Ethereum Methods
api-name: core-api
- api: Optimism Methods
api-name: core-api
Copy link
Collaborator Author

@stanleyjones stanleyjones May 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This works but includes all of the methods in the API spec, not just the ones that we tagged "Ethereum" or "Optimism".

Comment on lines +2 to +6
tags:
- name: "Ethereum"
description: "Ethereum Methods"
- name: "Optimism"
description: "Optimism Methods"
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would prefer to do it this way (although with $refs) to automatically nest by tag, similar to how it works for OpenAPI.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant