https://github.com/blockscout/swaggers
https://github.com/blockscout/swaggers
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/blockscout/swaggers
- Owner: blockscout
- License: mit
- Created: 2024-05-06T09:17:13.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2025-02-13T17:33:49.000Z (over 1 year ago)
- Last Synced: 2025-02-13T18:35:15.797Z (over 1 year ago)
- Language: HTML
- Homepage: https://blockscout.github.io/swaggers/
- Size: 621 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Blockscout Swaggers
> This repo contains actual swagger files for blockscout microservices.
## Add new service
1. Install node_modules and run the script to generate swagger file
```bash
npm install
npm run new
```
2. Add github action job step to your CICD
```yaml
jobs:
other-jobs:
...
push-swagger:
if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags'))
uses: blockscout/blockscout-rs/.github/workflows/_push_swagger.yml@main
with:
service_name: '{service_name}'
swagger_path: '{swagger_path}'
secrets:
api_token_github: ${{ secrets.BLOCKSCOUT_BOT_TOKEN }}
```
## Update existing service with new template version
* Run the script to generate swagger file
```bash
npm run regenerate
```