Feature/add swagger specifics#360
Merged
Merged
Conversation
|
@Lansa-18 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
Contributor
Author
|
@LaGodxy Kindly go through. |
LaGodxy
approved these changes
Apr 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #178
✨ Feature: OpenAPI/Swagger Specification for Indexer REST API (#178)
Goal
Add a machine-readable OpenAPI/Swagger specification to the PropChain indexer REST API so consumers can explore, test, and generate clients against the API without relying solely on the markdown README.
🔍 What Was Implemented
The
utoipacrate was integrated into the indexer to derive an OpenAPI 3.0 spec at compile time from code annotations. A Swagger UI is served at/swagger-ui/and the raw JSON spec at/api-docs/openapi.json.The three documented routes are:
/healthGET/eventsGET/contractsGET📁 Files Modified
indexer/Cargo.tomlutoipav5 andutoipa-swagger-uiv8 dependencies; declaredingestas a valid feature to fix pre-existing clippy warningsindexer/src/db.rsutoipa::ToSchemaderive and doc comments toIndexedEventindexer/src/api.rsutoipa::IntoParams+utoipa::ToSchematoEventsParams; added#[utoipa::path]annotations tohealth,list_events, andlist_contractshandlersindexer/src/openapi.rsApiDocstruct that assembles the full OpenAPI spec (paths, schemas, tags, info)indexer/src/main.rsmod openapi; restructured router to mergeSwaggerUias a stateless outer layer alongside the state-bearing API routesindexer/README.md