Conversation
Member
Author
|
merge blocker: should add |
There was a problem hiding this comment.
Pull Request Overview
This PR adds an OpenAPI specification for the explored API to enable better documentation and API client generation. The specification includes comprehensive endpoint definitions, schema definitions, and authentication details for the Sia blockchain explorer API.
Key Changes:
- Added complete OpenAPI 3.0 specification defining all explored API endpoints and data structures
- Configured GitHub workflows for automated OpenAPI documentation publishing and version synchronization
- Integrated with Scalar for hosted API documentation
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| openapi.yml | Complete OpenAPI specification for explored API with endpoints, schemas, and authentication |
| .github/workflows/openapi-sync.yml | Workflow to sync OpenAPI versions on releases |
| .github/workflows/openapi-publish.yml | Workflow to publish OpenAPI docs to Scalar registry |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
alexfreska
reviewed
Oct 8, 2025
alexfreska
previously approved these changes
Oct 8, 2025
chris124567
reviewed
Oct 8, 2025
chris124567
reviewed
Oct 8, 2025
chris124567
reviewed
Oct 8, 2025
chris124567
reviewed
Oct 8, 2025
Member
chris124567
previously approved these changes
Oct 9, 2025
Member
|
@peterjan iirc SCALAR_API_KEY is available org wide. |
n8mgr
reviewed
Oct 9, 2025
n8mgr
approved these changes
Oct 9, 2025
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.
This PR adds an OpenAPI spec for walletd. I'm going to do the same for walletd and hostd. This is in reference to one of the goals we set last year, but we failed to accomplish it in due time. But better late than never.
I'm not too familiar with Scalar, I copy pasted the workflow from indexd and tweaked it a bit. The openapi spec was generated of course, I verified it manually though and ran it through a validator.
Fixes #273