Skip to content

REST API docs page #2070

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
Open
NikitaSavik opened this issue Jul 3, 2024 · 6 comments · May be fixed by #2725
Open

REST API docs page #2070

NikitaSavik opened this issue Jul 3, 2024 · 6 comments · May be fixed by #2725
Assignees
@tom2drum

Comments

@NikitaSavik
Copy link
Contributor

NikitaSavik commented Jul 3, 2024 •
edited
Loading

In order to improve visibility for microservices API, expand API docs page with all of the sattelite swaggers, with possibility to anchor-link parts of the page
Design
Tabs and swaggers to be configurable via ENVs
@tom2drum
Copy link
Collaborator

tom2drum commented Jul 3, 2024

Is this a duplicate of #2038 ?

@tgladilina
Copy link
Collaborator

Mockups in Figma

Image

@NikitaSavik
Copy link
Contributor Author

  • Add mixpanel tracking event for navigation menu
    _with attribute 'externa':true for target="blank" links

@tom2drum tom2drum added the need API For issues that wait for API changes label Jul 15, 2024
@sevenzing sevenzing mentioned this issue Jul 25, 2024
Closed
@bragov4ik
Copy link

Stats service now serves swagger (staging):
https://stats-sepolia.k8s-dev.blockscout.com/api/v1/docs/swagger.yaml

@ulyanas
Copy link

ulyanas commented Oct 28, 2024

@ulyanas - check if Swagger is ready, ETA - ?

@NikitaSavik NikitaSavik removed the need API For issues that wait for API changes label Feb 11, 2025
@tom2drum tom2drum self-assigned this May 9, 2025
@tom2drum tom2drum linked a pull request May 12, 2025 that will close this issue
Draft
4 tasks
@tom2drum
Copy link
Collaborator

Wait while the YAML file is generated for the other microservices as well.
blockscout/blockscout-rs#1362

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

@tom2drum tom2drum

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

API documentation page blockscout/frontend
5 participants
@NikitaSavik @ulyanas @bragov4ik @tom2drum @tgladilina