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.

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

Enriched API schema #5973

Open
wemeetagain opened this issue Sep 20, 2023 · 3 comments
Open

Enriched API schema #5973

wemeetagain opened this issue Sep 20, 2023 · 3 comments

Comments

@wemeetagain
Copy link
Member

wemeetagain commented Sep 20, 2023

Enriched schema would definitely be nice to have, especially for POST requests. I think we would have to pull a pinned version of the beacon-API schema from github and then override each route based on operationId. This will become especially important if we want to generate a API docs page with redoc (or similar tooling).

Originally posted by @nflaig in #5970 (comment)

@wemeetagain
Copy link
Member Author

wemeetagain commented Sep 20, 2023

One annoying thing is that this will blow up our bundle size. Current unpacked package size is 424K, the schema is 691K

@wemeetagain
Copy link
Member Author

@nflaig
I think we can close this as wontfix unless you have any other ideas about this.

@nflaig
Copy link
Member

nflaig commented Oct 22, 2024

This will become especially important if we want to generate a API docs page with redoc (or similar tooling).

do we want to do this? I think we are fine with just the beacon-api spec and the explorer we have local still provides an overview of other custom apis

We can still fetch the beacon-api spec json from github on demand and enrich the schema when you access /documentation path and cache it afterwards.

I personally don't really use the local explorer since I only use curl, so not sure it would be useful to anyone

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

No branches or pull requests

2 participants