{"id":13567074,"url":"https://github.com/sei-protocol/sei-chain","last_synced_at":"2026-01-23T21:13:26.041Z","repository":{"id":36973986,"uuid":"493429814","full_name":"sei-protocol/sei-chain","owner":"sei-protocol","description":null,"archived":false,"fork":false,"pushed_at":"2025-05-12T23:15:35.000Z","size":293377,"stargazers_count":2776,"open_issues_count":130,"forks_count":826,"subscribers_count":120,"default_branch":"main","last_synced_at":"2025-05-12T23:23:09.036Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sei-protocol.png","metadata":{"files":{"readme":"docs/README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-05-17T22:17:39.000Z","updated_at":"2025-05-12T07:43:04.000Z","dependencies_parsed_at":"2023-12-25T04:30:33.939Z","dependency_job_id":"61617dab-1536-4707-96c9-36121e4921a9","html_url":"https://github.com/sei-protocol/sei-chain","commit_stats":null,"previous_names":[],"tags_count":252,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sei-protocol%2Fsei-chain","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sei-protocol%2Fsei-chain/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sei-protocol%2Fsei-chain/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sei-protocol%2Fsei-chain/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sei-protocol","download_url":"https://codeload.github.com/sei-protocol/sei-chain/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254010823,"owners_count":21998993,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T13:02:23.041Z","updated_at":"2026-01-23T21:13:25.999Z","avatar_url":"https://github.com/sei-protocol.png","language":"Go","readme":"# OpenAPI/Swagger docs generation\n\n\u003e **Note:** Anytime we make changes to the APIs/proto files, we also need to update the Swagger/OpenAPI docs.\n\nBoth Swagger and OpenAPI terms are used interchangeably in this document.\n-  [OpenAPI](https://github.com/OAI/OpenAPI-Specification/) = specification\n- Swagger = Tools for implementing the specification.\n\nThe process of Swagger docs generation involves running a script that does the following tasks:\n1. Generating the swagger yml file using the `ignite` tool.\n2. Updating the static assets for the Swagger UI.\n\n## Prerequisites\n\nThe docs generation script uses the `ignite` tool to generate the OpenAPI docs.\nSo, first install the `ignite` tool, if not installed already.\nWe need version v0.23.0, which is outdated, but works with the current version of the codebase.\nPull binaries from the [releases page](https://github.com/ignite/cli/releases/tag/v0.23.0) or install from source code \nfollowing instructions.\n\nVerify the installation by running `ignite version`:\n\n```bash\n% ignite version          \n·\n· 🛸 Ignite CLI v28.2.0 is available!\n·\n· To upgrade your Ignite CLI version, see the upgrade doc: https://docs.ignite.com/guide/install.html#upgrading-your-ignite-cli-installation\n·\n··\n\nIgnite CLI version:     v0.23.0\n....\n\n```\n## Running the script\nThen run the following command to generate the OpenAPI docs and update static assets for Swagger UI:\n\n```bash\n./scripts/update-swagger-ui-statik.sh\n```\nThe script generates a new swagger/openapi yml and saves it as `docs/swagger-ui/swagger.yml`.\nIt will then embed the yml file and static assets in `docs/swagger-ui/` directory into the `docs/swagger/statik.go` file.\n\nIf swagger endpoint is configured, the app on startup will \"read\" `statik.go` and make it's content available at the \n`/swagger/` endpoint.\n\n# Serving the OpenAPI docs on the node\n\nTo start serving the docs, enable the swagger docs serving. \nTo do that, update `api.swagger` value to `true` in the `app.toml` file.\n\n```toml\n###############################################################################\n###                           API Configuration                             ###\n###############################################################################\n\n[api]\n\n# Enable defines if the API server should be enabled.\nenable = true\n\n# Swagger defines if swagger documentation should automatically be registered.\nswagger = true\n```\nOnce node is restarted, swagger docs will be available at `http://\u003cnode-ip\u003e:\u003cport\u003e/swagger/`","funding_links":[],"categories":["Go","How to Contribute"],"sub_categories":["Project Guidelines"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsei-protocol%2Fsei-chain","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsei-protocol%2Fsei-chain","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsei-protocol%2Fsei-chain/lists"}